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 , or 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
    System.Object
    ScoreDoc
    FieldDoc
    Inherited Members
    ScoreDoc.Score
    ScoreDoc.Doc
    ScoreDoc.ShardIndex
    Namespace: Lucene.Net.Search
    Assembly: Lucene.Net.dll
    Syntax
    public class FieldDoc : ScoreDoc

    Constructors

    | Improve this Doc View Source

    FieldDoc(Int32, Single)

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

    Declaration
    public FieldDoc(int doc, float score)
    Parameters
    Type Name Description
    System.Int32 doc
    System.Single score
    | Improve this Doc View Source

    FieldDoc(Int32, Single, 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
    System.Int32 doc
    System.Single score
    System.Object[] fields
    | Improve this Doc View Source

    FieldDoc(Int32, Single, Object[], Int32)

    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
    System.Int32 doc
    System.Single score
    System.Object[] fields
    System.Int32 shardIndex

    Properties

    | Improve this Doc View Source

    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 Item[Int32] method corresponding FieldComparer used to sort this field.

    Declaration
    public object[] Fields { get; set; }
    Property Value
    Type Description
    System.Object[]
    See Also
    Sort
    Search(Query, Filter, Int32, Sort)

    Methods

    | Improve this Doc View Source

    ToString()

    A convenience method for debugging.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    ScoreDoc.ToString()

    See Also

    ScoreDoc
    TopFieldDocs
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)