Class TSTLookup
- java.lang.Object
-
- org.apache.lucene.search.suggest.Lookup
-
- org.apache.lucene.search.suggest.tst.TSTLookup
-
public class TSTLookup extends Lookup
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.suggest.Lookup
Lookup.LookupPriorityQueue, Lookup.LookupResult
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.search.suggest.Lookup
CHARSEQUENCE_COMPARATOR
-
-
Constructor Summary
Constructors Constructor Description TSTLookup()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(CharSequence key, Object value)
void
build(TermFreqIterator tfit)
Builds up a new internalLookup
representation based on the givenTermFreqIterator
.Object
get(CharSequence key)
boolean
load(InputStream input)
Discard current lookup data and load it from a previously saved copy.List<Lookup.LookupResult>
lookup(CharSequence key, boolean onlyMorePopular, int num)
Look up a key and return possible completion for this key.boolean
store(OutputStream output)
Persist the constructed lookup data to a directory.
-
-
-
Method Detail
-
build
public void build(TermFreqIterator tfit) throws IOException
Description copied from class:Lookup
Builds up a new internalLookup
representation based on the givenTermFreqIterator
. The implementation might re-sort the data internally.- Specified by:
build
in classLookup
- Throws:
IOException
-
add
public boolean add(CharSequence key, Object value)
-
get
public Object get(CharSequence key)
-
lookup
public List<Lookup.LookupResult> lookup(CharSequence key, boolean onlyMorePopular, int num)
Description copied from class:Lookup
Look up a key and return possible completion for this key.- Specified by:
lookup
in classLookup
- Parameters:
key
- lookup key. Depending on the implementation this may be a prefix, misspelling, or even infix.onlyMorePopular
- return only more popular resultsnum
- maximum number of results to return- Returns:
- a list of possible completions, with their relative weight (e.g. popularity)
-
store
public boolean store(OutputStream output) throws IOException
Description copied from class:Lookup
Persist the constructed lookup data to a directory. Optional operation.- Specified by:
store
in classLookup
- Parameters:
output
-OutputStream
to write the data to.- Returns:
- true if successful, false if unsuccessful or not supported.
- Throws:
IOException
- when fatal IO error occurs.
-
load
public boolean load(InputStream input) throws IOException
Description copied from class:Lookup
Discard current lookup data and load it from a previously saved copy. Optional operation.- Specified by:
load
in classLookup
- Parameters:
input
- theInputStream
to load the lookup data.- Returns:
- true if completed successfully, false if unsuccessful or not supported.
- Throws:
IOException
- when fatal IO error occurs.
-
-