org.eclipse.smila.connectivity
Interface ConnectivityManager

All Known Implementing Classes:

ConnectivityManagerImpl

public interface ConnectivityManager

The Interface ConnectivityManager.

Field Summary

static java.lang.String

HASH_TOKEN The HAS h_ token.

Method Summary

int	add(Record[] records) Put the given records for further processing to the ADD Queue.
boolean[]	checkForUpdate(Record[] diData) Checks for each DeltaIndexing data, if it needs to be updated in the system.
void	clearDeltaIndexing() Administrative reset method.
void	clearDeltaIndexingByDataSourceId(java.lang.String dataSourceId) Administrative reset method.
int	delete(Id[] ids) Put the the given ids for Deletion from the system to the DELETE Queue.
int	deleteDeltaByCompoundId(Id compoundId) Initiates a delta delete for the given compound object ID and all it's elements.
int	deleteDeltaByDataSourceId(java.lang.String dataSourceId) Initiates a delta delete for the given dataSourceID.
void	finishDeltaIndexingByCompoundId(Id compoundId) Finishes a DeltaIndexing run for the given compoundId.
void	finishDeltaIndexingByDataSourceId(java.lang.String dataSourceId) Finishes a DeltaIndexing run for the given dataSourceId.
void	initDeltaIndexingByCompoundId(Id compoundId) Initializes a DeltaIndexing run for the given compoundId.
void	initDeltaIndexingByDataSourceId(java.lang.String dataSourceId) Initializes a DeltaIndexing run for the given dataSourceId.

Field Detail

HASH_TOKEN

static final java.lang.String HASH_TOKEN

The HAS h_ token.

See Also:

Constant Field Values

Method Detail

add

int add(Record[] records)
        throws ConnectivityException

Put the given records for further processing to the ADD Queue.

Parameters:

records - a list of Record objects

Returns:

the number of records successfully added to the ADD Queue

Throws:

ConnectivityException - if any error occurs

delete

int delete(Id[] ids)
           throws ConnectivityException

Put the the given ids for Deletion from the system to the DELETE Queue.

Parameters:

ids - a list of IDs to delete

Returns:

the number of ids successfully added to the DELETE Queue

Throws:

ConnectivityException - if any error occurs

initDeltaIndexingByDataSourceId

void initDeltaIndexingByDataSourceId(java.lang.String dataSourceId)
                                     throws ConnectivityException

Initializes a DeltaIndexing run for the given dataSourceId.

Parameters:

dataSourceId - the ID of the data source

Throws:

ConnectivityException - if any error occurs

initDeltaIndexingByCompoundId

void initDeltaIndexingByCompoundId(Id compoundId)
                                   throws ConnectivityException

Initializes a DeltaIndexing run for the given compoundId. This method is used by Agents only.

Parameters:

compoundId - the Id of the compound object

Throws:

ConnectivityException - if any error occurs if any error occurs

finishDeltaIndexingByDataSourceId

void finishDeltaIndexingByDataSourceId(java.lang.String dataSourceId)
                                       throws ConnectivityException

Finishes a DeltaIndexing run for the given dataSourceId.

Parameters:

dataSourceId - the ID of the data source

Throws:

ConnectivityException - if any error occurs

finishDeltaIndexingByCompoundId

void finishDeltaIndexingByCompoundId(Id compoundId)
                                     throws ConnectivityException

Finishes a DeltaIndexing run for the given compoundId. This method is used by Agents only.

Parameters:

compoundId - the Id of the compound object

Throws:

ConnectivityException - if any error occurs if any error occurs

checkForUpdate

boolean[] checkForUpdate(Record[] diData)
                         throws ConnectivityException

Checks for each DeltaIndexing data, if it needs to be updated in the system. Updated means if the data is new or has changed. The positions of the returned list of boolean values matches the incoming list of Records.

Parameters:

diData - a list of Records containing DeltaIndexing data to check

Returns:

a list of boolean values

Throws:

ConnectivityException - if any error occurs

deleteDeltaByDataSourceId

int deleteDeltaByDataSourceId(java.lang.String dataSourceId)
                              throws ConnectivityException

Initiates a delta delete for the given dataSourceID. All DeltaIndexing records belonging to the dataSourceID, that were not marked as visited during this DeltaIndexing run are removed.

Parameters:

dataSourceId - the ID of the data source

Returns:

the number of records marked for delta-delete and successfully added to the delete Queue

Throws:

ConnectivityException - if any error occurs

deleteDeltaByCompoundId

int deleteDeltaByCompoundId(Id compoundId)
                            throws ConnectivityException

Initiates a delta delete for the given compound object ID and all it's elements. All DeltaIndexing records belonging to this compound object, that were not marked as visited are removed. This method is used by Agents only.

Parameters:

compoundId - the ID of the compound object

Returns:

the number of records marked for delta-delete and successfully added to the delete Queue

Throws:

ConnectivityException - if any error occurs

clearDeltaIndexing

void clearDeltaIndexing()
                        throws ConnectivityException

Administrative reset method. It removes all DeltaIndexing information.

Throws:

ConnectivityException - if any error occurs

clearDeltaIndexingByDataSourceId

void clearDeltaIndexingByDataSourceId(java.lang.String dataSourceId)
                                      throws ConnectivityException

Administrative reset method. It removes all DeltaIndexing information for the given dataSourceID.

Parameters:

dataSourceId - the ID of the data source

Throws:

ConnectivityException - if any error occurs