Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class MultiFunction

    Abstract parent class for ValueSource implementations that wrap multiple ValueSources and apply their own logic.

    Inheritance
    object
    ValueSource
    MultiFunction
    DefFunction
    Inherited Members
    ValueSource.GetValues(IDictionary, AtomicReaderContext)
    ValueSource.ToString()
    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 abstract class MultiFunction : ValueSource

    Constructors

    MultiFunction(IList<ValueSource>)

    Abstract parent class for ValueSource implementations that wrap multiple ValueSources and apply their own logic.

    Declaration
    protected MultiFunction(IList<ValueSource> sources)
    Parameters
    Type Name Description
    IList<ValueSource> sources

    Fields

    m_sources

    Abstract parent class for ValueSource implementations that wrap multiple ValueSources and apply their own logic.

    Declaration
    protected readonly IList<ValueSource> m_sources
    Field Value
    Type Description
    IList<ValueSource>

    Properties

    Name

    Abstract parent class for ValueSource implementations that wrap multiple ValueSources and apply their own logic.

    Declaration
    protected abstract string Name { get; }
    Property Value
    Type Description
    string

    Methods

    CreateWeight(IDictionary, IndexSearcher)

    Implementations should propagate CreateWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to GetValues() where this info can be retrieved.

    Declaration
    public override void CreateWeight(IDictionary context, IndexSearcher searcher)
    Parameters
    Type Name Description
    IDictionary context
    IndexSearcher searcher
    Overrides
    ValueSource.CreateWeight(IDictionary, IndexSearcher)

    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()

    GetDescription(string, IList<ValueSource>)

    Abstract parent class for ValueSource implementations that wrap multiple ValueSources and apply their own logic.

    Declaration
    public static string GetDescription(string name, IList<ValueSource> sources)
    Parameters
    Type Name Description
    string name
    IList<ValueSource> sources
    Returns
    Type Description
    string

    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()

    ToString(string, FunctionValues[], int)

    Abstract parent class for ValueSource implementations that wrap multiple ValueSources and apply their own logic.

    Declaration
    public static string ToString(string name, FunctionValues[] valsArr, int doc)
    Parameters
    Type Name Description
    string name
    FunctionValues[] valsArr
    int doc
    Returns
    Type Description
    string

    ValsArr(IList<ValueSource>, IDictionary, AtomicReaderContext)

    Abstract parent class for ValueSource implementations that wrap multiple ValueSources and apply their own logic.

    Declaration
    public static FunctionValues[] ValsArr(IList<ValueSource> sources, IDictionary fcontext, AtomicReaderContext readerContext)
    Parameters
    Type Name Description
    IList<ValueSource> sources
    IDictionary fcontext
    AtomicReaderContext readerContext
    Returns
    Type Description
    FunctionValues[]
    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.