Class TSTLookup

Suggest implementation based on a Ternary Search Tree

Inheritance
object
Lookup
TSTLookup
Inherited Members
Namespace: Lucene.Net.Search.Suggest.Tst
Assembly: Lucene.Net.Suggest.dll
Syntax
public class TSTLookup : Lookup

Constructors

TSTLookup()

Creates a new TSTLookup with an empty Ternary Search Tree.

Declaration
public TSTLookup()
See Also

Properties

Count

Get the number of entries the lookup was built with

Declaration
public override long Count { get; }
Property Value
Type Description
long

total number of suggester entries
Overrides
See Also

Methods

Add(string, object)

Adds a new node if 

key
already exists, otherwise replaces its value.

This method always returns true.

Declaration
public virtual bool Add(string key, object value)
Parameters
Type Name Description
string key
object value
Returns
Type Description
bool
See Also

Build(IInputEnumerator)

Builds up a new internal Lookup representation based on the given IInputEnumerator. The implementation might re-sort the data internally.

Declaration
public override void Build(IInputEnumerator enumerator)
Parameters
Type Name Description
IInputEnumerator enumerator
Overrides
See Also

DoLookup(string, IEnumerable<BytesRef>, bool, int)

Look up a key and return possible completion for this key.

Declaration
public override IList<Lookup.LookupResult> DoLookup(string key, IEnumerable<BytesRef> contexts, bool onlyMorePopular, int num)
Parameters
Type Name Description
string key

lookup key. Depending on the implementation this may be a prefix, misspelling, or even infix.
IEnumerable<BytesRef> 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 match
bool onlyMorePopular

return only more popular results
int num

maximum number of results to return
Returns
Type Description
IList<Lookup.LookupResult>

a list of possible completions, with their relative weight (e.g. popularity)
Overrides
See Also

Get(string)

Returns the value for the specified key, or null if the key does not exist.

Declaration
public virtual object Get(string key)
Parameters
Type Name Description
string key
Returns
Type Description
object
See Also

GetSizeInBytes()

Returns byte size of the underlying TST

Declaration
public override long GetSizeInBytes()
Returns
Type Description
long
Overrides
See Also

Load(DataInput)

Discard current lookup data and load it from a previously saved copy. Optional operation.

Declaration
public override bool Load(DataInput input)
Parameters
Type Name Description
DataInput input

the Lucene.Net.Store.DataInput to load the lookup data.
Returns
Type Description
bool

true if completed successfully, false if unsuccessful or not supported.
Overrides
Exceptions
Type Condition
IOException

when fatal IO error occurs.
See Also

Store(DataOutput)

Persist the constructed lookup data to a directory. Optional operation.

Declaration
public override bool Store(DataOutput output)
Parameters
Type Name Description
DataOutput output

Lucene.Net.Store.DataOutput to write the data to.
Returns
Type Description
bool

true if successful, false if unsuccessful or not supported.
Overrides
Exceptions
Type Condition
IOException

when fatal IO error occurs.
See Also

See Also