Interface TopicMapObjectInterface

Description

Interface TopicMapObjectInterface: The base class for all objects in the PHPTMAPI system which represent constructs in a topic map.

Interface TopicMapObjectInterface: The base class for all objects in the PHPTMAPI system which represent constructs in a topic map. Every topic map object may be created from any number of input sources (typically markup in some topic map interchange format), each of which may have a separate address. In addition, the PHPTMAPI TopicMapObjectInterface may "wrap" one or more objects in an underlying topic map processing system.

Located in /org.phptmapi.core/TopicMapObject.interface.php (line 10)


	
			
Direct descendents
Class Description
AssociationRoleInterface Interface AssociationRoleInterface: Represents the topic map member / role construct (known as association role in HyTM).
ScopedObjectInterface Interface ScopedObjectInterface: The base class for all objects which define a scope or parameter property.
TopicInterface Interface TopicInterface: Represents the topic map topic construct.
TopicMapInterface Interface TopicMapInterface: Represents a topic map construct.
Method Summary
void addItemIdentifier (string $itemIdentifier)
string getObjectId ()
void remove ()
void removeItemIdentifier (string $itemIdentifier)
Methods
addItemIdentifier (line 65)

addItemIdentifier: Adds a locator to the item identifiers for this object.

addItemIdentifier: Adds a locator to the item identifiers for this object. It is not allowed to have two TopicMapObjectInterfaces in the same topic map with the same item identifier. If the two objects are TopicInterface objects, then they must be merged. If at least one of the two objects is not a TopicInterface object, a DuplicateItemIdentifierException must be reported.

  • access: public
  • throws: DuplicateItemIdentifierException if there is already a topic map object in the same topic map with this item identifier.
    1. public function addItemIdentifier($itemIdentifier){
    2. throw new DuplicateItemIdentifierException('Exception in '.__method__);
    3. }
void addItemIdentifier (string $itemIdentifier)
  • string $itemIdentifier: The locator to be added.
getItemIdentifiers (line 24)

getItemIdentifiers: Returns the array of item identifiers for this object.

getItemIdentifiers: Returns the array of item identifiers for this object. Item identifiers are identifiers for the object and can be freely assigned in order to be used to refer to the object. Note that on XTM import item identifiers MUST be assigned that refer to the XTM elements that gave rise to the object, providing the XTM element had an id attribute. The return value may be an empty array, but is never null.

  • access: public
array getItemIdentifiers ()
getObjectId (line 16)

Returns a topic map-specific identifier for this object.

Returns a topic map-specific identifier for this object. The identifier returned must be guaranteed to be unique across all TopicMapObjectInterface instances from the same TopicMapInterface instance.

  • access: public
string getObjectId ()
getParent (line 38)

getParent: Gets the parent object of a TopicMapObjectInterface.

getParent: Gets the parent object of a TopicMapObjectInterface. AssociationRole[child]->Association[parent], Occurrence[child]->Topic[parent], TopicName[child]->Topic[parent], Variant[child]->TopicName[parent], Topic[child]->TopicMap[parent], Association[child]->TopicMap[parent], TopicMap->null.

  • access: public
getTopicMap (line 31)

getTopicMap: Returns the topic map to which this object belongs.

getTopicMap: Returns the topic map to which this object belongs. If the object is an instance of the TopicMapInterface interface, then it should return itself.

  • access: public
object TopicMapInterface getTopicMap ()
remove (line 51)

remove: Removes the object.

remove: Removes the object.

  • throws: TMAPIException if the object cannot be removed. Derived interfaces may define specific circumstances under which a subclass of TMAPIException must be raised - topic throws a TopicInUseException. Implementations MUST NOT use a TMAPIException to wrap a failure raised in the underlying engine - such errors must always be wrapped in a TMAPIRuntimeException.
    1. public function remove(){
    2. throw new TMAPIException('Exception in '.__method__);
    3. }
  • access: public
void remove ()
removeItemIdentifier (line 73)

removeItemIdentifiers: Removes a locator from the set of item identifiers for this object.

removeItemIdentifiers: Removes a locator from the set of item identifiers for this object.

  • access: public
void removeItemIdentifier (string $itemIdentifier)
  • string $itemIdentifier

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