|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.suggest.Lookup org.apache.lucene.search.suggest.fst.WFSTCompletionLookup
public class WFSTCompletionLookup
Suggester based on a weighted FST: it first traverses the prefix, then walks the n shortest paths to retrieve top-ranked suggestions.
NOTE:
Input weights must be between 0 and Integer.MAX_VALUE
, any
other values will be rejected.
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 | |
---|---|
WFSTCompletionLookup()
Calls WFSTCompletionLookup(true) |
|
WFSTCompletionLookup(boolean exactFirst)
Creates a new suggester. |
Method Summary | |
---|---|
void |
build(InputIterator iterator)
Builds up a new internal Lookup representation based on the given InputIterator . |
Object |
get(CharSequence key)
Returns the weight associated with an input string, or null if it does not exist. |
long |
getCount()
Get the number of entries the lookup was built with |
boolean |
load(DataInput 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. |
long |
sizeInBytes()
Returns byte size of the underlying FST. |
boolean |
store(DataOutput output)
Persist the constructed lookup data to a directory. |
Methods inherited from class org.apache.lucene.search.suggest.Lookup |
---|
build, load, store |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WFSTCompletionLookup()
WFSTCompletionLookup(true)
public WFSTCompletionLookup(boolean exactFirst)
exactFirst
- true
if suggestions that match the
prefix exactly should always be returned first, regardless
of score. This has no performance impact, but could result
in low-quality suggestions.Method Detail |
---|
public void build(InputIterator iterator) throws IOException
Lookup
Lookup
representation based on the given InputIterator
.
The implementation might re-sort the data internally.
build
in class Lookup
IOException
public boolean store(DataOutput output) throws IOException
Lookup
store
in class Lookup
output
- DataOutput
to write the data to.
IOException
- when fatal IO error occurs.public boolean load(DataInput input) throws IOException
Lookup
load
in class Lookup
input
- the DataInput
to load the lookup data.
IOException
- when fatal IO error occurs.public List<Lookup.LookupResult> lookup(CharSequence key, boolean onlyMorePopular, int num)
Lookup
lookup
in class Lookup
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
public Object get(CharSequence key)
public long sizeInBytes()
sizeInBytes
in class Lookup
public long getCount()
Lookup
getCount
in class Lookup
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |