Interface TopicNameInterface

Description

Interface TopicNameInterface: Represents the topic map topicname construct.

Interface TopicNameInterface: Represents the topic map topicname construct. In XTM 1.0, this construct is represented by the <baseName> element. In XTM 2.0, this construct is represented by the <name> element.

Located in /org.phptmapi.core/TopicName.interface.php (line 12)

TopicMapObjectInterface
   |
   --ScopedObjectInterface
      |
      --TopicNameInterface
Method Summary
object VariantInterface createVariant (string $value, string $datatype, array $scope)
string getValue ()
array getVariants ()
void setValue (string $value)
Methods
createVariant (line 21)

createVariant: Creates a variant of this topic name with the specified resource data string and scopes.

createVariant: Creates a variant of this topic name with the specified resource data string and scopes.

  • access: public
object VariantInterface createVariant (string $value, string $datatype, array $scope)
  • string $value: The inline data string for the variant. Pass null for no string.
  • string $datatype: An XML Schema Datatype.
  • array $scope: The scope for the variant to be created. Must be an array of TopicInterface objects.
getReifier (line 28)

getReifier: Returns the topic that reifies this topic name.

getReifier: Returns the topic that reifies this topic name.

  • access: public
object TopicInterface getReifier ()
getTopic (line 49)

getTopic: Returns the topic which contains this topic name.

getTopic: Returns the topic which contains this topic name.

  • access: public
object TopicInterface getTopic ()
getValue (line 56)

getValue: Returns the name string of the topic name.

getValue: Returns the name string of the topic name.

  • return: OR null
  • access: public
string getValue ()
getVariants (line 63)

getVariants: Returns the VariantInterface instances defined for this topic name.

getVariants: Returns the VariantInterface instances defined for this topic name. The return value may be an empty array, but is never null.

  • access: public
array getVariants ()
setReifier (line 42)

setReifier: Sets the reifiying topic of this topic name.

setReifier: Sets the reifiying topic of this topic name.

  • access: public
  • throws: ModelConstraintException if the topic already reifies another object.
    1. public function setReifier($reifier){
    2. throw new ModelConstraintException('Exception in '.__method__);
    3. }
void setReifier (object TopicInterface $reifier)
setValue (line 77)

setValue: Define the name string for this topic name.

setValue: Define the name string for this topic name. A new value will replace any existing value. A null value indicates that there is no name string for this topic name.

  • access: public
  • throws: MergeException if the processor detects that a merge is required and either automerge is disabled or automerge is enabled but the merge cannot be completed for some other reason.
    1. public function setValue($value){
    2. throw new MergeException('Exception in '.__method__);
    3. }
void setValue (string $value)
  • string $value

Inherited Methods

Inherited From ScopedObjectInterface

ScopedObjectInterface::addScopingTopic()
ScopedObjectInterface::getScope()
ScopedObjectInterface::removeScopingTopic()

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:13 +0200 by phpDocumentor 1.3.0RC4