Interface 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.

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

Construct
   |
   --Reifiable
      |
      --Name
Method Summary
Variant createVariant (string $value, string $datatype,  $scope)
string getValue ()
array getVariants ()
void setValue (string $value)
Methods
createVariant (line 73)

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

Creates a 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 datatype is null, or the scope of the variant would not be a true superset of the name's scope.
  • access: public
Variant 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.

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.

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

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