The FilteredTermEnum type exposes the following members.

Constructors

  NameDescription
Public methodFilteredTermEnum
Initializes a new instance of the FilteredTermEnum class

Methods

  NameDescription
Public methodClose
Closes the enumeration to further activity, freeing resources.
(Overrides TermEnum..::..Close()()()().)
Public methodDifference
Equality measure on the term
Public methodDocFreq
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()()()().)
Public methodEndEnum
Indicates the end of the enumeration has been reached
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNext
Increments the enumeration to the next element. True if one exists.
(Overrides TermEnum..::..Next()()()().)
Protected methodSetEnum
use this method to set the actual TermEnum (e.g. in ctor), it will be automatically positioned on the first matching term.
Public methodSkipTo 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:

            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.
(Inherited from TermEnum.)
Public methodTerm
Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated.
(Overrides TermEnum..::..Term()()()().)
Public methodTermCompare
Equality compare on the term
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)

Fields

  NameDescription
Protected fieldactualEnum
the delegate enum - to set this member use {@link #setEnum}
Protected fieldcurrentTerm
the current term

See Also