|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CategoryListIterator
An interface for obtaining the category ordinals of documents.
getOrdinals(int, IntsRef)
calls are done with document IDs that are
local to the reader given to setNextReader(AtomicReaderContext)
.
NOTE: this class operates as a key to a map, and therefore you should
implement equals()
and hashCode()
for proper behavior.
Method Summary | |
---|---|
void |
getOrdinals(int docID,
IntsRef ints)
Stores the category ordinals of the given document ID in the given IntsRef , starting at position 0 upto IntsRef.length . |
boolean |
setNextReader(AtomicReaderContext context)
Sets the AtomicReaderContext for which
getOrdinals(int, IntsRef) calls will be made. |
Method Detail |
---|
boolean setNextReader(AtomicReaderContext context) throws IOException
AtomicReaderContext
for which
getOrdinals(int, IntsRef)
calls will be made. Returns true iff any
of the documents in this reader have category ordinals. This method must be
called before any calls to getOrdinals(int, IntsRef)
.
IOException
void getOrdinals(int docID, IntsRef ints) throws IOException
IntsRef
, starting at position 0 upto IntsRef.length
. Grows
the IntsRef
if it is not large enough.
NOTE: if the requested document does not have category ordinals
associated with it, IntsRef.length
is set to zero.
IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |