SMILA (incubation) API documentation

org.eclipse.smila.connectivity.deltaindexing
Class AbstractDeltaIndexingManagerAgent

java.lang.Object
  extended by org.eclipse.smila.management.LocatedManagementAgentBase
      extended by org.eclipse.smila.management.DeclarativeManagementAgent
          extended by org.eclipse.smila.management.DeclarativeServiceManagementAgent<DeltaIndexingManager>
              extended by org.eclipse.smila.connectivity.deltaindexing.AbstractDeltaIndexingManagerAgent
All Implemented Interfaces:
DeltaIndexingManagerAgent, LocatedManagementAgent, ManagementAgent
Direct Known Subclasses:
DeltaIndexingManagerAgentImpl, DeltaIndexingManagerAgentImpl

public abstract class AbstractDeltaIndexingManagerAgent
extends DeclarativeServiceManagementAgent<DeltaIndexingManager>
implements DeltaIndexingManagerAgent

An abstract base class for DeltaIndexingManagerAgent implementations.


Field Summary
 
Fields inherited from class org.eclipse.smila.management.DeclarativeServiceManagementAgent
_service
 
Fields inherited from class org.eclipse.smila.management.DeclarativeManagementAgent
_log
 
Constructor Summary
AbstractDeltaIndexingManagerAgent()
           
 
Method Summary
 void clear(java.lang.String dataSourceID)
          Clear.
 void clearAll()
          Clear all.
protected  java.lang.String getCategory()
          Gets the category.
 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,java.lang.String> getLockStates()
          Get an overview what data sources are locked or unlocked.
protected  java.lang.String getName()
          Gets the name.
 void unlock(java.lang.String dataSourceID)
          Unlocks the given data source.
 void unlockAll()
          Unlock all data sources.
 
Methods inherited from class org.eclipse.smila.management.DeclarativeServiceManagementAgent
setService, unsetService
 
Methods inherited from class org.eclipse.smila.management.DeclarativeManagementAgent
activate, deactivate
 
Methods inherited from class org.eclipse.smila.management.LocatedManagementAgentBase
getLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractDeltaIndexingManagerAgent

public AbstractDeltaIndexingManagerAgent()
Method Detail

getCategory

protected java.lang.String getCategory()
Gets the category.

Specified by:
getCategory in class LocatedManagementAgentBase
Returns:
the category
See Also:
LocatedManagementAgentBase.getCategory()

getName

protected java.lang.String getName()
Gets the name.

Specified by:
getName in class LocatedManagementAgentBase
Returns:
the name
See Also:
LocatedManagementAgentBase.getName()

clear

public void clear(java.lang.String dataSourceID)
Clear.

Specified by:
clear in interface DeltaIndexingManagerAgent
Parameters:
dataSourceID - the data source id
See Also:
DeltaIndexingManagerAgent.clear(java.lang.String)

clearAll

public void clearAll()
Clear all.

Specified by:
clearAll in interface DeltaIndexingManagerAgent
See Also:
DeltaIndexingManagerAgent.clearAll()

unlock

public void unlock(java.lang.String dataSourceID)
Unlocks the given data source.

Specified by:
unlock in interface DeltaIndexingManagerAgent
Parameters:
dataSourceID - the data source id
See Also:
DeltaIndexingManagerAgent.unlock(String)

unlockAll

public void unlockAll()
Unlock all data sources.

Specified by:
unlockAll in interface DeltaIndexingManagerAgent
See Also:
DeltaIndexingManagerAgent.unlockAll()

getLockStates

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

Specified by:
getLockStates in interface DeltaIndexingManagerAgent
Returns:
a map containing the dataSoureId and the LockState
See Also:
DeltaIndexingManagerAgent.getLockStates()

getEntryCount

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

Specified by:
getEntryCount in interface DeltaIndexingManagerAgent
Parameters:
dataSourceID - the data source id
Returns:
the number of entries
See Also:
DeltaIndexingManagerAgent.getEntryCount(String)

getEntryCounts

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

Specified by:
getEntryCounts in interface DeltaIndexingManagerAgent
Returns:
a map containing the dataSoureId and the entry count
See Also:
DeltaIndexingManagerAgent.getEntryCounts()

SMILA (incubation) API documentation