Class TSTLookup
- java.lang.Object
-
- org.apache.lucene.search.suggest.Lookup
-
- org.apache.lucene.search.suggest.tst.TSTLookup
-
- All Implemented Interfaces:
Accountable
public class TSTLookup extends Lookup
Suggest implementation based on a Ternary Search Tree- See Also:
TSTAutocomplete
-
-
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
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanadd(CharSequence key, Object value)Adds a new node ifkeyalready exists, otherwise replaces its value.voidbuild(InputIterator iterator)Builds up a new internalLookuprepresentation based on the givenInputIterator.Objectget(CharSequence key)Returns the value for the specified key, or null if the key does not exist.longgetCount()Get the number of entries the lookup was built withbooleanload(DataInput input)Discard current lookup data and load it from a previously saved copy.List<Lookup.LookupResult>lookup(CharSequence key, Set<BytesRef> contexts, boolean onlyMorePopular, int num)Look up a key and return possible completion for this key.longramBytesUsed()Returns byte size of the underlying TSTbooleanstore(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 Detail
-
TSTLookup
public TSTLookup()
Creates a new TSTLookup with an empty Ternary Search Tree.- See Also:
build(InputIterator)
-
TSTLookup
public TSTLookup(Directory tempDir, String tempFileNamePrefix)
Creates a new TSTLookup, for building.- See Also:
build(InputIterator)
-
-
Method Detail
-
build
public void build(InputIterator iterator) throws IOException
Description copied from class:LookupBuilds up a new internalLookuprepresentation based on the givenInputIterator. The implementation might re-sort the data internally.- Specified by:
buildin classLookup- Throws:
IOException
-
add
public boolean add(CharSequence key, Object value)
Adds a new node ifkeyalready exists, otherwise replaces its value.This method always returns true.
-
get
public Object get(CharSequence key)
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:LookupLook up a key and return possible completion for this key.- Specified by:
lookupin 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
public boolean store(DataOutput output) throws IOException
Description copied from class:LookupPersist the constructed lookup data to a directory. Optional operation.- Specified by:
storein classLookup- Parameters:
output-DataOutputto 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(DataInput input) throws IOException
Description copied from class:LookupDiscard current lookup data and load it from a previously saved copy. Optional operation.- Specified by:
loadin classLookup- Parameters:
input- theDataInputto 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
-
-