Show / Hide Table of Contents

    Class Fields

    Flex API for access to fields and terms

    This is a Lucene.NET EXPERIMENTAL API, use at your own risk
    Inheritance
    System.Object
    Fields
    FieldsProducer
    FilterAtomicReader.FilterFields
    MultiFields
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class Fields : IEnumerable<string>

    Constructors

    | Improve this Doc View Source

    Fields()

    Sole constructor. (For invocation by subclass constructors, typically implicit.)

    Declaration
    protected Fields()

    Fields

    | Improve this Doc View Source

    EMPTY_ARRAY

    Zero-length Fields array.

    Declaration
    public static readonly Fields[] EMPTY_ARRAY
    Field Value
    Type Description
    Fields[]

    Properties

    | Improve this Doc View Source

    Count

    Gets the number of fields or -1 if the number of distinct field names is unknown. If >= 0, GetEnumerator() will return as many field names.

    NOTE: This was size() in Lucene.

    Declaration
    public abstract int Count { get; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    UniqueTermCount

    Returns the number of terms for all fields, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.

    Declaration
    public virtual long UniqueTermCount { get; }
    Property Value
    Type Description
    System.Int64
    See Also
    Count

    Methods

    | Improve this Doc View Source

    GetEnumerator()

    Returns an enumerator that will step through all field names. This will not return null.

    Declaration
    public abstract IEnumerator<string> GetEnumerator()
    Returns
    Type Description
    IEnumerator<System.String>
    | Improve this Doc View Source

    GetTerms(String)

    Get the Terms for this field. This will return null if the field does not exist.

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