Class DocTermsIndexDocValues

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Inheritance

object

FunctionValues

DocTermsIndexDocValues

Inherited Members

FunctionValues.ByteVal(int)

FunctionValues.Int16Val(int)

FunctionValues.SingleVal(int)

FunctionValues.Int32Val(int)

FunctionValues.Int64Val(int)

FunctionValues.DoubleVal(int)

FunctionValues.ByteVal(int, byte[])

FunctionValues.Int16Val(int, short[])

FunctionValues.SingleVal(int, float[])

FunctionValues.Int32Val(int, int[])

FunctionValues.Int64Val(int, long[])

FunctionValues.DoubleVal(int, double[])

FunctionValues.StrVal(int, string[])

FunctionValues.Explain(int)

FunctionValues.GetScorer(IndexReader)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Queries.Function.DocValues

Assembly: Lucene.Net.Queries.dll

Syntax

public abstract class DocTermsIndexDocValues : FunctionValues

Constructors

DocTermsIndexDocValues(ValueSource, AtomicReaderContext, string)

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

protected DocTermsIndexDocValues(ValueSource vs, AtomicReaderContext context, string field)

Parameters

Type	Name	Description
ValueSource	vs
AtomicReaderContext	context
string	field

Fields

m_spare

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

protected readonly BytesRef m_spare

Field Value

Type	Description
BytesRef

m_spareChars

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

protected readonly CharsRef m_spareChars

Field Value

Type	Description
CharsRef

m_termsIndex

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

protected readonly SortedDocValues m_termsIndex

Field Value

Type	Description
SortedDocValues

m_val

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

protected readonly MutableValueStr m_val

Field Value

Type	Description
MutableValueStr

m_vs

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

protected readonly ValueSource m_vs

Field Value

Type	Description
ValueSource

Properties

NumOrd

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

public override int NumOrd { get; }

Property Value

Type	Description
int	the number of unique sort ordinals this instance has

Overrides

FunctionValues.NumOrd

Methods

BoolVal(int)

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

public override bool BoolVal(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
bool

Overrides

FunctionValues.BoolVal(int)

BytesVal(int, BytesRef)

returns the bytes representation of the str val - TODO: should this return the indexed raw bytes not?

Declaration

public override bool BytesVal(int doc, BytesRef target)

Parameters

Type	Name	Description
int	doc
BytesRef	target

Returns

Type	Description
bool

Overrides

FunctionValues.BytesVal(int, BytesRef)

Exists(int)

Returns true if there is a value for this document

Declaration

public override bool Exists(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
bool

Overrides

FunctionValues.Exists(int)

GetRangeScorer(IndexReader, string, string, bool, bool)

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

public override ValueSourceScorer GetRangeScorer(IndexReader reader, string lowerVal, string upperVal, bool includeLower, bool includeUpper)

Parameters

Type	Name	Description
IndexReader	reader
string	lowerVal
string	upperVal
bool	includeLower
bool	includeUpper

Returns

Type	Description
ValueSourceScorer

Overrides

FunctionValues.GetRangeScorer(IndexReader, string, string, bool, bool)

GetValueFiller()

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public override FunctionValues.ValueFiller GetValueFiller()

Returns

Type	Description
FunctionValues.ValueFiller

Overrides

FunctionValues.GetValueFiller()

ObjectVal(int)

Native object representation of the value

Declaration

public override abstract object ObjectVal(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
object

Overrides

FunctionValues.ObjectVal(int)

OrdVal(int)

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

public override int OrdVal(int doc)

Parameters

Type	Name	Description
int	doc	The doc to retrieve to sort ordinal for

Returns

Type	Description
int	the sort ordinal for the specified doc TODO: Maybe we can just use intVal for this...

Overrides

FunctionValues.OrdVal(int)

StrVal(int)

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

public override string StrVal(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
string

Overrides

FunctionValues.StrVal(int)

ToString(int)

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

public override string ToString(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
string

Overrides

FunctionValues.ToString(int)

ToTerm(string)

Serves as base class for FunctionValues based on DocTermsIndex.

Note

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

Declaration

protected abstract string ToTerm(string readableValue)

Parameters

Type	Name	Description
string	readableValue

Returns

Type	Description
string