Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class OrdFieldSource

    Obtains the ordinal of the field value from the default Lucene Lucene.Net.Search.FieldCache using StringIndex.

    The native lucene index order is used to assign an ordinal value for each field value.

    Field values (terms) are lexicographically ordered by unicode value, and numbered starting at 1.

    Example:
    If there were only three field values: "apple","banana","pear"
    then ord("apple")=1, ord("banana")=2, ord("pear")=3

    WARNING: Ord depends on the position in an index and can thus change when other documents are inserted or deleted, or if a MultiSearcher is used.

    WARNING: as of Solr 1.4, ord() and rord() can cause excess memory use since they must use a FieldCache entry at the top level reader, while sorting and function queries now use entries at the segment level. Hence sorting or using a different function query, in addition to ord()/rord() will double memory use.
    Inheritance
    object
    ValueSource
    OrdFieldSource
    Inherited Members
    ValueSource.ToString()
    ValueSource.CreateWeight(IDictionary, IndexSearcher)
    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 OrdFieldSource : ValueSource

    Constructors

    OrdFieldSource(string)

    Obtains the ordinal of the field value from the default Lucene Lucene.Net.Search.FieldCache using StringIndex.

    The native lucene index order is used to assign an ordinal value for each field value.

    Field values (terms) are lexicographically ordered by unicode value, and numbered starting at 1.

    Example:
    If there were only three field values: "apple","banana","pear"
    then ord("apple")=1, ord("banana")=2, ord("pear")=3

    WARNING: Ord depends on the position in an index and can thus change when other documents are inserted or deleted, or if a MultiSearcher is used.

    WARNING: as of Solr 1.4, ord() and rord() can cause excess memory use since they must use a FieldCache entry at the top level reader, while sorting and function queries now use entries at the segment level. Hence sorting or using a different function query, in addition to ord()/rord() will double memory use.
    Declaration
    public OrdFieldSource(string field)
    Parameters
    Type Name Description
    string field

    Fields

    m_field

    Obtains the ordinal of the field value from the default Lucene Lucene.Net.Search.FieldCache using StringIndex.

    The native lucene index order is used to assign an ordinal value for each field value.

    Field values (terms) are lexicographically ordered by unicode value, and numbered starting at 1.

    Example:
    If there were only three field values: "apple","banana","pear"
    then ord("apple")=1, ord("banana")=2, ord("pear")=3

    WARNING: Ord depends on the position in an index and can thus change when other documents are inserted or deleted, or if a MultiSearcher is used.

    WARNING: as of Solr 1.4, ord() and rord() can cause excess memory use since they must use a FieldCache entry at the top level reader, while sorting and function queries now use entries at the segment level. Hence sorting or using a different function query, in addition to ord()/rord() will double memory use.
    Declaration
    protected readonly string m_field
    Field Value
    Type Description
    string

    Methods

    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)
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.