• API

    Show / Hide Table of Contents

    Class FieldInfos

    Collection of FieldInfos (accessible by number or by name).

    This is a Lucene.NET EXPERIMENTAL API, use at your own risk
    Inheritance
    System.Object
    FieldInfos
    Implements
    System.Collections.Generic.IEnumerable<FieldInfo>
    System.Collections.IEnumerable
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.dll
    Syntax
    public class FieldInfos : IEnumerable<FieldInfo>, IEnumerable

    Constructors

    | Improve this Doc View Source

    FieldInfos(FieldInfo[])

    Constructs a new FieldInfos from an array of FieldInfo objects

    Declaration
    public FieldInfos(FieldInfo[] infos)
    Parameters
    Type Name Description
    FieldInfo[] infos

    Properties

    | Improve this Doc View Source

    Count

    Returns the number of fields.

    NOTE: This was size() in Lucene.

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

    HasDocValues

    Returns true if any fields have DocValues

    Declaration
    public virtual bool HasDocValues { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasFreq

    Returns true if any fields have freqs

    Declaration
    public virtual bool HasFreq { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasNorms

    Returns true if any fields have norms

    Declaration
    public virtual bool HasNorms { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasOffsets

    Returns true if any fields have offsets

    Declaration
    public virtual bool HasOffsets { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasPayloads

    Returns true if any fields have payloads

    Declaration
    public virtual bool HasPayloads { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasProx

    Returns true if any fields have positions

    Declaration
    public virtual bool HasProx { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    HasVectors

    Returns true if any fields have vectors

    Declaration
    public virtual bool HasVectors { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    | Improve this Doc View Source

    FieldInfo(Int32)

    Return the FieldInfo object referenced by the fieldNumber.

    Declaration
    public virtual FieldInfo FieldInfo(int fieldNumber)
    Parameters
    Type Name Description
    System.Int32 fieldNumber

    field's number.

    Returns
    Type Description
    FieldInfo

    the FieldInfo object or null when the given fieldNumber doesn't exist.

    Exceptions
    Type Condition
    System.ArgumentException

    if fieldNumber is negative

    | Improve this Doc View Source

    FieldInfo(String)

    Return the FieldInfo object referenced by the fieldName

    Declaration
    public virtual FieldInfo FieldInfo(string fieldName)
    Parameters
    Type Name Description
    System.String fieldName
    Returns
    Type Description
    FieldInfo

    the FieldInfo object or null when the given fieldName doesn't exist.

    | Improve this Doc View Source

    GetEnumerator()

    Returns an iterator over all the fieldinfo objects present, ordered by ascending field number

    Declaration
    public virtual IEnumerator<FieldInfo> GetEnumerator()
    Returns
    Type Description
    System.Collections.Generic.IEnumerator<FieldInfo>

    Explicit Interface Implementations

    | Improve this Doc View Source

    IEnumerable.GetEnumerator()

    Declaration
    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type Description
    System.Collections.IEnumerator

    Implements

    System.Collections.Generic.IEnumerable<T>
    System.Collections.IEnumerable
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)