Docs For Class OccurrencesIndexInterface

Description

Interface OccurrencesIndexInterface: An index of all OccurrenceInterface instances in the topic map by their type and resource reference or resource data.

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

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

TopicMapSystemConfigurableHelperObjectInterface
   |
   --IndexInterface
      |
      --OccurrencesIndexInterface

Method Summary

array getOccurrences (string $value, string $datatype)

array getOccurrencesByType (object TopicInterface $type)

array getOccurrenceTypes ()

Methods

getOccurrences (line 19)

getOccurrences: Returns the occurrences in the topic map whose data matches $value and XML Schema datatype matches $datatype.

getOccurrences: Returns the occurrences in the topic map whose data matches $value and XML Schema datatype matches $datatype. The return value may be an empty array but must never be null.

return: An array of OccurrenceInterface instances.
access: public

array getOccurrences (string $value, string $datatype)

string $value: The occurrence data.
string $datatype: An XML Schema Datatype.

getOccurrencesByType (line 27)

getOccurrencesByType: Returns the occurrences typed by the topic type.

return: An array of OccurrenceInterface instances.
access: public

array getOccurrencesByType (object TopicInterface $type)

object TopicInterface $type: The type of occurrences to be returned. If $type is null an array containing all untyped occurrences will be returned. The return value may be an empty array but must never be null.

getOccurrenceTypes (line 34)

getOccurrenceTypes: Returns the topics which are used to type occurrences in the indexed topic map.

getOccurrenceTypes: Returns the topics which are used to type occurrences in the indexed topic map. The return value may be an empty array but must never be null.

return: An array of OccurrenceInterface instances.
access: public

array getOccurrenceTypes ()

Inherited Methods

Inherited From IndexInterface

IndexInterface::close()
IndexInterface::getFlags()
IndexInterface::isAutoUpdated()
IndexInterface::isOpen()
IndexInterface::open()
IndexInterface::reindex()

Inherited From TopicMapSystemConfigurableHelperObjectInterface

TopicMapSystemConfigurableHelperObjectInterface::configure()