Interface AssociationsIndexInterface

Description
Description | Methods (details)

Interface AssociationsIndexInterface: An index of AssociationInterface instances in a topic map.

Interface AssociationsIndexInterface: An index of AssociationInterface instances in a topic map. This index provides an index of associations by their type and a method for retrieving all topics which are used to specify the type of one or more associations.

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

TopicMapSystemConfigurableHelperObjectInterface
   |
   --IndexInterface
      |
      --AssociationsIndexInterface
Method Summary
Description | Methods (details)
array getAssociationsByType (object TopicInterface $type)
array getAssociationTypes ()
Methods
Description | Methods (details)
getAssociationsByType (line 25)

getAssociationsByType: Retrieve the associations which are typed by the topic type.

getAssociationsByType: Retrieve the associations which are typed by the topic type. The return value may be an empty array but must never be null.

  • return: An array of AssociationInterface instances.
  • access: public
array getAssociationsByType (object TopicInterface $type)
  • object TopicInterface $type: The type of associations to be returned. If $type is null an array containing all untyped association will be returned.
getAssociationTypes (line 17)

getAssociationTypes: Retrieve the topics which are used to type associations in this topic map.

getAssociationTypes: Retrieve the topics which are used to type associations in this topic map. The return value may be an empty array but must never be null.

  • return: An array of TopicInterface instances.
  • access: public
array getAssociationTypes ()

Inherited Methods

Inherited From IndexInterface

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

Inherited From TopicMapSystemConfigurableHelperObjectInterface

TopicMapSystemConfigurableHelperObjectInterface::configure()

Documentation generated on Fri, 30 Jun 2006 13:06:49 +0200 by phpDocumentor 1.3.0RC4