Interface Construct

Description

Base interface for all Topic Maps constructs.

Base interface for all Topic Maps constructs.

Located in /core/Construct.interface.php (line 20)


	
			
Direct descendents
Class Description
Scoped Indicates that a statement (Topic Maps construct) has a scope.
Typed Indicates that a Topic Maps construct is typed.
Reifiable Indicates that a Construct is reifiable.
Topic Represents a topic item.
Method Summary
void addItemIdentifier (string $itemIdentifier)
boolean equals (Construct $other)
string getId ()
string hashCode ()
void remove ()
void removeItemIdentifier (string $itemIdentifier)
Methods
addItemIdentifier (line 75)

Adds an item identifier.

Adds an item identifier. It is not allowed to have two Constructs in the same TopicMap with the same item identifier. If the two objects are Topics, then they must be merged. If at least one of the two objects is not a Topic, an IdentityConstraintException must be reported.

void addItemIdentifier (string $itemIdentifier)
  • string $itemIdentifier: The item identifier to be added; must not be null.
equals (line 111)

Returns true if the other construct is equal to this one, false otherwise.

Returns true if the other construct is equal to this one, false otherwise. Equality must be the result of comparing the ids of the two constructs. Note: This equality test does not reflect any equality rule according to the Topic Maps - Data Model (TMDM) by intention.

  • access: public
boolean equals (Construct $other)
  • Construct $other: The construct to compare this construct against.
getId (line 51)

Returns the identifier of this construct.

Returns the identifier of this construct. This property has no representation in the Topic Maps - Data Model (TMDM). The ID can be anything, so long as no other Construct in the same topic map has the same ID.

  • return: An identifier which identifies this construct uniquely within a topic map.
  • access: public
string getId ()
getItemIdentifiers (line 59)

Returns the item identifiers of this Topic Maps construct.

Returns the item identifiers of this Topic Maps construct. The return value may be an empty array but must never be null.

  • return: An array containing a set of URIs representing the item identifiers.
  • access: public
array getItemIdentifiers ()
getParent (line 31)

Returns the parent of this construct. return value.

Returns the parent of this construct. See the derived constructs for the particular return value. This method returns null iff this construct is a TopicMap instance.

  • return: The parent of this construct or null iff the construct is an instance of TopicMap.
  • access: public
Construct|null getParent ()
getTopicMap (line 40)

Returns the TopicMap instance to which this Topic Maps construct belongs.

Returns the TopicMap instance to which this Topic Maps construct belongs. A TopicMap instance returns itself.

  • return: The topic map instance to which this construct belongs.
  • access: public
TopicMap getTopicMap ()
hashCode (line 120)

Returns a hash code value.

Returns a hash code value. The returned hash code is equal to the hash code of the getId() property.

  • access: public
string hashCode ()
remove (line 98)

Deletes this construct from its parent container.

Deletes this construct from its parent container. Iff this construct is an instance of Topic this method throws a TopicInUseException if the topic plays a Role, is used as type of a Typed construct, or if it is used as theme for a Scoped construct, or if it reifies a Reifiable. After invocation of this method, the construct is in an undefined state and MUST NOT be used further.

  • access: public
void remove ()
removeItemIdentifier (line 84)

Removes an item identifier.

Removes an item identifier.

  • access: public
void removeItemIdentifier (string $itemIdentifier)
  • string $itemIdentifier: The item identifier to be removed from this construct, if present (null is ignored).

Documentation generated on Sat, 15 Jan 2011 20:02:25 +0100 by phpDocumentor 1.4.1