org.apache.lucene.index

Class AssertingLeafReader.AssertingTerms

java.lang.Object

org.apache.lucene.index.Terms

org.apache.lucene.index.FilterLeafReader.FilterTerms

org.apache.lucene.index.AssertingLeafReader.AssertingTerms

Enclosing class:

AssertingLeafReader

public static class AssertingLeafReader.AssertingTerms
extends FilterLeafReader.FilterTerms

Wraps a Terms but with additional asserts

Field Summary

Fields inherited from class org.apache.lucene.index.FilterLeafReader.FilterTerms

in

Fields inherited from class org.apache.lucene.index.Terms

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
AssertingTerms(Terms in)

Method Summary

Modifier and Type	Method and Description
int	getDocCount() Returns the number of documents that have at least one term for this field.
BytesRef	getMax() Returns the largest term (in lexicographic order) in the field.
BytesRef	getMin() Returns the smallest term (in lexicographic order) in the field.
long	getSumDocFreq() Returns the sum of TermsEnum.docFreq() for all terms in this field.
long	getSumTotalTermFreq() Returns the sum of TermsEnum.totalTermFreq() for all terms in this field.
TermsEnum	intersect(CompiledAutomaton automaton, BytesRef bytes) Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton.
TermsEnum	iterator() Returns an iterator that will step through all terms.
String	toString()

Methods inherited from class org.apache.lucene.index.FilterLeafReader.FilterTerms

getStats, hasFreqs, hasOffsets, hasPayloads, hasPositions, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AssertingTerms

public AssertingTerms(Terms in)

Method Detail

intersect

public TermsEnum intersect(CompiledAutomaton automaton,
                           BytesRef bytes)
                    throws 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:

IOException

getMin

public BytesRef getMin()
                throws IOException

Description copied from class: Terms

Returns the smallest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms.

Overrides:

getMin in class Terms

Throws:

IOException

getMax

public BytesRef getMax()
                throws IOException

Description copied from class: Terms

Returns the largest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms.

Overrides:

getMax in class Terms

Throws:

IOException

getDocCount

public int getDocCount()
                throws 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.

Overrides:

getDocCount in class FilterLeafReader.FilterTerms

Throws:

IOException

getSumDocFreq

public long getSumDocFreq()
                   throws 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.

Overrides:

getSumDocFreq in class FilterLeafReader.FilterTerms

Throws:

IOException

getSumTotalTermFreq

public long getSumTotalTermFreq()
                         throws IOException

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.

Overrides:

getSumTotalTermFreq in class FilterLeafReader.FilterTerms

Throws:

IOException

iterator

public TermsEnum iterator()
                   throws IOException

Description copied from class: Terms

Returns an iterator that will step through all terms. This method will not return null.

Overrides:

iterator in class FilterLeafReader.FilterTerms

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object