Class FunctionValues

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Inheritance

object

FunctionValues

BoolDocValues

DocTermsIndexDocValues

DoubleDocValues

Int32DocValues

Int64DocValues

SingleDocValues

StrDocValues

MultiFunction.Values

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Queries.Function

Assembly: Lucene.Net.Queries.dll

Syntax

public abstract class FunctionValues

Properties

NumOrd

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual int NumOrd { get; }

Property Value

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

Methods

BoolVal(int)

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual bool BoolVal(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
bool

ByteVal(int)

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual byte ByteVal(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
byte

ByteVal(int, byte[])

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual void ByteVal(int doc, byte[] vals)

Parameters

Type	Name	Description
int	doc
byte[]	vals

BytesVal(int, BytesRef)

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

Declaration

public virtual bool BytesVal(int doc, BytesRef target)

Parameters

Type	Name	Description
int	doc
BytesRef	target

Returns

Type	Description
bool

DoubleVal(int)

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual double DoubleVal(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
double

DoubleVal(int, double[])

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual void DoubleVal(int doc, double[] vals)

Parameters

Type	Name	Description
int	doc
double[]	vals

Exists(int)

Returns true if there is a value for this document

Declaration

public virtual bool Exists(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
bool

Explain(int)

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual Explanation Explain(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
Explanation

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

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual 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

GetScorer(IndexReader)

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual ValueSourceScorer GetScorer(IndexReader reader)

Parameters

Type	Name	Description
IndexReader	reader

Returns

Type	Description
ValueSourceScorer

GetValueFiller()

Note

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

Declaration

public virtual FunctionValues.ValueFiller GetValueFiller()

Returns

Type	Description
FunctionValues.ValueFiller

Int16Val(int)

NOTE: This was shortVal() in Lucene

Declaration

public virtual short Int16Val(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
short

Int16Val(int, short[])

NOTE: This was shortVal() in Lucene

Declaration

public virtual void Int16Val(int doc, short[] vals)

Parameters

Type	Name	Description
int	doc
short[]	vals

Int32Val(int)

NOTE: This was intVal() in Lucene

Declaration

public virtual int Int32Val(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
int

Int32Val(int, int[])

NOTE: This was intVal() in Lucene

Declaration

public virtual void Int32Val(int doc, int[] vals)

Parameters

Type	Name	Description
int	doc
int[]	vals

Int64Val(int)

NOTE: This was longVal() in Lucene

Declaration

public virtual long Int64Val(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
long

Int64Val(int, long[])

NOTE: This was longVal() in Lucene

Declaration

public virtual void Int64Val(int doc, long[] vals)

Parameters

Type	Name	Description
int	doc
long[]	vals

ObjectVal(int)

Native object representation of the value

Declaration

public virtual object ObjectVal(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
object

OrdVal(int)

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual 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...

SingleVal(int)

NOTE: This was floatVal() in Lucene

Declaration

public virtual float SingleVal(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
float

SingleVal(int, float[])

NOTE: This was floatVal() in Lucene

Declaration

public virtual void SingleVal(int doc, float[] vals)

Parameters

Type	Name	Description
int	doc
float[]	vals

StrVal(int)

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual string StrVal(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
string

StrVal(int, string[])

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public virtual void StrVal(int doc, string[] vals)

Parameters

Type	Name	Description
int	doc
string[]	vals

ToString(int)

Represents field values as different types. Normally created via a ValueSource for a particular field and reader.

Declaration

public abstract string ToString(int doc)

Parameters

Type	Name	Description
int	doc

Returns

Type	Description
string