NetworkedPlanet | TMCore Engine API Guide |
The interface IIndex
defines a
generic interface for an index over the data in a single TopicMap
instance. The IIndex
interface provides
methods for opening and closing an index; and for determining whether an
index is currently open or closed.
The methods IIndex.Open()
and
Close()
are used to modify the open state of
the index. The property IsOpen is a boolean value
which is true when the index is open. Calling any index retrieval
methods on an index which is not open will result in an exception being
thrown.
The IIndex interface is defined for future extension to
implementations which may require local resources to be consumed when
an index is open. The SQLServer implementation of the TMCore API does
not consume any local resources. For the SQLServer implementation, all
indexes are automatically created as open and the
Close()
method has no effect, hence the value
of the IsOpen property is always true.