Class TotalTermFreqValueSource

TotalTermFreqValueSource returns the total term freq (sum of term freqs across all documents). Returns -1 if frequencies were omitted for the field, or if the codec doesn't support this statistic.

Note

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

Inheritance

object

ValueSource

TotalTermFreqValueSource

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 TotalTermFreqValueSource : ValueSource

Constructors

TotalTermFreqValueSource(string, string, string, BytesRef)

TotalTermFreqValueSource returns the total term freq (sum of term freqs across all documents). Returns -1 if frequencies were omitted for the field, or if the codec doesn't support this statistic.

Note

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

Declaration

public TotalTermFreqValueSource(string field, string val, string indexedField, BytesRef indexedBytes)

Parameters

Type	Name	Description
string	field
string	val
string	indexedField
BytesRef	indexedBytes

Fields

m_field

TotalTermFreqValueSource returns the total term freq (sum of term freqs across all documents). Returns -1 if frequencies were omitted for the field, or if the codec doesn't support this statistic.

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

m_indexedBytes

TotalTermFreqValueSource returns the total term freq (sum of term freqs across all documents). Returns -1 if frequencies were omitted for the field, or if the codec doesn't support this statistic.

Note

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

Declaration

protected readonly BytesRef m_indexedBytes

Field Value

Type	Description
BytesRef

m_indexedField

TotalTermFreqValueSource returns the total term freq (sum of term freqs across all documents). Returns -1 if frequencies were omitted for the field, or if the codec doesn't support this statistic.

Note

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

Declaration

protected readonly string m_indexedField

Field Value

Type	Description
string

m_val

TotalTermFreqValueSource returns the total term freq (sum of term freqs across all documents). Returns -1 if frequencies were omitted for the field, or if the codec doesn't support this statistic.

Note

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

Declaration

protected readonly string m_val

Field Value

Type	Description
string

Properties

Name

TotalTermFreqValueSource returns the total term freq (sum of term freqs across all documents). Returns -1 if frequencies were omitted for the field, or if the codec doesn't support this statistic.

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)