Interface LiteralIndex

Description
Description | Methods (details)

Index for literal values stored in a topic map.

Index for literal values stored in a topic map.

Located in /index/LiteralIndex.interface.php (line 22) 

Index
   |
   --LiteralIndex
Method Summary
Description | Methods (details)
array getNames (string $value)
array getOccurrences (string $value, string $datatype)
array getVariants (string $value, string $datatype)
Methods
Description | Methods (details)
getNames (line 33)

Retrieves the topic names in the topic map which have a value equal to $value.

Retrieves the topic names in the topic map which have a value equal to $value. The return value may be an empty array but must never be null.

  • return: An array containing Names.
  • throws: InvalidArgumentException If the value is null.
  • access: public
array getNames (string $value)
  • string $value: The value of the Names to be returned.
getOccurrences (line 46)

Returns the Occurrences in the topic map whose value property matches $value and whose datatye is $datatype.

Returns the Occurrences in the topic map whose value property matches $value and whose datatye is $datatype. The return value may be an empty array but must never be null.

  • return: An array containing Occurrences.
  • throws: InvalidArgumentException If the value or datatype is null.
  • access: public
array getOccurrences (string $value, string $datatype)
  • string $value: The value of the Occurrences to be returned.
  • string $datatype: A URI indicating the datatype of the Occurrences. E.g. http://www.w3.org/2001/XMLSchema#string indicates a string value.
getVariants (line 59)

Returns the IVariants in the topic map whose value property matches $value and whose datatye is $datatype.

Returns the IVariants in the topic map whose value property matches $value and whose datatye is $datatype. The return value may be an empty array but must never be null.

  • return: An array containing IVariants.
  • throws: InvalidArgumentException If the value or datatype is null.
  • access: public
array getVariants (string $value, string $datatype)
  • string $value: The value of the IVariants to be returned.
  • string $datatype: A URI indicating the datatype of the IVariants. E.g. http://www.w3.org/2001/XMLSchema#string indicates a string value.

Inherited Methods

Inherited From Index

Index::close()
Index::isAutoUpdated()
Index::isOpen()
Index::open()
Index::reindex()

Documentation generated on Mon, 19 Sep 2011 21:01:27 +0200 by phpDocumentor 1.4.0