Class FilteredTermEnum

    • Constructor Detail

      • FilteredTermEnum

        public FilteredTermEnum()
    • Method Detail

      • termCompare

        protected abstract boolean termCompare​(Term term)
        Equality compare on the term
      • difference

        public abstract float difference()
        Equality measure on the term
      • endEnum

        protected abstract boolean endEnum()
        Indicates the end of the enumeration has been reached
      • setEnum

        protected void setEnum​(TermEnum actualEnum)
                        throws IOException
        use this method to set the actual TermEnum (e.g. in ctor), it will be automatically positioned on the first matching term.
        Throws:
        IOException
      • docFreq

        public int docFreq()
        Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated.
        Specified by:
        docFreq in class TermEnum
      • next

        public boolean next()
                     throws IOException
        Increments the enumeration to the next element. True if one exists.
        Specified by:
        next in class TermEnum
        Throws:
        IOException
      • term

        public Term term()
        Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated.
        Specified by:
        term in class TermEnum