org.apache.lucene.facet.search
Class PayloadCategoryListIteraor
java.lang.Object
org.apache.lucene.facet.search.PayloadCategoryListIteraor
- All Implemented Interfaces:
- CategoryListIterator
public class PayloadCategoryListIteraor
- extends Object
- implements CategoryListIterator
A CategoryListIterator
which reads the category ordinals from a
payload.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
PayloadCategoryListIteraor
public PayloadCategoryListIteraor(Term term,
IntDecoder decoder)
throws IOException
- Throws:
IOException
equals
public boolean equals(Object other)
- Overrides:
equals
in class Object
hashCode
public int hashCode()
- Overrides:
hashCode
in class Object
setNextReader
public boolean setNextReader(AtomicReaderContext context)
throws IOException
- Description copied from interface:
CategoryListIterator
- Sets the
AtomicReaderContext
for which
CategoryListIterator.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 CategoryListIterator.getOrdinals(int, IntsRef)
.
- Specified by:
setNextReader
in interface CategoryListIterator
- Throws:
IOException
getOrdinals
public void getOrdinals(int docID,
IntsRef ints)
throws IOException
- Description copied from interface:
CategoryListIterator
- Stores the category ordinals of the given document ID in the given
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.
- Specified by:
getOrdinals
in interface CategoryListIterator
- Throws:
IOException
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.