The FilteredTermEnum type exposes the following members.
Constructors
Name | Description | |
---|---|---|
FilteredTermEnum | Initializes a new instance of the FilteredTermEnum class |
Methods
Name | Description | |
---|---|---|
Close | Closes the enumeration to further activity, freeing resources. (Overrides TermEnum..::..Close()()()().) | |
Difference | Equality measure on the term | |
DocFreq | Returns the docFreq of the current Term in the enumeration.
Returns -1 if no Term matches or all terms have been enumerated.
(Overrides TermEnum..::..DocFreq()()()().) | |
EndEnum | Indicates the end of the enumeration has been reached | |
Equals | (Inherited from Object.) | |
Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Next | Increments the enumeration to the next element. True if one exists. (Overrides TermEnum..::..Next()()()().) | |
SetEnum | use this method to set the actual TermEnum (e.g. in ctor),
it will be automatically positioned on the first matching term.
| |
SkipTo | Obsolete. Skips terms to the first beyond the current whose value is
greater or equal to target. Returns true iff there is such
an entry. Behaves as if written: (Inherited from TermEnum.)public boolean skipTo(Term target) { do { if (!next()) return false; } while (target > term()); return true; }Some implementations *could* be considerably more efficient than a linear scan. Check the implementation to be sure. | |
Term | Returns the current Term in the enumeration.
Returns null if no Term matches or all terms have been enumerated.
(Overrides TermEnum..::..Term()()()().) | |
TermCompare | Equality compare on the term | |
ToString | (Inherited from Object.) |
Fields
Name | Description | |
---|---|---|
actualEnum | the delegate enum - to set this member use {@link #setEnum} | |
currentTerm | the current term |