Class FilteredTermsEnum
Abstract class for enumerating a subset of all terms.
Term enumerations are always ordered by Comparer. Each term in the enumeration is greater than all that precede it.
Please note: Consumers of this enumeration cannot
call Seek(), it is forward only; it throws
Inherited Members
Assembly: DistributedLucene.Net.dll
Syntax
public abstract class FilteredTermsEnum : TermsEnum, IBytesRefIteratorConstructors
| Name | Description |
|---|---|
| FilteredTermsEnum(TermsEnum) | Creates a filtered TermsEnum on a terms enum. |
| FilteredTermsEnum(TermsEnum, Boolean) | Creates a filtered TermsEnum on a terms enum. |
Properties
| Name | Description |
|---|---|
| Attributes | Returns the related attributes, the returned AttributeSource is shared with the delegate TermsEnum. |
| Comparer | |
| DocFreq | |
| Ord | |
| Term | |
| TotalTermFreq |
Methods
| Name | Description |
|---|---|
| Accept(BytesRef) | Return if term is accepted, not accepted or the iteration should ended (and possibly seek). |
| Docs(IBits, DocsEnum, DocsFlags) | |
| DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags) | |
| GetTermState() | Returns the filtered enums term state |
| Next() | |
| NextSeekTerm(BytesRef) | On the first call to Next() or if Accept(BytesRef) returns
YES_AND_SEEK or NO_AND_SEEK,
this method will be called to eventually seek the underlying TermsEnum
to a new position.
On the first call,
Override this method, if you want a more sophisticated TermsEnum,
that repositions the iterator during enumeration.
If this method always returns
|
| SeekCeil(BytesRef) | this enum does not support seeking! |
| SeekExact(BytesRef) | this enum does not support seeking! |
| SeekExact(BytesRef, TermState) | this enum does not support seeking! |
| SeekExact(Int64) | this enum does not support seeking! |
| SetInitialSeekTerm(BytesRef) | Use this method to set the initial BytesRef
to seek before iterating. This is a convenience method for
subclasses that do not override NextSeekTerm(BytesRef).
If the initial seek term is You can only use this method, if you keep the default implementation of NextSeekTerm(BytesRef). |
