Class Lookup.LookupResult

Result of a lookup.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
Lookup.LookupResult
Namespace: Lucene.Net.Search.Suggest
Assembly: Lucene.Net.Suggest.dll
Syntax
public sealed class LookupResult : IComparable<Lookup.LookupResult>

Constructors

| Improve this Doc View Source

LookupResult(String, Int64)

Create a new result from a key+weight pair.

Declaration
public LookupResult(string key, long value)
Parameters
Type Name Description
System.String key
System.Int64 value
| Improve this Doc View Source

LookupResult(String, Int64, BytesRef)

Create a new result from a key+weight+payload triple.

Declaration
public LookupResult(string key, long value, BytesRef payload)
Parameters
Type Name Description
System.String key
System.Int64 value
BytesRef payload
| Improve this Doc View Source

LookupResult(String, Int64, BytesRef, IEnumerable<BytesRef>)

Create a new result from a key+weight+payload+contexts triple.

Declaration
public LookupResult(string key, long value, BytesRef payload, IEnumerable<BytesRef> contexts)
Parameters
Type Name Description
System.String key
System.Int64 value
BytesRef payload
IEnumerable<BytesRef> contexts
| Improve this Doc View Source

LookupResult(String, Int64, HashSet<BytesRef>)

Create a new result from a key+weight+contexts triple.

Declaration
public LookupResult(string key, long value, HashSet<BytesRef> contexts)
Parameters
Type Name Description
System.String key
System.Int64 value
HashSet<BytesRef> contexts
| Improve this Doc View Source

LookupResult(String, Object, Int64, BytesRef)

Create a new result from a key+highlightKey+weight+payload triple.

Declaration
public LookupResult(string key, object highlightKey, long value, BytesRef payload)
Parameters
Type Name Description
System.String key
System.Object highlightKey
System.Int64 value
BytesRef payload
| Improve this Doc View Source

LookupResult(String, Object, Int64, BytesRef, IEnumerable<BytesRef>)

Create a new result from a key+highlightKey+weight+payload+contexts triple.

Declaration
public LookupResult(string key, object highlightKey, long value, BytesRef payload, IEnumerable<BytesRef> contexts)
Parameters
Type Name Description
System.String key
System.Object highlightKey
System.Int64 value
BytesRef payload
IEnumerable<BytesRef> contexts

Properties

| Improve this Doc View Source

Contexts

the key's contexts (null if not present)

Declaration
public IEnumerable<BytesRef> Contexts { get; }
Property Value
Type Description
IEnumerable<BytesRef>
| Improve this Doc View Source

HighlightKey

Expert: custom Object to hold the result of a highlighted suggestion.

Declaration
public object HighlightKey { get; }
Property Value
Type Description
System.Object
| Improve this Doc View Source

Key

the key's text

Declaration
public string Key { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Payload

the key's payload (null if not present)

Declaration
public BytesRef Payload { get; }
Property Value
Type Description
BytesRef
| Improve this Doc View Source

Value

the key's weight

Declaration
public long Value { get; }
Property Value
Type Description
System.Int64

Methods

| Improve this Doc View Source

CompareTo(Lookup.LookupResult)

Compare alphabetically.

Declaration
public int CompareTo(Lookup.LookupResult o)
Parameters
Type Name Description
Lookup.LookupResult o
Returns
Type Description
System.Int32
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String