Interface Index

Description

Base interface for all indices.

Base interface for all indices.

Located in /index/Index.interface.php (line 20)


	
			
Direct descendents
Class Description
ScopedIndex Index for Scoped statements and their scope.
LiteralIndex Index for literal values stored in a topic map.
TypeInstanceIndex Index for type-instance relationships between Topics and for Typed Topic Maps constructs.
Method Summary
void close ()
boolean isAutoUpdated ()
boolean isOpen ()
void open ()
void reindex ()
Methods
close (line 36)

Close the index.

Close the index.

  • access: public
void close ()
isAutoUpdated (line 56)

Indicates whether the index is updated automatically.

Indicates whether the index is updated automatically. If the value 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.

  • return: true if index is updated automatically, false otherwise.
  • access: public
boolean isAutoUpdated ()
isOpen (line 43)

Indicates if the index is open.

Indicates if the index is open.

  • return: true if index is already opened, false otherwise.
  • access: public
boolean isOpen ()
open (line 29)

Open the index.

Open the index. This method must be invoked before using any other method (aside from isOpen()) exported by this interface or derived interfaces.

  • access: public
void open ()
reindex (line 63)

Synchronizes the index with data in the topic map.

Synchronizes the index with data in the topic map.

  • access: public
void reindex ()

Documentation generated on Sat, 15 Jan 2011 20:02:26 +0100 by phpDocumentor 1.4.1