Class javax.help.search.IndexBuilder

java.lang.Object
    |
    +----javax.help.search.IndexBuilder

public abstract class IndexBuilder
extends java.lang.Object
Abstract base class that builds an index for a search database.


indexDir

protected java.lang.String indexDir

IndexBuilder

public IndexBuilder(java.lang.String indexDir) throws java.lang.Exception
Builds an index at indexDir. If indexDir already exists the index is opened and the new doucments are merged into the existing document.

close

public abstract void close() throws java.lang.Exception
Closes the index.

storeStopWords

public abstract void storeStopWords(java.util.Enumeration stopWords)
Sets the stopwords in an index. If the stopwords are already defined for an index, the stop words are merged with the existing set of stopwords.

getStopWords

public abstract java.util.Enumeration getStopWords()
Returns the list of stopwords for an index.

openDocument

public abstract void openDocument(java.lang.String name) throws java.lang.Exception
Opens a document to store information.

closeDocument

public abstract void closeDocument() throws java.lang.Exception
Closes the document. This prevents any additional information from being stored.

storeLocation

public abstract void storeLocation(java.lang.String text,
                                   int position) throws java.lang.Exception
Stores a concept at a given position.

storeTitle

public abstract void storeTitle(java.lang.String title) throws java.lang.Exception
Stores the title for the document.