Class TSTLookup
java.lang.Object
org.apache.lucene.search.suggest.Lookup
org.apache.lucene.search.suggest.tst.TSTLookup
- All Implemented Interfaces:
Accountable
Suggest implementation based on a Ternary Search Tree
- See Also:
-
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
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
add
(CharSequence key, Object value) Adds a new node ifkey
already exists, otherwise replaces its value.void
build
(InputIterator iterator) Builds up a new internalLookup
representation based on the givenInputIterator
.get
(CharSequence key) Returns the value for the specified key, or null if the key does not exist.long
getCount()
Get the number of entries the lookup was built withboolean
Discard current lookup data and load it from a previously saved copy.lookup
(CharSequence key, Set<BytesRef> contexts, boolean onlyMorePopular, int num) Look up a key and return possible completion for this key.long
Returns byte size of the underlying TSTboolean
store
(DataOutput output) Persist the constructed lookup data to a directory.Methods inherited from class org.apache.lucene.search.suggest.Lookup
build, load, lookup, lookup, store
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
Constructor Details
-
TSTLookup
public TSTLookup()Creates a new TSTLookup with an empty Ternary Search Tree.- See Also:
-
TSTLookup
Creates a new TSTLookup, for building.- See Also:
-
-
Method Details
-
build
Description copied from class:Lookup
Builds up a new internalLookup
representation based on the givenInputIterator
. The implementation might re-sort the data internally.- Specified by:
build
in classLookup
- Throws:
IOException
-
add
Adds a new node ifkey
already exists, otherwise replaces its value.This method always returns true.
-
get
Returns the value for the specified key, or null if the key does not exist. -
lookup
public List<Lookup.LookupResult> lookup(CharSequence key, Set<BytesRef> contexts, 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.contexts
- contexts to filter the lookup by, or null if all contexts are allowed; if the suggestion contains any of the contexts, it's a matchonlyMorePopular
- 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
Description copied from class:Lookup
Persist the constructed lookup data to a directory. Optional operation.- Specified by:
store
in classLookup
- Parameters:
output
-DataOutput
to write the data to.- Returns:
- true if successful, false if unsuccessful or not supported.
- Throws:
IOException
- when fatal IO error occurs.
-
load
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
- theDataInput
to load the lookup data.- Returns:
- true if completed successfully, false if unsuccessful or not supported.
- Throws:
IOException
- when fatal IO error occurs.
-
ramBytesUsed
public long ramBytesUsed()Returns byte size of the underlying TST -
getCount
public long getCount()Description copied from class:Lookup
Get the number of entries the lookup was built with
-