

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
java.lang.Object org.apache.lucene.index.Terms org.apache.lucene.index.FilterAtomicReader.FilterTerms
public static class FilterAtomicReader.FilterTerms
Base class for filtering Terms
implementations.
Field Summary  

protected Terms 
in
The underlying Terms instance. 
Fields inherited from class org.apache.lucene.index.Terms 

EMPTY_ARRAY 
Constructor Summary  

FilterAtomicReader.FilterTerms(Terms in)
Creates a new FilterTerms 
Method Summary  

Comparator<BytesRef> 
getComparator()
Return the BytesRef Comparator used to sort terms provided by the iterator. 
int 
getDocCount()
Returns the number of documents that have at least one term for this field, or 1 if this measure isn't stored by the codec. 
long 
getSumDocFreq()
Returns the sum of TermsEnum.docFreq() for
all terms in this field, or 1 if this measure isn't
stored by the codec. 
long 
getSumTotalTermFreq()
Returns the sum of TermsEnum.totalTermFreq() for
all terms in this field, or 1 if this measure isn't
stored by the codec (or if this fields omits term freq
and positions). 
boolean 
hasOffsets()
Returns true if documents in this field store offsets. 
boolean 
hasPayloads()
Returns true if documents in this field store payloads. 
boolean 
hasPositions()
Returns true if documents in this field store positions. 
TermsEnum 
intersect(CompiledAutomaton automaton,
BytesRef bytes)
Returns a TermsEnum that iterates over all terms that are accepted by the provided CompiledAutomaton . 
TermsEnum 
iterator(TermsEnum reuse)
Returns an iterator that will step through all terms. 
long 
size()
Returns the number of terms for this field, or 1 if this measure isn't stored by the codec. 
Methods inherited from class java.lang.Object 

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 
Field Detail 

protected final Terms in
Constructor Detail 

public FilterAtomicReader.FilterTerms(Terms in)
in
 the underlying Terms instance.Method Detail 

public TermsEnum iterator(TermsEnum reuse) throws IOException
Terms
iterator
in class Terms
IOException
public Comparator<BytesRef> getComparator()
Terms
getComparator
in class Terms
public long size() throws IOException
Terms
size
in class Terms
IOException
public long getSumTotalTermFreq() throws IOException
Terms
TermsEnum.totalTermFreq()
for
all terms in this field, or 1 if this measure isn't
stored by the codec (or if this fields omits term freq
and positions). Note that, just like other term
measures, this measure does not take deleted documents
into account.
getSumTotalTermFreq
in class Terms
IOException
public long getSumDocFreq() throws IOException
Terms
TermsEnum.docFreq()
for
all terms in 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.
getSumDocFreq
in class Terms
IOException
public int getDocCount() throws IOException
Terms
getDocCount
in class Terms
IOException
public TermsEnum intersect(CompiledAutomaton automaton, BytesRef bytes) throws IOException
Terms
CompiledAutomaton
. If the startTerm
is
provided then the returned enum will only accept 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.
NOTE: the returned TermsEnum cannot seek
.
intersect
in class Terms
IOException
public boolean hasOffsets()
Terms
hasOffsets
in class Terms
public boolean hasPositions()
Terms
hasPositions
in class Terms
public boolean hasPayloads()
Terms
hasPayloads
in class Terms


PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 