kaos.core.csi.extension.state
Interface StateMonitorManager

All Superinterfaces:
KAoSExtensionComponentManager

public interface StateMonitorManager
extends KAoSExtensionComponentManager

This interface defines a factory method for obtaining a StateMonitor for the given ontological type, representing a state. The monitor manager will be used to monitor properties of a given state for a particular entity. Methods are provided for sensors to update the state and for interested parties to query the state.


Method Summary
 StateSensor getStateMonitor(java.lang.String ontType)
          Return a StateMonitor for the specified ontological type.
 java.lang.String getStateValueForEntity(java.lang.String entityID, java.lang.String stateID)
          This method can be used to query the state database for the value of a state for a particular entity
 java.util.HashMap<java.lang.String,java.lang.String> getStateValuesForEntity(java.lang.String entityID)
          This method can be used to query the state database for the value of a state for a particular entity
 void removeEntity(java.lang.String entityID)
          This method is to be used by state sensors to remove all state associated with an entity in the overall state database maintained in the state monitor manager
 void removeState(java.lang.String stateID)
          This method is to be used by state sensors to remove all state associated with an entity in the overall state database maintained in the state monitor manager
 void removeStateForEntity(java.lang.String entityID, java.lang.String stateID)
          This method is to be used by state sensors to remove the current state from an entity in the overall state database maintained in the state monitor manager
 void updateState(java.util.HashMap<java.lang.String,java.util.HashMap> updates)
          This method is to be used by state sensors to publish the multiple state updates to an overall state database maintained in the state monitor manager
 void updateState(java.lang.String entityID, java.lang.String stateID, java.lang.String stateValue)
          This method is to be used by state sensors to publish the current state to an overall state database maintained in the state monitor manager
 
Methods inherited from interface kaos.core.csi.extension.KAoSExtensionComponentManager
changeComponentEnabledStatus, deregisterComponent, getAllKAoSExtensionComponents, getComponent, getComponentEnabledStatus, getRepositoryManagerType, getRepositoryTableInformation, loadConfiguration, registerComponent, removeAllKAoSExtensionComponents
 

Method Detail

getStateMonitor

StateSensor getStateMonitor(java.lang.String ontType)
Return a StateMonitor for the specified ontological type.

Parameters:
ontType - String specifying the ontological type, for which a StateMonitor is requested.
Returns:
StateMonitor an instance of the requested StateMonitor, or null, if the manager is not able to find or create the state monitor.

updateState

void updateState(java.util.HashMap<java.lang.String,java.util.HashMap> updates)
This method is to be used by state sensors to publish the multiple state updates to an overall state database maintained in the state monitor manager

Parameters:
updates - a mapping of entity IDs to a mapping of stateIDs to state values

updateState

void updateState(java.lang.String entityID,
                 java.lang.String stateID,
                 java.lang.String stateValue)
This method is to be used by state sensors to publish the current state to an overall state database maintained in the state monitor manager

Parameters:
entityID - String representing the id if the entity
stateID - String representing the id of the state
stateValue - String representing the current value of the state

removeStateForEntity

void removeStateForEntity(java.lang.String entityID,
                          java.lang.String stateID)
This method is to be used by state sensors to remove the current state from an entity in the overall state database maintained in the state monitor manager

Parameters:
entityID - The entity to remove state from
stateID - The particular state to remove

removeEntity

void removeEntity(java.lang.String entityID)
This method is to be used by state sensors to remove all state associated with an entity in the overall state database maintained in the state monitor manager

Parameters:
entityID - the entity ID to remove all state from

removeState

void removeState(java.lang.String stateID)
This method is to be used by state sensors to remove all state associated with an entity in the overall state database maintained in the state monitor manager

Parameters:
stateID - the state ID to be removed from all entities

getStateValueForEntity

java.lang.String getStateValueForEntity(java.lang.String entityID,
                                        java.lang.String stateID)
This method can be used to query the state database for the value of a state for a particular entity

Parameters:
entityID - String representing the entities ID
stateID - String representing the state ID of interest
Returns:
String representing the value of the current state for that specified entity

getStateValuesForEntity

java.util.HashMap<java.lang.String,java.lang.String> getStateValuesForEntity(java.lang.String entityID)
This method can be used to query the state database for the value of a state for a particular entity

Parameters:
entityID - String representing the entities ID
Returns:
map of states to their current values for the specified entity


Copyright © 2006 IHMC All Rights Reserved.