org.apache.lucene.search
Class FieldCache.DocTerms

java.lang.Object
  org.apache.lucene.search.FieldCache.DocTerms

Enclosing interface:

FieldCache

public abstract static class FieldCache.DocTerms
extends Object

Returned by FieldCache.getTerms(org.apache.lucene.index.AtomicReader, java.lang.String)

Constructor Summary

FieldCache.DocTerms()

Method Summary

abstract boolean	exists(int docID) Returns true if this doc has this field and is not deleted.
abstract BytesRef	getTerm(int docID, BytesRef ret) The BytesRef argument must not be null; the method returns the same BytesRef, or an empty (length=0) BytesRef if the doc did not have this field or was deleted.
abstract int	size() Number of documents

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldCache.DocTerms

public FieldCache.DocTerms()

Method Detail

getTerm

public abstract BytesRef getTerm(int docID,
                                 BytesRef ret)

The BytesRef argument must not be null; the method returns the same BytesRef, or an empty (length=0) BytesRef if the doc did not have this field or was deleted.

exists

public abstract boolean exists(int docID)

Returns true if this doc has this field and is not deleted.

size

public abstract int size()

Number of documents