Class NormValueSource

Function that returns DecodeNormValue(long) for every document.

Note that the configured Similarity for the field must be a subclass of Lucene.Net.Search.Similarities.TFIDFSimilarity

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Inheritance

object

ValueSource

NormValueSource

Inherited Members

ValueSource.ToString()

ValueSource.NewContext(IndexSearcher)

ValueSource.GetSortField(bool)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Queries.Function.ValueSources

Assembly: Lucene.Net.Queries.dll

Syntax

public class NormValueSource : ValueSource

Constructors

NormValueSource(string)

Function that returns DecodeNormValue(long) for every document.

Note that the configured Similarity for the field must be a subclass of Lucene.Net.Search.Similarities.TFIDFSimilarity

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public NormValueSource(string field)

Parameters

Type	Name	Description
string	field

Fields

m_field

Function that returns DecodeNormValue(long) for every document.

Note that the configured Similarity for the field must be a subclass of Lucene.Net.Search.Similarities.TFIDFSimilarity

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

protected readonly string m_field

Field Value

Type	Description
string

Properties

Name

Function that returns DecodeNormValue(long) for every document.

Note that the configured Similarity for the field must be a subclass of Lucene.Net.Search.Similarities.TFIDFSimilarity

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public virtual string Name { get; }

Property Value

Type	Description
string

Methods

CreateWeight(IDictionary, IndexSearcher)

Implementations should propagate CreateWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to GetValues() where this info can be retrieved.

Declaration

public override void CreateWeight(IDictionary context, IndexSearcher searcher)

Parameters

Type	Name	Description
IDictionary	context
IndexSearcher	searcher

Overrides

ValueSource.CreateWeight(IDictionary, IndexSearcher)

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
object	o

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueSource.Equals(object)

GetDescription()

description of field, used in Explain()

Declaration

public override string GetDescription()

Returns

Type	Description
string

Overrides

ValueSource.GetDescription()

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

ValueSource.GetHashCode()

GetValues(IDictionary, AtomicReaderContext)

Gets the values for this reader and the context that was previously passed to CreateWeight(IDictionary, IndexSearcher)

Declaration

public override FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)

Parameters

Type	Name	Description
IDictionary	context
AtomicReaderContext	readerContext

Returns

Type	Description
FunctionValues

Overrides

ValueSource.GetValues(IDictionary, AtomicReaderContext)