|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An IndexManager controls access to all of the indexes for a particular topic map. Depending upon the implementation, this manager may be responsible for initialising indexes when it is created (or initialisation may be deferred until a specific index is requested). As well as managing the Index objects, this class also manages real-time meta data about the indexes - this meta data includes whether or not the index is already initialised, whether or not an explicit runtime initialisation is required and whether or not the index automatically updates itself as the topic map contents change. It also defines short cut access methods to all regular (part of tm4j and available for all backends) indices
Method Summary | |
AssociationTypesIndex |
getAssociationTypesIndex()
Shortcut access method for the AssociationTypesIndex |
BaseNameDataIndex |
getBaseNameDataIndex()
Shortcut access method for BaseNameDataIndex |
Index |
getIndex(java.lang.Class ixClass)
Returns the index which implements the specified interface. |
Index |
getIndex(java.lang.String ixInterface)
Returns the index which implements the specified interface |
IndexMeta |
getIndexMeta(java.lang.Class ixClass)
Returns meta data about the specified index. |
IndexMeta |
getIndexMeta(java.lang.String ixInterface)
Returns meta data about the specified index. |
MemberTypesIndex |
getMemberTypesIndex()
Shortcut access method for the MemberTypesIndex |
OccurrenceDataIndex |
getOccurrenceDataIndex()
Shortcut access method for OccurrenceDataIndex |
OccurrenceLocatorIndex |
getOccurrenceLocatorIndex()
Shortcut access method for the OccurrenceLocatorIndex |
OccurrenceTypesIndex |
getOccurrenceTypesIndex()
Shortcut access method for the OccurrenceTypesIndex |
ThemesIndex |
getThemesIndex()
Shortcut access method for the ThemesIndex |
TopicTypesIndex |
getTopicTypesIndex()
Shortcut access method for the TopicTypesIndex |
VariantDataIndex |
getVariantDataIndex()
Shortcut access method for VariantDataIndex |
boolean |
isRegistered(java.lang.Class ixClass)
Determines whether or not an Index implementing the specified interface is registered with this IndexManager. |
boolean |
isRegistered(java.lang.String ixInterface)
Determines whether or not an implementation of the specified Index interface is registered with this IndexManager. |
void |
registerIndexProvider(IndexProvider index)
Plugin interface for index service providers. |
Method Detail |
public void registerIndexProvider(IndexProvider index) throws DuplicateIndexNameException, IndexManagerException
index
- The index service provider to be registered.
DuplicateIndexNameException
- if name
is already
assigned to an index managed by this IndexManager.
java.lang.IllegalArgumentException
- If index
does not support
ant interfaces derived from Index
.
IndexManagerException
- If the index could not be registered
with the manager for some other reason.public boolean isRegistered(java.lang.String ixInterface)
ixInterface
- The fully qualified class name of the index
ixName
is
registered, false otherwise.public boolean isRegistered(java.lang.Class ixClass)
ixClass
- The interface to which the requested class must
conform.
java.lang.IllegalArgumentException
- If ixClass
is not an interface derived from Index
public IndexMeta getIndexMeta(java.lang.String ixInterface) throws UnsupportedIndexException
ixInterface
- The fully qualified Java class name of the
index interface to return meta data for.
ixName
is
registered.
UnsupportedIndexException
- If the specified index is not
managed by this index manager or if the provider.public IndexMeta getIndexMeta(java.lang.Class ixClass) throws java.lang.IllegalArgumentException, UnsupportedIndexException
ixClass
- The interface implemented by the index for
which meta data is requested.
java.lang.IllegalArgumentException
- if ixClass
is not an interface derived from Index
UnsupportedIndexException
- If the specified index is not
managed by this index manager or if the provider.public Index getIndex(java.lang.String ixInterface) throws IndexManagerException
ixInterface
- The fully qualified Java class name of the
index interface to retrieve.
IndexManagerException
- If the index could not be initialised
for some reason.public Index getIndex(java.lang.Class ixClass) throws IndexManagerException, java.lang.IllegalArgumentException
ixClass
- The interface implemented by the index
to be returned.
IndexManagerException
- If the index could not be initialised
for some reason.
java.lang.IllegalArgumentException
- if ixClass
is not an interface derived from Index
public TopicTypesIndex getTopicTypesIndex() throws IndexManagerException
IndexManagerException
- If the index could not be initialised
for some reason.public ThemesIndex getThemesIndex() throws IndexManagerException
IndexManagerException
- If the index could not be initialised
for some reason.public OccurrenceTypesIndex getOccurrenceTypesIndex() throws IndexManagerException
IndexManagerException
- If the index could not be initialised
for some reason.public OccurrenceLocatorIndex getOccurrenceLocatorIndex() throws IndexManagerException
IndexManagerException
- If the index could not be initialised
for some reason.public MemberTypesIndex getMemberTypesIndex() throws IndexManagerException
IndexManagerException
- If the index could not be initialised
for some reason.public AssociationTypesIndex getAssociationTypesIndex() throws IndexManagerException
IndexManagerException
- If the index could not be initialised
for some reason.public BaseNameDataIndex getBaseNameDataIndex() throws IndexManagerException
IndexManagerException
- if the index could not be initialised for some reasonpublic OccurrenceDataIndex getOccurrenceDataIndex() throws IndexManagerException
IndexManagerException
- if the index could not be initialised for some reasonpublic VariantDataIndex getVariantDataIndex() throws IndexManagerException
IndexManagerException
- if the index could not be initialised for some reason
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |