Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SingleTermsEnum

    Subclass of FilteredTermsEnum for enumerating a single term.

    For example, this can be used by MultiTermQuerys that need only visit one term, but want to preserve MultiTermQuery semantics such as MultiTermRewriteMethod.
    Inheritance
    object
    TermsEnum
    FilteredTermsEnum
    SingleTermsEnum
    Implements
    IBytesRefEnumerator
    Inherited Members
    FilteredTermsEnum.Attributes
    FilteredTermsEnum.Term
    FilteredTermsEnum.Comparer
    FilteredTermsEnum.DocFreq
    FilteredTermsEnum.TotalTermFreq
    FilteredTermsEnum.SeekExact(BytesRef)
    FilteredTermsEnum.SeekCeil(BytesRef)
    FilteredTermsEnum.SeekExact(long)
    FilteredTermsEnum.Ord
    FilteredTermsEnum.Docs(IBits, DocsEnum, DocsFlags)
    FilteredTermsEnum.DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)
    FilteredTermsEnum.SeekExact(BytesRef, TermState)
    FilteredTermsEnum.GetTermState()
    FilteredTermsEnum.MoveNext()
    TermsEnum.Docs(IBits, DocsEnum)
    TermsEnum.DocsAndPositions(IBits, DocsAndPositionsEnum)
    TermsEnum.EMPTY
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class SingleTermsEnum : FilteredTermsEnum, IBytesRefEnumerator

    Constructors

    SingleTermsEnum(TermsEnum, BytesRef)

    Creates a new SingleTermsEnum.

    After calling the constructor the enumeration is already pointing to the term, if it exists.
    Declaration
    public SingleTermsEnum(TermsEnum tenum, BytesRef termText)
    Parameters
    Type Name Description
    TermsEnum tenum
    BytesRef termText

    Methods

    Accept(BytesRef)

    Return if term is accepted, not accepted or the iteration should ended (and possibly seek).

    Declaration
    protected override FilteredTermsEnum.AcceptStatus Accept(BytesRef term)
    Parameters
    Type Name Description
    BytesRef term
    Returns
    Type Description
    FilteredTermsEnum.AcceptStatus
    Overrides
    FilteredTermsEnum.Accept(BytesRef)

    Implements

    IBytesRefEnumerator
    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.