Class FilterAtomicReader.FilterTermsEnum

Base class for filtering TermsEnum implementations.

Inheritance
object
TermsEnum
FilterAtomicReader.FilterTermsEnum
Implements
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public class FilterAtomicReader.FilterTermsEnum : TermsEnum, IBytesRefEnumerator

Constructors

FilterTermsEnum(TermsEnum)

Creates a new FilterAtomicReader.FilterTermsEnum

Declaration
public FilterTermsEnum(TermsEnum input)
Parameters
Type Name Description
TermsEnum input

the underlying TermsEnum instance.

Fields

m_input

The underlying TermsEnum instance.

Declaration
protected readonly TermsEnum m_input
Field Value
Type Description
TermsEnum

Properties

Attributes

Returns the related attributes.

Declaration
public override AttributeSource Attributes { get; }
Property Value
Type Description
AttributeSource
Overrides

Comparer

Return the BytesRef Comparer used to sort terms provided by the iterator. This may return null if there are no items or the iterator is not sorted. Callers may invoke this method many times, so it's best to cache a single instance & reuse it.

Declaration
public override IComparer<BytesRef> Comparer { get; }
Property Value
Type Description
IComparer<BytesRef>
Overrides

DocFreq

Returns the number of documents containing the current term. Do not call this when the enum is unpositioned.

Declaration
public override int DocFreq { get; }
Property Value
Type Description
int
Overrides
See Also

Ord

Returns ordinal position for current term. This is an optional property (the codec may throw NotSupportedException. Do not call this when the enum is unpositioned.

Declaration
public override long Ord { get; }
Property Value
Type Description
long
Overrides

Term

Returns current term. Do not call this when the enum is unpositioned.

Declaration
public override BytesRef Term { get; }
Property Value
Type Description
BytesRef
Overrides

TotalTermFreq

Returns the total number of occurrences of this term across all documents (the sum of the Freq for each doc that has this term). This will be -1 if the codec doesn't support this measure. Note that, like other term measures, this measure does not take deleted documents into account.

Declaration
public override long TotalTermFreq { get; }
Property Value
Type Description
long
Overrides

Methods

Docs(IBits, DocsEnum, DocsFlags)

Get DocsEnum for the current term, with control over whether freqs are required. Do not call this when the enum is unpositioned. This method will not return null.

Declaration
public override DocsEnum Docs(IBits liveDocs, DocsEnum reuse, DocsFlags flags)
Parameters
Type Name Description
IBits liveDocs

Unset bits are documents that should not be returned
DocsEnum reuse

Pass a prior DocsEnum for possible reuse
DocsFlags flags

Specifies which optional per-document values you require; DocsFlags
Returns
Type Description
DocsEnum
Overrides
See Also

DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)

Get DocsAndPositionsEnum for the current term, with control over whether offsets and payloads are required. Some codecs may be able to optimize their implementation when offsets and/or payloads are not required. Do not call this when the enum is unpositioned. This will return null if positions were not indexed.

Declaration
public override DocsAndPositionsEnum DocsAndPositions(IBits liveDocs, DocsAndPositionsEnum reuse, DocsAndPositionsFlags flags)
Parameters
Type Name Description
IBits liveDocs

Unset bits are documents that should not be returned
DocsAndPositionsEnum reuse

Pass a prior DocsAndPositionsEnum for possible reuse
DocsAndPositionsFlags flags

Specifies which optional per-position values you require; see DocsAndPositionsFlags.
Returns
Type Description
DocsAndPositionsEnum
Overrides

MoveNext()

Moves to the next item in the TermsEnum.

The default implementation can and should be overridden with a more optimized version.
Declaration
public override bool MoveNext()
Returns
Type Description
bool

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
Overrides

SeekCeil(BytesRef)

Seeks to the specified term, if it exists, or to the next (ceiling) term. Returns TermsEnum.SeekStatus to indicate whether exact term was found, a different term was found, or EOF was hit. The target term may be before or after the current term. If this returns END, the enum is unpositioned.

Declaration
public override TermsEnum.SeekStatus SeekCeil(BytesRef text)
Parameters
Type Name Description
BytesRef text
Returns
Type Description
TermsEnum.SeekStatus
Overrides

SeekExact(long)

Seeks to the specified term by ordinal (position) as previously returned by Ord. The target ord may be before or after the current ord, and must be within bounds.

Declaration
public override void SeekExact(long ord)
Parameters
Type Name Description
long ord
Overrides

Implements