Class Lookup.LookupResult

Result of a lookup.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk

Inheritance

System.Object

Lookup.LookupResult

Implements

System.IComparable<Lookup.LookupResult>

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Lucene.Net.Search.Suggest

Assembly: Lucene.Net.Suggest.dll

Syntax

public sealed class LookupResult : IComparable<Lookup.LookupResult>

Constructors

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

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

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
System.Collections.Generic.IEnumerable<BytesRef>	contexts

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
System.Collections.Generic.HashSet<BytesRef>	contexts

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

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
System.Collections.Generic.IEnumerable<BytesRef>	contexts

Properties

Contexts

the key's contexts (null if not present)

Declaration

public IEnumerable<BytesRef> Contexts { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<BytesRef>

HighlightKey

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

Declaration

public object HighlightKey { get; }

Property Value

Type	Description
System.Object

Key

the key's text

Declaration

public string Key { get; }

Property Value

Type	Description
System.String

Payload

the key's payload (null if not present)

Declaration

public BytesRef Payload { get; }

Property Value

Type	Description
BytesRef

Value

the key's weight

Declaration

public long Value { get; }

Property Value

Type	Description
System.Int64

Methods

CompareTo(Lookup.LookupResult)

Compare alphabetically.

Declaration

public int CompareTo(Lookup.LookupResult o)

Parameters

Type	Name	Description
Lookup.LookupResult	o

Returns

Type	Description
System.Int32

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Implements

System.IComparable<T>