SMILA (incubation) API documentation

org.eclipse.smila.connectivity.deltaindexing2
Interface IDeltaIndexingManager


public interface IDeltaIndexingManager

The Interface DeltaIndexingManager.


Nested Class Summary
static class IDeltaIndexingManager.LockState
          An enumeration defining the lock states a data source in the DeltaIndexingManager.
 
Method Summary
 void clear()
          Clears all entries of the DeltaIndexingManager including sessions.
 IDeltaIndexingSession createSession(java.lang.String dataSourceID)
          Initializes the internal state for an import of a dataSourceID and creates a session wherein it establishes a lock to avoid that the same dataSourceID is initialized multiple times concurrently.
 boolean dataSourceExists(java.lang.String dataSourceId)
          Checks if the entries for the given dataSourceId exist.
 long getEntryCount(java.lang.String dataSourceID)
          Get the number of delta indexing entries for the given dataSourceID.
 java.util.Map<java.lang.String,java.lang.Long> getEntryCounts()
          Get the number of delta indexing entries for all data sources.
 java.util.Map<java.lang.String,IDeltaIndexingManager.LockState> getLockStates()
          Gets an overview what data sources are locked or unlocked.
 void unlockDatasource(java.lang.String dataSourceID)
          Unlock the given data source and removes the sessions.
 void unlockDatasources()
          Unlock all data sources and removes all sessions.
 

Method Detail

createSession

IDeltaIndexingSession createSession(java.lang.String dataSourceID)
                                    throws DeltaIndexingException
Initializes the internal state for an import of a dataSourceID and creates a session wherein it establishes a lock to avoid that the same dataSourceID is initialized multiple times concurrently. It returns an object for the session that a client has to use to gain access to the locked data source.

Parameters:
dataSourceID - dataSourceID
Returns:
the i delta indexing session
Throws:
DeltaIndexingException - the delta indexing exception

clear

void clear()
           throws DeltaIndexingException
Clears all entries of the DeltaIndexingManager including sessions.

Throws:
DeltaIndexingException - the delta indexing exception

unlockDatasource

void unlockDatasource(java.lang.String dataSourceID)
                      throws DeltaIndexingException
Unlock the given data source and removes the sessions.

Parameters:
dataSourceID - the data source id
Throws:
DeltaIndexingException - the delta indexing exception

unlockDatasources

void unlockDatasources()
                       throws DeltaIndexingException
Unlock all data sources and removes all sessions.

Throws:
DeltaIndexingException - the delta indexing exception

getLockStates

java.util.Map<java.lang.String,IDeltaIndexingManager.LockState> getLockStates()
Gets an overview what data sources are locked or unlocked.

Returns:
a map containing the dataSoureId and the LockState

dataSourceExists

boolean dataSourceExists(java.lang.String dataSourceId)
Checks if the entries for the given dataSourceId exist.

Parameters:
dataSourceId - the data source id
Returns:
true, if successful

getEntryCount

long getEntryCount(java.lang.String dataSourceID)
Get the number of delta indexing entries for the given dataSourceID.

Parameters:
dataSourceID - the data source id
Returns:
the number of entries

getEntryCounts

java.util.Map<java.lang.String,java.lang.Long> getEntryCounts()
Get the number of delta indexing entries for all data sources.

Returns:
a map of dataSoureIds and the entry counts

SMILA (incubation) API documentation