|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Index
An index into a body of text that knows what words exist and where they are.
The GNU Lesser General Public License for details.
Method Summary | |
---|---|
void |
close()
Closes resources related to the index |
Key |
find(String query)
Find the set of references that satisfy the query. |
Key |
getKey(String name)
An index must be able to create KeyLists for users in a similar way to the Book that it is indexing. |
SearchModifier |
getSearchModifier()
Get the current SearchModifier. |
void |
setSearchModifier(SearchModifier modifier)
Set any modifier for the current and subsequent search. |
Method Detail |
---|
Key find(String query) throws BookException
query
being searched
for is null then an empty Key MUST be returned. Users of this
index may use this functionality to get empty KeyLists which they then
use to aggregate other searches done on this index.
query
- The text to search for
BookException
Key getKey(String name) throws NoSuchKeyException
name
- The string to convert to a Key
NoSuchKeyException
- If the string can not be turned into a KeyKeyFactory.getKey(String)
void setSearchModifier(SearchModifier modifier)
modifier
- how to modify the search and its results.SearchModifier getSearchModifier()
void close()
|
Copyright ยจ 2003-2015 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |