org.apache.lucene.facet.associations

Class IntAssociationsPayloadIterator

java.lang.Object

org.apache.lucene.facet.associations.AssociationsPayloadIterator<CategoryIntAssociation>

org.apache.lucene.facet.associations.IntAssociationsPayloadIterator

public class IntAssociationsPayloadIterator
extends AssociationsPayloadIterator<CategoryIntAssociation>

An AssociationsPayloadIterator over integer association values.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Constructor and Description
IntAssociationsPayloadIterator(String field, CategoryIntAssociation association)

Method Summary

Methods

Modifier and Type	Method and Description
IntToIntMap	getAssociations(int docID) Returns the integer association values of the categories that are associated with the given document, or null if the document has no associations.
protected void	handleAssociation(int ordinal, CategoryIntAssociation association) A hook for extending classes to handle the given association value for the ordinal.

Methods inherited from class org.apache.lucene.facet.associations.AssociationsPayloadIterator

setNextDoc, setNextReader

Methods inherited from class java.lang.Object

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

Constructor Detail

IntAssociationsPayloadIterator

public IntAssociationsPayloadIterator(String field,
                              CategoryIntAssociation association)
                               throws IOException

Throws:

IOException

Method Detail

handleAssociation

protected void handleAssociation(int ordinal,
                     CategoryIntAssociation association)

Description copied from class: AssociationsPayloadIterator

A hook for extending classes to handle the given association value for the ordinal.

Specified by:

handleAssociation in class AssociationsPayloadIterator<CategoryIntAssociation>

getAssociations

public IntToIntMap getAssociations(int docID)
                            throws IOException

Returns the integer association values of the categories that are associated with the given document, or null if the document has no associations.

NOTE: you are not expected to modify the returned map.

Throws:

IOException