Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class FieldExtensions

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Inheritance
    object
    FieldExtensions
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Documents
    Assembly: Lucene.Net.dll
    Syntax
    public static class FieldExtensions

    Methods

    IsAnalyzed(Index)

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Declaration
    [Obsolete("This is here only to ease transition from the pre-4.0 APIs.")]
    public static bool IsAnalyzed(this Field.Index index)
    Parameters
    Type Name Description
    Field.Index index
    Returns
    Type Description
    bool

    IsIndexed(Index)

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Declaration
    [Obsolete("This is here only to ease transition from the pre-4.0 APIs.")]
    public static bool IsIndexed(this Field.Index index)
    Parameters
    Type Name Description
    Field.Index index
    Returns
    Type Description
    bool

    IsStored(Store)

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Declaration
    public static bool IsStored(this Field.Store store)
    Parameters
    Type Name Description
    Field.Store store
    Returns
    Type Description
    bool

    IsStored(TermVector)

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Declaration
    [Obsolete("This is here only to ease transition from the pre-4.0 APIs.")]
    public static bool IsStored(this Field.TermVector tv)
    Parameters
    Type Name Description
    Field.TermVector tv
    Returns
    Type Description
    bool

    OmitNorms(Index)

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Declaration
    [Obsolete("This is here only to ease transition from the pre-4.0 APIs.")]
    public static bool OmitNorms(this Field.Index index)
    Parameters
    Type Name Description
    Field.Index index
    Returns
    Type Description
    bool

    ToIndex(bool, bool)

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Declaration
    [Obsolete("This is here only to ease transition from the pre-4.0 APIs.")]
    public static Field.Index ToIndex(bool indexed, bool analyed)
    Parameters
    Type Name Description
    bool indexed
    bool analyed
    Returns
    Type Description
    Field.Index

    ToIndex(bool, bool, bool)

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Declaration
    [Obsolete("This is here only to ease transition from the pre-4.0 APIs.")]
    public static Field.Index ToIndex(bool indexed, bool analyzed, bool omitNorms)
    Parameters
    Type Name Description
    bool indexed
    bool analyzed
    bool omitNorms
    Returns
    Type Description
    Field.Index

    ToTermVector(bool, bool, bool)

    Get the best representation of a TermVector given the flags.

    Declaration
    [Obsolete("This is here only to ease transition from the pre-4.0 APIs.")]
    public static Field.TermVector ToTermVector(bool stored, bool withOffsets, bool withPositions)
    Parameters
    Type Name Description
    bool stored
    bool withOffsets
    bool withPositions
    Returns
    Type Description
    Field.TermVector

    WithOffsets(TermVector)

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Declaration
    [Obsolete("This is here only to ease transition from the pre-4.0 APIs.")]
    public static bool WithOffsets(this Field.TermVector tv)
    Parameters
    Type Name Description
    Field.TermVector tv
    Returns
    Type Description
    bool

    WithPositions(TermVector)

    LUCENENET specific extension methods to add functionality to enumerations that mimic Lucene

    Declaration
    [Obsolete("This is here only to ease transition from the pre-4.0 APIs.")]
    public static bool WithPositions(this Field.TermVector tv)
    Parameters
    Type Name Description
    Field.TermVector tv
    Returns
    Type Description
    bool
    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.