gov.nist.nlpir.irf.index
Interface IndexIntrf

All Known Implementing Classes:
Index, ProxyIndex
public abstract interface IndexIntrf

This interface represents the functionality of a Index object.

Version:
$Revision: 1.2 $
Author:
This software was produced by NIST, an agency of the U.S. government, and by statute is not subject to copyright in the United States. Recipients of this software assume all responsibilities associated with its operation, modification and maintenance.
See Also:
Index, ProxyIndex

Method Summary
 boolean addIndexingFeatures(java.util.Vector indexingFeatures, Indexer anIndexer)
          Add indexing features.
 boolean checkIndexer(Indexer anIndexer)
          Verifies that the same indexer is applied consistantly.
 void clear()
          Clears the index and its features.
 java.util.Enumeration getFeatures()
          Returns the features for which indexing features have been stored.
 java.lang.String getName()
          Gets the index name.
 java.util.Enumeration getSources()
          Returns the sources for which indexing features have been stored.
 void present()
          Presents the status of the index and its features.
 void presentStatistics()
          Presents the status of the index and its feature statistics.
 java.util.Vector retrieve(QueryModalityUnit qm, java.util.Vector setIF)
          Executes a search and retrieves documents.
 void showStatistics(int depth, int maxLengthIf3)
          statistics about the index.
 java.lang.String toString()
          Gives a String Representaiton of the Index.
 void update()
          Updates the index and its features.
 

Method Detail

getName

public java.lang.String getName()
Gets the index name.
Returns:
The index name.

getFeatures

public java.util.Enumeration getFeatures()
Returns the features for which indexing features have been stored.
Returns:
The Enumeration of Objects (should be DeIntern) used as features in this Index

getSources

public java.util.Enumeration getSources()
Returns the sources for which indexing features have been stored.
Returns:
The Enumeration of Objects (should be IoAddrIntern) used as sources in this Index

update

public void update()
Updates the index and its features.

clear

public void clear()
Clears the index and its features.

retrieve

public java.util.Vector retrieve(QueryModalityUnit qm,
                                 java.util.Vector setIF)
Executes a search and retrieves documents.
Parameters:
qm - Query Modality Unit
setIF - Vector of Vectors of indexing features
Returns:
Results or null if submitted to the wrong index.

present

public void present()
Presents the status of the index and its features.

presentStatistics

public void presentStatistics()
Presents the status of the index and its feature statistics.

toString

public java.lang.String toString()
Gives a String Representaiton of the Index.
Overrides:
toString in class java.lang.Object

checkIndexer

public boolean checkIndexer(Indexer anIndexer)
Verifies that the same indexer is applied consistantly.
Parameters:
an_Indexer - an indexer
Returns:
true if the Index is well applied, false otherwise.

addIndexingFeatures

public boolean addIndexingFeatures(java.util.Vector indexingFeatures,
                                   Indexer anIndexer)
Add indexing features.
Parameters:
indexingFeatures - Vector of indexing features.
anIndexer - an indexer.
Returns:
true if the Indexer exists and is correct,
false otherwise

showStatistics

public void showStatistics(int depth,
                           int maxLengthIf3)
statistics about the index.
Parameters:
deep - deepness of the statistics in the intern index
maxLengthIf3 - maximum number of characters printed.
See Also:
PersistentDualKeyContainer.showStatistics(int, int)