org.apache.manifoldcf.crawler.interfaces

Interface IBinManager

All Known Implementing Classes:

BinManager

public interface IBinManager

This interface represents a class that tracks data in document bins.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid

Method Summary

Modifier and Type	Method and Description
void	deinstall() Uninstall.
double[]	getIncrementBinValues(java.lang.String connectorClass, java.lang.String binName, double newBinValue, int count) Get N bin values (and set next one).
double[]	getIncrementBinValuesInTransaction(java.lang.String connectorClass, java.lang.String binName, double newBinValue, int count) Get N bin values (and set next one).
void	install() Install or upgrade this table.
void	reset() Reset all bins

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

install

void install()
      throws ManifoldCFException

Install or upgrade this table.

Throws:

ManifoldCFException

deinstall

void deinstall()
        throws ManifoldCFException

Uninstall.

Throws:

ManifoldCFException

reset

void reset()
    throws ManifoldCFException

Reset all bins

Throws:

ManifoldCFException

getIncrementBinValues

double[] getIncrementBinValues(java.lang.String connectorClass,
                               java.lang.String binName,
                               double newBinValue,
                               int count)
                        throws ManifoldCFException

Get N bin values (and set next one). If the record does not yet exist, create it with a starting value. We expect this to happen within a transaction!!

Parameters:

connectorClass - is the class name of the connector

binName - is the name of the bin (256 char max)

newBinValue - is the value to use if there is no such bin yet. This is the value that will be returned; what will be stored will be that value + 1.

count - is the number of values desired.

Returns:

the counter values.

Throws:

ManifoldCFException

getIncrementBinValuesInTransaction

double[] getIncrementBinValuesInTransaction(java.lang.String connectorClass,
                                            java.lang.String binName,
                                            double newBinValue,
                                            int count)
                                     throws ManifoldCFException

Get N bin values (and set next one). If the record does not yet exist, create it with a starting value. This method invokes its own retry-able transaction.

Parameters:

connectorClass - is the class name of the connector

binName - is the name of the bin (256 char max)

newBinValue - is the value to use if there is no such bin yet. This is the value that will be returned; what will be stored will be that value + 1.

count - is the number of values desired.

Returns:

the counter values.

Throws:

ManifoldCFException