Docs For Class TopicMapInterface

Interface TopicMapInterface

Description

Interface TopicMapInterface: Represents a topic map construct.

author: Johannes Schmidt - t8d <kontakt@t8d.de>

Located in /org.phptmapi.core/TopicMap.interface.php (line 11)

TopicMapObjectInterface
   |
   --TopicMapInterface

Method Summary

void close ()

object AssociationInterface createAssociation ()

object TopicInterface createTopic ()

array getAssociations ()

object getHelperObject (string $implementationDirectoryName, string $implementationClassName)

object TopicMapObjectInterface getObjectById (string $objectId)

object TopicMapObjectInterface getObjectByItemIdentifier (string $itemIdentifier)

object TopicInterface getReifier ()

object TopicInterface getTopicBySubjectIdentifier (string $subjectIdentifier)

object TopicInterface getTopicBySubjectLocator (string $subjectLocator)

object TopicMapSystemInterface getTopicMapSystem ()

array getTopics ()

void mergeIn (TopicMapInterface $othermap)

void setReifier (object TopicInterface $reifier)

Methods

close (line 17)

close: Closes use of this topic map.

close: Closes use of this topic map. This method should be invoked by the application once it is finished using the TopicMapInterface instance. Implementations may release any resources required for the TopicMapInterface instance or any of the TopicMapObjectInterface instances contained by the TopicMapInterface instance.

access: public

void close ()

createAssociation (line 24)

createAssociation: Creates a new association in the topic map.

createAssociation: Creates a new association in the topic map. The newly created association has no type, no roles and is in the unconstrained scope.

access: public

object AssociationInterface createAssociation ()

createTopic (line 45)

createTopic: Creates a new topic in the topic map.

createTopic: Creates a new topic in the topic map. The newly created topic has no types, names or occurrences.

access: public

object TopicInterface createTopic ()

getAssociations (line 31)

getAssociations: Returns all of the associations in the topic map.

getAssociations: Returns all of the associations in the topic map. The return value may be an empty array, but is never null.

access: public

array getAssociations ()

getHelperObject (line 138)

getHelperObject: Returns a helper object.

getHelperObject: Returns a helper object. The discovery procedure is similar as implemented in TopicMapSystemFactory using a discovery file in '../META/$implementationDirectoryName/$implementationClassName'. The "discovered" helper object is then assigned to an implementation of TopicMapSystemConfigurableHelperObjectInterface.

access: public
throws: UnsupportedHelperObjectException if no implementation can be found.
throws: HelperObjectInstantiationException if the specified implementation class could not be loaded or if a new instance of the helper class could not be instantiated.

throws: HelperObjectConfigurationException if the TopicMapSystemConfigurableHelperObjectInterface->configure(TopicMapInterface $tm) method of the helper object implementation raises an exception.

    public function getHelperObject($implementationClassName){
        throw new UnsupportedHelperObjectException('Exception in '.__method__);
         throw new HelperObjectInstantiationException('Exception in '.__method__);
         throw new HelperObjectConfigurationException('Exception in '.__method__);
    }

object getHelperObject (string $implementationDirectoryName, string $implementationClassName)

string $implementationDirectoryName
string $implementationClassName

getObjectById (line 53)

getObjectById: Returns the TopicMapObjectInterface managed by this topic map with the specified object ID.

access: public

object TopicMapObjectInterface getObjectById (string $objectId)

string $objectId

getObjectByItemIdentifier (line 103)

getObjectByItemIdentifier: Returns a TopicMapObjectInterface that is identified by the named item identifier.

access: public

object TopicMapObjectInterface getObjectByItemIdentifier (string $itemIdentifier)

string $itemIdentifier

getReifier (line 60)

getReifier: Returns the topic that reifies this topic map.

access: public

object TopicInterface getReifier ()

getTopicBySubjectIdentifier (line 119)

getTopicBySubjectIdentifier: Returns the topic whose subject is identified by the named identifier that must be a URI.

access: public

object TopicInterface getTopicBySubjectIdentifier (string $subjectIdentifier)

string $subjectIdentifier

getTopicBySubjectLocator (line 111)

getTopicBySubjectLocator: Returns the topic whose subject is represented by the named locator.

access: public

object TopicInterface getTopicBySubjectLocator (string $subjectLocator)

string $subjectLocator

getTopicMapSystem (line 81)

getTopicMapSystem: Returns the topic map system to which this topic map belongs.

access: public

object TopicMapSystemInterface getTopicMapSystem ()

getTopics (line 38)

getTopics: Returns all of the topics in the topic map.

getTopics: Returns all of the topics in the topic map. The return value may be an empty array, but is never null.

access: public

array getTopics ()

mergeIn (line 95)

mergeIn: Merges the topic map $othermap into this topic map.

mergeIn: Merges the topic map $othermap into this topic map. All topics and associations and all of their contents in other will be added to this topic map. Topics in other will be merged with topics in this topic map as defined by XTM merging rules. The merge process will not modify $othermap in any way.

access: public

throws: MergeException if merging of topics of this topic map instance and the other cannot be completed because of subject locator property conflicts and the XTM 1.0 processing model is enabled.

    public function mergeIn(TopicMapInterface $othermap){
        throw new MergeException('Exception in '.__method__);
    }

void mergeIn (TopicMapInterface $othermap)

object TopicMapInterface $othermap

setReifier (line 74)

setReifier: Sets the reifiying topic of this topic map.

access: public

throws: ModelConstraintException if the topic already reifies another object

    public function setReifier($reifier){
        throw new ModelConstraintException('Exception in '.__method__);
    }

void setReifier (object TopicInterface $reifier)

object TopicInterface $reifier: or null if the reifier should be set to null

Inherited Methods

Inherited From TopicMapObjectInterface

TopicMapObjectInterface::addItemIdentifier()
TopicMapObjectInterface::getItemIdentifiers()
TopicMapObjectInterface::getObjectId()
TopicMapObjectInterface::getParent()
TopicMapObjectInterface::getTopicMap()
TopicMapObjectInterface::remove()
TopicMapObjectInterface::removeItemIdentifier()

Documentation generated on Fri, 30 Jun 2006 13:07:06 +0200 by phpDocumentor 1.3.0RC4