Class FSTTermsReader.TermsReader

    • Field Detail

      • numTerms

        final long numTerms
      • sumTotalTermFreq

        final long sumTotalTermFreq
      • sumDocFreq

        final long sumDocFreq
      • docCount

        final int docCount
      • longsSize

        final int longsSize
    • Constructor Detail

      • TermsReader

        TermsReader​(FieldInfo fieldInfo,
                    IndexInput in,
                    long numTerms,
                    long sumTotalTermFreq,
                    long sumDocFreq,
                    int docCount,
                    int longsSize)
             throws java.io.IOException
        Throws:
        java.io.IOException
    • Method Detail

      • ramBytesUsed

        public long ramBytesUsed()
        Description copied from interface: Accountable
        Return the memory usage of this object in bytes. Negative values are illegal.
        Specified by:
        ramBytesUsed in interface Accountable
      • getChildResources

        public java.util.Collection<Accountable> getChildResources()
        Description copied from interface: Accountable
        Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).
        Specified by:
        getChildResources in interface Accountable
        See Also:
        Accountables
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • hasFreqs

        public boolean hasFreqs()
        Description copied from class: Terms
        Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).
        Specified by:
        hasFreqs in class Terms
      • hasOffsets

        public boolean hasOffsets()
        Description copied from class: Terms
        Returns true if documents in this field store offsets.
        Specified by:
        hasOffsets in class Terms
      • hasPositions

        public boolean hasPositions()
        Description copied from class: Terms
        Returns true if documents in this field store positions.
        Specified by:
        hasPositions in class Terms
      • hasPayloads

        public boolean hasPayloads()
        Description copied from class: Terms
        Returns true if documents in this field store payloads.
        Specified by:
        hasPayloads in class Terms
      • size

        public long size()
        Description copied from class: Terms
        Returns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.
        Specified by:
        size in class Terms
      • getSumTotalTermFreq

        public long getSumTotalTermFreq()
        Description copied from class: Terms
        Returns the sum of TermsEnum.totalTermFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.
        Specified by:
        getSumTotalTermFreq in class Terms
      • getSumDocFreq

        public long getSumDocFreq()
                           throws java.io.IOException
        Description copied from class: Terms
        Returns the sum of TermsEnum.docFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.
        Specified by:
        getSumDocFreq in class Terms
        Throws:
        java.io.IOException
      • getDocCount

        public int getDocCount()
                        throws java.io.IOException
        Description copied from class: Terms
        Returns the number of documents that have at least one term for this field. Note that, just like other term measures, this measure does not take deleted documents into account.
        Specified by:
        getDocCount in class Terms
        Throws:
        java.io.IOException
      • iterator

        public TermsEnum iterator()
                           throws java.io.IOException
        Description copied from class: Terms
        Returns an iterator that will step through all terms. This method will not return null.
        Specified by:
        iterator in class Terms
        Throws:
        java.io.IOException
      • intersect

        public TermsEnum intersect​(CompiledAutomaton compiled,
                                   BytesRef startTerm)
                            throws java.io.IOException
        Description copied from class: Terms
        Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton. If the startTerm is provided then the returned enum will only return terms > startTerm, but you still must call next() first to get to the first term. Note that the provided startTerm must be accepted by the automaton.

        This is an expert low-level API and will only work for NORMAL compiled automata. To handle any compiled automata you should instead use CompiledAutomaton.getTermsEnum(org.apache.lucene.index.Terms) instead.

        NOTE: the returned TermsEnum cannot seek

        .
        Overrides:
        intersect in class Terms
        Throws:
        java.io.IOException