Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class FieldDoc

    Expert: A ScoreDoc which also contains information about how to sort the referenced document. In addition to the document number and score, this object contains an array of values for the document from the field(s) used to sort. For example, if the sort criteria was to sort by fields "a", "b" then "c", the fields object array will have three elements, corresponding respectively to the term values for the document in fields "a", "b" and "c". The class of each element in the array will be either int, float or string depending on the type of values in the terms of each field.

    Created: Feb 11, 2004 1:23:38 PM

    @since lucene 1.4
    Inheritance
    object
    ScoreDoc
    FieldDoc
    Inherited Members
    ScoreDoc.Score
    ScoreDoc.Doc
    ScoreDoc.ShardIndex
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search
    Assembly: Lucene.Net.dll
    Syntax
    public class FieldDoc : ScoreDoc

    Constructors

    FieldDoc(int, float)

    Expert: Creates one of these objects with empty sort information.

    Declaration
    public FieldDoc(int doc, float score)
    Parameters
    Type Name Description
    int doc
    float score
    See Also
    ScoreDoc
    TopFieldDocs

    FieldDoc(int, float, object[])

    Expert: Creates one of these objects with the given sort information.

    Declaration
    public FieldDoc(int doc, float score, object[] fields)
    Parameters
    Type Name Description
    int doc
    float score
    object[] fields
    See Also
    ScoreDoc
    TopFieldDocs

    FieldDoc(int, float, object[], int)

    Expert: Creates one of these objects with the given sort information.

    Declaration
    public FieldDoc(int doc, float score, object[] fields, int shardIndex)
    Parameters
    Type Name Description
    int doc
    float score
    object[] fields
    int shardIndex
    See Also
    ScoreDoc
    TopFieldDocs

    Fields

    Fields

    Expert: The values which are used to sort the referenced document. The order of these will match the original sort criteria given by a Sort object. Each Object will have been returned from the GetValue(int) method corresponding FieldComparer used to sort this field.

    Declaration
    public object[] Fields
    Field Value
    Type Description
    object[]
    See Also
    Sort
    Search(Query, Filter, int, Sort)

    Methods

    ToString()

    A convenience method for debugging.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    ScoreDoc.ToString()
    See Also
    ScoreDoc
    TopFieldDocs

    See Also

    ScoreDoc
    TopFieldDocs
    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.