Interface TypeInstanceIndex

Description

Index for type-instance relationships between Topics and for Typed Topic Maps constructs.

Index for type-instance relationships between Topics and for Typed Topic Maps constructs. This index provides access to Topics used in type-instance relationships (see http://www.isotopicmaps.org/sam/sam-model/#sect-types) or as type of a Typed construct. Further, the retrieval of Associations, Roles, Occurrences, and Names by their type property is supported.

Located in /index/TypeInstanceIndex.interface.php (line 30)

Index
   |
   --TypeInstanceIndex
Method Summary
array getAssociations ( $type)
array getNames ( $type)
array getNameTypes ()
array getOccurrences ( $type)
array getRoles ( $type)
array getRoleTypes ()
array getTopics ( $types, boolean $matchAll)
array getTopicTypes ()
Methods
getAssociations (line 82)

Returns the associations in the topic map whose type property equals $type.

Returns the associations in the topic map whose type property equals $type. The return value may be an empty array but must never be null.

  • return: An array containing Associations.
  • access: public
array getAssociations ( $type)
getAssociationTypes (line 91)

Returns the topics in the topic map used in the type property of Associations.

Returns the topics in the topic map used in the type property of Associations. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • access: public
array getAssociationTypes ()
getNames (line 120)

Returns the topic names in the topic map whose type property equals $type.

Returns the topic names in the topic map whose type property equals $type. The return value may be an empty array but must never be null.

  • return: An array containing Names.
  • access: public
array getNames ( $type)
  • Topic $type: The type of the Names to be returned.
getNameTypes (line 129)

Returns the topics in the topic map used in the type property of Names.

Returns the topics in the topic map used in the type property of Names. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • access: public
array getNameTypes ()
getOccurrences (line 139)

Returns the occurrences in the topic map whose type property equals $type.

Returns the occurrences in the topic map whose type property equals $type. The return value may be an empty array but must never be null.

  • return: An array containing Occurrences.
  • access: public
array getOccurrences ( $type)
getOccurrenceTypes (line 148)

Returns the topics in the topic map used in the type property of Occurrences.

Returns the topics in the topic map used in the type property of Occurrences. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • access: public
array getOccurrenceTypes ()
getRoles (line 101)

Returns the roles in the topic map whose type property equals $type.

Returns the roles in the topic map whose type property equals $type. The return value may be an empty array but must never be null.

  • return: An array containing Roles.
  • access: public
array getRoles ( $type)
  • Topic $type: The type of the Roles to be returned.
getRoleTypes (line 110)

Returns the topics in the topic map used in the type property of Roles.

Returns the topics in the topic map used in the type property of Roles. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • access: public
array getRoleTypes ()
getTopics (line 55)

Returns the topics in the topic map whose type property equals one of those types at least.

Returns the topics in the topic map whose type property equals one of those types at least. If types' length == 1, $matchAll is interpreted true. Note: Implementations may return only those topics whose types property contains the type and may ignore type-instance relationships (see http://www.isotopicmaps.org/sam/sam-model/#sect-types) which are modeled as association. Further, supertype-subtype relationships (see http://www.isotopicmaps.org/sam/sam-model/#sect-subtypes) may also be ignored. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • throws: InvalidArgumentException If $types does not exclusively contain Topics.
  • access: public
array getTopics ( $types, boolean $matchAll)
  • array $types: An array containing the types of the Topics to be returned.
  • boolean $matchAll: If true, a topic must be an instance of all types, if false the topic must be an instance of one type at least. If types' length == 1, $matchAll is interpreted true.
getTopicTypes (line 72)

Returns the topics in the topic map which are used as type in a "type-instance"-relationship.

Returns the topics in the topic map which are used as type in a "type-instance"-relationship. Note: Implementations may return only those topics which are member of the types property of other topics and may ignore type-instance relationships (see http://www.isotopicmaps.org/sam/sam-model/#sect-types) which are modeled as association. Further, supertype-subtype relationships (see http://www.isotopicmaps.org/sam/sam-model/#sect-subtypes) may also be ignored. The return value may be an empty array but must never be null.

  • return: An array containing Topics.
  • access: public
array getTopicTypes ()

Inherited Methods

Inherited From Index

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

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