net.obsearch.pivots
Interface IncrementalPairPivotSelector<O extends OB>

All Known Implementing Classes:

AbstractIncrementalRF02, AbstractIncrementalRF03, AbstractIncrementalRF04, RF02PivotSelectorFloat, RF02PivotSelectorShort, RF03PivotSelectorFloat, RF03PivotSelectorLong, RF03PivotSelectorShort, RF04PivotSelectorByte, RF04PivotSelectorDouble, RF04PivotSelectorFloat, RF04PivotSelectorFloat, RF04PivotSelectorInt, RF04PivotSelectorInt, RF04PivotSelectorLong, RF04PivotSelectorShort, RF04PivotSelectorShort

public interface IncrementalPairPivotSelector<O extends OB>

Objects that implement the IncrementalPivotSelector interface are expected to take objects from a) all the database, b) a subset of the database. The pivot selector should return a list with all the objects that will be pivots.

Author:

Arnoldo Jose Muller Molina

Method Summary

PivotPairResult<O>	generatePivotsPair(int pairCount, Index<O> index) Generates pivots from all the elements found in the DB.
PivotPairResult<O>	generatePivotsPair(int pairCount, cern.colt.list.LongArrayList elements, Index<O> index) Generates pivots from the elements (object ids) given in the array elements.

Method Detail

generatePivotsPair

PivotPairResult<O> generatePivotsPair(int pairCount,
                                      Index<O> index)
                                                 throws OBException,
                                                        IllegalAccessException,
                                                        InstantiationException,
                                                        OBStorageException,
                                                        PivotsUnavailableException

Generates pivots from all the elements found in the DB.

Parameters:

pivotCount - The # of pivots that will be generated.

Returns:

A list of the ids of the pivots.

Throws:

OBStorageException - If something goes wrong with the DB

OBException - User generated exception

IllegalAccessException - If there is a problem when instantiating objects O

InstantiationException - If there is a problem when instantiating objects O

PivotsUnavailableException - If not all the pivots requested were found.

generatePivotsPair

PivotPairResult<O> generatePivotsPair(int pairCount,
                                      cern.colt.list.LongArrayList elements,
                                      Index<O> index)
                                                 throws OBException,
                                                        IllegalAccessException,
                                                        InstantiationException,
                                                        OBStorageException,
                                                        PivotsUnavailableException

Generates pivots from the elements (object ids) given in the array elements. Generates pivotsCount pivots.

Parameters:

pivotCount -

elements -

Returns:

A list of the ids of the pivots.

Throws:

OBException

IllegalAccessException

InstantiationException

OBStorageException

PivotsUnavailableException