org.apache.lucene.facet.associations

Class FloatAssociationsPayloadIterator

java.lang.Object

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

org.apache.lucene.facet.associations.FloatAssociationsPayloadIterator

public class FloatAssociationsPayloadIterator
extends AssociationsPayloadIterator<CategoryFloatAssociation>

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
FloatAssociationsPayloadIterator(String field, CategoryFloatAssociation association)

Method Summary

Methods

Modifier and Type	Method and Description
IntToFloatMap	getAssociations(int docID) Returns the float 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, CategoryFloatAssociation 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

FloatAssociationsPayloadIterator

public FloatAssociationsPayloadIterator(String field,
                                CategoryFloatAssociation association)
                                 throws IOException

Throws:

IOException

Method Detail

handleAssociation

protected void handleAssociation(int ordinal,
                     CategoryFloatAssociation 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<CategoryFloatAssociation>

getAssociations

public IntToFloatMap getAssociations(int docID)
                              throws IOException

Returns the float 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