Show / Hide Table of Contents

    Class FunctionValues

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

    Inheritance
    System.Object
    FunctionValues
    BoolDocValues
    DocTermsIndexDocValues
    DoubleDocValues
    Int32DocValues
    Int64DocValues
    SingleDocValues
    StrDocValues
    MultiFunction.Values
    Namespace: Lucene.Net.Queries.Function
    Assembly: Lucene.Net.Queries.dll
    Syntax
    public abstract class FunctionValues : object

    Properties

    | Improve this Doc View Source

    NumOrd

    Declaration
    public virtual int NumOrd { get; }
    Property Value
    Type Description
    System.Int32

    the number of unique sort ordinals this instance has

    Methods

    | Improve this Doc View Source

    BoolVal(Int32)

    Declaration
    public virtual bool BoolVal(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    BytesVal(Int32, 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
    System.Int32 doc
    BytesRef target
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    ByteVal(Int32)

    Declaration
    public virtual byte ByteVal(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.Byte
    | Improve this Doc View Source

    ByteVal(Int32, Byte[])

    Declaration
    public virtual void ByteVal(int doc, byte[] vals)
    Parameters
    Type Name Description
    System.Int32 doc
    System.Byte[] vals
    | Improve this Doc View Source

    DoubleVal(Int32)

    Declaration
    public virtual double DoubleVal(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.Double
    | Improve this Doc View Source

    DoubleVal(Int32, Double[])

    Declaration
    public virtual void DoubleVal(int doc, double[] vals)
    Parameters
    Type Name Description
    System.Int32 doc
    System.Double[] vals
    | Improve this Doc View Source

    Exists(Int32)

    Returns true if there is a value for this document

    Declaration
    public virtual bool Exists(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Explain(Int32)

    Declaration
    public virtual Explanation Explain(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    Explanation
    | Improve this Doc View Source

    GetRangeScorer(IndexReader, String, String, Boolean, Boolean)

    Declaration
    public virtual ValueSourceScorer GetRangeScorer(IndexReader reader, string lowerVal, string upperVal, bool includeLower, bool includeUpper)
    Parameters
    Type Name Description
    IndexReader reader
    System.String lowerVal
    System.String upperVal
    System.Boolean includeLower
    System.Boolean includeUpper
    Returns
    Type Description
    ValueSourceScorer
    | Improve this Doc View Source

    GetScorer(IndexReader)

    Declaration
    public virtual ValueSourceScorer GetScorer(IndexReader reader)
    Parameters
    Type Name Description
    IndexReader reader
    Returns
    Type Description
    ValueSourceScorer
    | Improve this Doc View Source

    GetValueFiller()

    @lucene.experimental

    Declaration
    public virtual FunctionValues.ValueFiller GetValueFiller()
    Returns
    Type Description
    FunctionValues.ValueFiller
    | Improve this Doc View Source

    Int16Val(Int32)

    NOTE: This was shortVal() in Lucene

    Declaration
    public virtual short Int16Val(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.Int16
    | Improve this Doc View Source

    Int16Val(Int32, Int16[])

    NOTE: This was shortVal() in Lucene

    Declaration
    public virtual void Int16Val(int doc, short[] vals)
    Parameters
    Type Name Description
    System.Int32 doc
    System.Int16[] vals
    | Improve this Doc View Source

    Int32Val(Int32)

    NOTE: This was intVal() in Lucene

    Declaration
    public virtual int Int32Val(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.Int32
    | Improve this Doc View Source

    Int32Val(Int32, Int32[])

    NOTE: This was intVal() in Lucene

    Declaration
    public virtual void Int32Val(int doc, int[] vals)
    Parameters
    Type Name Description
    System.Int32 doc
    System.Int32[] vals
    | Improve this Doc View Source

    Int64Val(Int32)

    NOTE: This was longVal() in Lucene

    Declaration
    public virtual long Int64Val(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.Int64
    | Improve this Doc View Source

    Int64Val(Int32, Int64[])

    NOTE: This was longVal() in Lucene

    Declaration
    public virtual void Int64Val(int doc, long[] vals)
    Parameters
    Type Name Description
    System.Int32 doc
    System.Int64[] vals
    | Improve this Doc View Source

    ObjectVal(Int32)

    Native representation of the value

    Declaration
    public virtual object ObjectVal(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.Object
    | Improve this Doc View Source

    OrdVal(Int32)

    Declaration
    public virtual int OrdVal(int doc)
    Parameters
    Type Name Description
    System.Int32 doc

    The doc to retrieve to sort ordinal for

    Returns
    Type Description
    System.Int32

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

    | Improve this Doc View Source

    SingleVal(Int32)

    NOTE: This was floatVal() in Lucene

    Declaration
    public virtual float SingleVal(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.Single
    | Improve this Doc View Source

    SingleVal(Int32, Single[])

    NOTE: This was floatVal() in Lucene

    Declaration
    public virtual void SingleVal(int doc, float[] vals)
    Parameters
    Type Name Description
    System.Int32 doc
    System.Single[] vals
    | Improve this Doc View Source

    StrVal(Int32)

    Declaration
    public virtual string StrVal(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.String
    | Improve this Doc View Source

    StrVal(Int32, String[])

    Declaration
    public virtual void StrVal(int doc, string[] vals)
    Parameters
    Type Name Description
    System.Int32 doc
    System.String[] vals
    | Improve this Doc View Source

    ToString(Int32)

    Declaration
    public abstract string ToString(int doc)
    Parameters
    Type Name Description
    System.Int32 doc
    Returns
    Type Description
    System.String
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)