Docs For Class VariantInterface

Description

Interface VariantInterface: Represents the topic map variant name construct.

Interface VariantInterface: Represents the topic map variant name construct. A variant name is qualified by zero or more parameters, each of which is a topic. This class uses the ScopedObjectInterface to manage the parameters. When implementing the VariantInterface remember that VARIANT is a native PHP class.

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

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

TopicMapObjectInterface
   |
   --ScopedObjectInterface
      |
      --VariantInterface

Method Summary

string getDatatype ()

object TopicInterface getReifier ()

object TopicNameInterface getTopicName ()

string getValue ()

void setReifier (object TopicInterface $reifier)

void setValue (string $value, string $datatype)

Methods

getDatatype (line 61)

getDatatype: Returns the datatype of the variant's resource data.

access: public

string getDatatype ()

getReifier (line 17)

getReifier: Returns the topic that reifies this variant name.

access: public

object TopicInterface getReifier ()

getTopicName (line 38)

getTopicName: Returns the topic name to which this variant belongs.

access: public

object TopicNameInterface getTopicName ()

getValue (line 45)

getValue: Returns the data string associated with this variant.

access: public

string getValue ()

setReifier (line 31)

setReifier: Sets the reifiying topic of this variant name.

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.

setValue (line 54)

setValue: Sets the resource data string for this variant.

setValue: Sets the resource data string for this variant. This method will overwrite any existing value data string and will set the value of the resource property to null.

access: public

void setValue (string $value, string $datatype)

string $value
string $datatype: An XML Schema Datatype.

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()