Docs For Class IndexInterface

Description

Interface IndexInterface: Abstract representation of a topic map index.

Interface IndexInterface: Abstract representation of a topic map index. This is the base interface that must be implemented by all indexes.

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

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

TopicMapSystemConfigurableHelperObjectInterface
   |
   --IndexInterface

Direct descendents

Class	Description
AssociationRolesIndexInterface	Interface AssociationRolesIndexInterface: An index of the association roles in the indexed topic map.
AssociationsIndexInterface	Interface AssociationsIndexInterface: An index of AssociationInterface instances in a topic map.
OccurrencesIndexInterface	Interface OccurrencesIndexInterface: An index of all OccurrenceInterface instances in the topic map by their type and resource reference or resource data.
ScopedObjectsIndexInterface	Interface ScopedObjectsIndexInterface: An index of all ScopedObjectInterfaces (AssociationInterface, TopicNameInterface, OccurrenceInterface and VariantInterface) instances in the indexed topic map.
TopicNamesIndexInterface	Interface TopicNamesIndexInterface: This Index gives direct access to all topic names.
TopicsIndexInterface	Interface TopicsIndexInterface: An index of the topics in the topic map.
VariantsIndexInterface	Interface VariantsIndexInterface: An index of all VariantInterface instances in the topic map by their resource reference or resource data.

Method Summary

void close ()

object IndexInterface getFlags ()

boolean isAutoUpdated ()

boolean isOpen ()

void open ()

void reindex ()

Methods

close (line 23)

close: Close the index.

access: public

throws: TMAPIIndexException()

     public function close(){
        throw new TMAPIIndexException('Exception in '.__method__);
     }

void close ()

getFlags (line 36)

getFlags: Retrieve the IndexInterface instance that represents the static meta data for this index.

access: public

throws: TMAPIIndexException()

     public function getFlags(){
         throw new TMAPIIndexException('Exception in '.__method__);
     }

object IndexInterface getFlags ()

isAutoUpdated (line 82)

isAutoUpdated: Returns the auto-update flag for the index.

isAutoUpdated: Returns the auto-update flag for the index. If the value of this flag is true, then the index is automatically kept synchronized with the topic map as values are changed. If the value is false, then the Index->reindex() method must be called to resynchronize the index with the topic map after values are changed.

access: public

boolean isAutoUpdated ()

isOpen (line 49)

isOpen: Return the state of this index.

isOpen: Return the state of this index. True if the index is currently open, false otherwise.

access: public

throws: TMAPIIndexException()

     public function isOpen(){
         throw new TMAPIIndexException('Exception in '.__method__);
     }

boolean isOpen ()

open (line 62)

open: Open the index.

open: Open the index. This method must be invoked before using any other method exported by this interface or derived interfaces.

access: public

throws: TMAPIIndexException()

     public function open(){
         throw new TMAPIIndexException('Exception in '.__method__);
     }

void open ()

reindex (line 75)

reindex: Resynchronize this index with the data in the topic map.

access: public

throws: TMAPIIndexException()

     public function reindex(){
         throw new TMAPIIndexException('Exception in '.__method__);
     }

void reindex ()

Inherited Methods

Inherited From TopicMapSystemConfigurableHelperObjectInterface

TopicMapSystemConfigurableHelperObjectInterface::configure()