Package javax.help.search
Class IndexBuilder
java.lang.Object
javax.help.search.IndexBuilder
Abstract base class that builds an index for a search database.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract voidclose()Closes the index.abstract voidCloses the document.abstract EnumerationReturns the list of stopwords for an index.abstract voidopenDocument(String name) Opens a document to store information.abstract voidstoreLocation(String text, int position) Stores a concept at a given position.abstract voidstoreStopWords(Enumeration stopWords) Sets the stopwords in an index.abstract voidstoreTitle(String title) Stores the title for the document.
-
Field Details
-
indexDir
-
-
Constructor Details
-
IndexBuilder
Builds an index at indexDir. If indexDir already exists the index is opened and the new doucments are merged into the existing document.- Throws:
Exception
-
-
Method Details
-
close
Closes the index.- Throws:
Exception
-
storeStopWords
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
Returns the list of stopwords for an index. -
openDocument
Opens a document to store information.- Throws:
Exception
-
closeDocument
Closes the document. This prevents any additional information from being stored.- Throws:
Exception
-
storeLocation
Stores a concept at a given position.- Throws:
Exception
-
storeTitle
Stores the title for the document.- Throws:
Exception
-