|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StateMonitorManager
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 |
---|
StateSensor getStateMonitor(java.lang.String ontType)
ontType
- String specifying the ontological type, for which a StateMonitor is requested.
void updateState(java.util.HashMap<java.lang.String,java.util.HashMap> updates)
updates
- a mapping of entity IDs to a mapping of stateIDs to state valuesvoid updateState(java.lang.String entityID, java.lang.String stateID, java.lang.String stateValue)
entityID
- String representing the id if the entitystateID
- String representing the id of the statestateValue
- String representing the current value of the statevoid removeStateForEntity(java.lang.String entityID, java.lang.String stateID)
entityID
- The entity to remove state fromstateID
- The particular state to removevoid removeEntity(java.lang.String entityID)
entityID
- the entity ID to remove all state fromvoid removeState(java.lang.String stateID)
stateID
- the state ID to be removed from all entitiesjava.lang.String getStateValueForEntity(java.lang.String entityID, java.lang.String stateID)
entityID
- String representing the entities IDstateID
- String representing the state ID of interest
java.util.HashMap<java.lang.String,java.lang.String> getStateValuesForEntity(java.lang.String entityID)
entityID
- String representing the entities ID
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |