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
System.Object
ValueSource
TotalTermFreqValueSource
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Queries.Function.ValueSources
Assembly: Lucene.Net.Queries.dll
Syntax
public class TotalTermFreqValueSource : ValueSource

Constructors

| Improve this Doc View Source

TotalTermFreqValueSource(String, String, String, BytesRef)

Declaration
public TotalTermFreqValueSource(string field, string val, string indexedField, BytesRef indexedBytes)
Parameters
Type Name Description
System.String field
System.String val
System.String indexedField
Lucene.Net.Util.BytesRef indexedBytes

Fields

| Improve this Doc View Source

m_field

Declaration
protected readonly string m_field
Field Value
Type Description
System.String
| Improve this Doc View Source

m_indexedBytes

Declaration
protected readonly BytesRef m_indexedBytes
Field Value
Type Description
Lucene.Net.Util.BytesRef
| Improve this Doc View Source

m_indexedField

Declaration
protected readonly string m_indexedField
Field Value
Type Description
System.String
| Improve this Doc View Source

m_val

Declaration
protected readonly string m_val
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

Name

Declaration
public virtual string Name { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

CreateWeight(IDictionary, IndexSearcher)

Declaration
public override void CreateWeight(IDictionary context, IndexSearcher searcher)
Parameters
Type Name Description
System.Collections.IDictionary context
Lucene.Net.Search.IndexSearcher searcher
Overrides
| Improve this Doc View Source

Equals(Object)

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

GetDescription()

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

GetHashCode()

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

GetValues(IDictionary, AtomicReaderContext)

Declaration
public override FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)
Parameters
Type Name Description
System.Collections.IDictionary context
Lucene.Net.Index.AtomicReaderContext readerContext
Returns
Type Description
FunctionValues
Overrides