Class ValueSource

Instantiates FunctionValues for a particular reader.

Often used when creating a FunctionQuery.

Inheritance
System.Object
ValueSource
TaxonomyFacetSumValueSource.ScoreValueSource
BoolFunction
ConstNumberSource
DocFreqValueSource
DualSingleFunction
FieldCacheSource
LinearSingleFunction
LiteralValueSource
MaxDocValueSource
MultiFunction
MultiSingleFunction
MultiValueSource
NormValueSource
NumDocsValueSource
OrdFieldSource
QueryValueSource
RangeMapSingleFunction
ReciprocalSingleFunction
ReverseOrdFieldSource
ScaleSingleFunction
SingularFunction
SumTotalTermFreqValueSource
TotalTermFreqValueSource
Namespace: Lucene.Net.Queries.Function
Assembly: Lucene.Net.Queries.dll
Syntax
public abstract class ValueSource : object

Methods

| Improve this Doc View Source

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 virtual void CreateWeight(IDictionary context, IndexSearcher searcher)
Parameters
Type Name Description
IDictionary context
IndexSearcher searcher
| Improve this Doc View Source

Equals(Object)

Declaration
public abstract override bool Equals(object o)
Parameters
Type Name Description
System.Object o
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetDescription()

description of field, used in Explain()

Declaration
public abstract string GetDescription()
Returns
Type Description
System.String
| Improve this Doc View Source

GetHashCode()

Declaration
public abstract override int GetHashCode()
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetSortField(Boolean)

EXPERIMENTAL: This method is subject to change.

Get the SortField for this ValueSource. Uses the GetValues(IDictionary, AtomicReaderContext) to populate the SortField.

Declaration
public virtual SortField GetSortField(bool reverse)
Parameters
Type Name Description
System.Boolean reverse

true if this is a reverse sort.

Returns
Type Description
SortField

The SortField for the ValueSource

| Improve this Doc View Source

GetValues(IDictionary, AtomicReaderContext)

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

Declaration
public abstract FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)
Parameters
Type Name Description
IDictionary context
AtomicReaderContext readerContext
Returns
Type Description
FunctionValues
| Improve this Doc View Source

NewContext(IndexSearcher)

Returns a new non-threadsafe context map.

Declaration
public static IDictionary NewContext(IndexSearcher searcher)
Parameters
Type Name Description
IndexSearcher searcher
Returns
Type Description
IDictionary
| Improve this Doc View Source

ToString()

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