Docs For Class Name

Description

Represents a topic name item.

Represents a topic name item. See http://www.isotopicmaps.org/sam/sam-model/#sect-topic-name. Inherited method getParent() from Construct returns the Topic to which this name belongs to.

author: Johannes Schmidt <phptmapi-discuss@lists.sourceforge.net>
version: svn:$Id: Name.interface.php 91 2011-09-18 14:39:00Z joschmidt $

Located in /core/Name.interface.php (line 29)

Construct
   |
   --Reifiable
      |
      --Name

Method Summary

IVariant createVariant (string $value, string $datatype, $scope)

string getValue ()

array getVariants ()

void setValue (string $value)

Methods

createVariant (line 73)

Creates an IVariant of this topic name with the specified value, datatype, and scope.

Creates an IVariant of this topic name with the specified value, datatype, and scope. The newly created IVariant will have the datatype specified by $datatype. The newly created IVariant will contain all themes from the parent name and the themes specified in $scope.

throws: ModelConstraintException If the value or the datatype is null, or the scope of the variant would not be a true superset of the name's scope, or a theme in the scope does not belong to the parent topic map.
access: public

IVariant createVariant (string $value, string $datatype, $scope)

string $value: A string representation of the value.
string $datatype: A URI indicating the datatype of the value. E.g. http://www.w3.org/2001/XMLSchema#string indicates a string value.
array $scope: An array (length >= 1) containing Topics, each representing a theme.

getValue (line 36)

Returns the value of this name.

access: public

string getValue ()

getVariants (line 54)

Returns the IVariants defined for this name.

Returns the IVariants defined for this name. The return array may be empty but must never be null.

return: An array containing a set of IVariants.
access: public

array getVariants ()

setValue (line 46)

Sets the value of this name.

Sets the value of this name. The previous value is overridden.

throws: ModelConstraintException If $value is null.
access: public

void setValue (string $value)

string $value: The name string to be assigned to the name; must not be null.

Inherited Methods

Inherited From Reifiable

Reifiable::getReifier()
Reifiable::setReifier()

Inherited From Construct

Construct::addItemIdentifier()
Construct::equals()
Construct::getId()
Construct::getItemIdentifiers()
Construct::getParent()
Construct::getTopicMap()
Construct::hashCode()
Construct::remove()
Construct::removeItemIdentifier()

Interface Name

Inherited Methods