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

All Known Implementing Classes:

IncrementalBustosNavarroChavezByte, IncrementalBustosNavarroChavezDouble, IncrementalBustosNavarroChavezFloat, IncrementalBustosNavarroChavezInt, IncrementalBustosNavarroChavezLong, IncrementalBustosNavarroChavezShort, IncrementalDummyPivotSelector, IncrementalFixedPivotSelector, IncrementalPermFloat, RandomPivotSelector, SSSByte, SSSDouble, SSSFloat, SSSInt, SSSLong, SSSShort

public interface IncrementalPivotSelector<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

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

Method Detail

generatePivots

PivotResult generatePivots(int pivotCount,
                           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.

generatePivots

PivotResult generatePivots(int pivotCount,
                           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