fr.liglab.adele.icasa

Interface ContextManager

All Known Subinterfaces:

SimulationManager

public interface ContextManager

This service provides all information about application context including available devices and zones. It is the main entry point of the iCasa platform. Most operations on the platform should be made using this service instead of modifying directly the platform objects (Zones, Devices).

Field Summary

Fields

Modifier and Type	Field and Description
static String	GATEWAY_ID_PROP_NAME Name of global property that holds the gateway identifier.

Method Summary

Methods

Modifier and Type	Method and Description
void	addGlobalVariable(String variableName) Adds a global variable.
void	addListener(IcasaListener listener) Adds a listener to the platform.
void	addZoneVariable(String zoneId, String variableName) Adds a variable on specified zone.
Zone	createZone(String id, int leftX, int topY, int bottomZ, int width, int height, int depth) Creates a new rectangular zone.
Zone	createZone(String id, Position center, int detectionScope) Creates a new rectangular zone using a center position.
LocatedDevice	getDevice(String deviceId) Returns an object which represents the device with specified id.
Set<String>	getDeviceIds() Returns serial numbers of all available devices.
Position	getDevicePosition(String deviceId) Returns current position of specified device.
List<LocatedDevice>	getDevices() Returns a set of objects that represent all available devices.
Set<String>	getDeviceTypes() Gets the set of devices Types existing in the platform.
GenericDevice	getGenericDevice(String deviceId) Returns device object that corresponds to specified serial number.
Set<Variable>	getGlobalVariables() Returns all global variables.
Object	getGlobalVariableValue(String variableName) Returns the value of a given global variable.
Set<String>	getProvidedServices(LocatedDevice device) Get a set of Service specifications of specified device.
Set<String>	getProvidedServices(String deviceType) Get a set of the Service specification
Zone	getZone(String zoneId) Gets the zone having the specified ID or null if there is no zone with this ID.
Zone	getZoneFromPosition(Position position) Gets the zone containing this position.
Set<String>	getZoneIds() Gets the set of zones' IDs.
List<Zone>	getZones() Returns all defined zones.
Set<String>	getZoneVariables(String zoneId) Gets the set of available variables names in a given zone.
Object	getZoneVariableValue(String zoneId, String variableName) Gets the value of a given variable in a specified zone.
void	moveDeviceIntoZone(String deviceId, String zoneId) Moves a device to a zone.
void	moveZone(String id, int leftX, int topY, int bottomZ) Moves a zone to a new top left corner position.
void	removeAllZones() Removes all zones in the platform.
void	removeListener(IcasaListener listener) Removes a listener from the platform.
void	removeZone(String id) Removes a zone given his identifier.
void	resetContext() Removes all zones.
void	resizeZone(String id, int width, int height, int depth) Resizes a zone using a new width and height.
void	setDevicePosition(String deviceId, Position position) Sets the device position.
void	setDeviceState(String deviceId, boolean activatedFlag) Sets activated flag of a device.
void	setGlobalVariable(String variableName, Object value) Sets specified global variable .
void	setParentZone(String zoneId, String parentId) Sets the zone parent.
void	setZoneVariable(String zoneId, String variableName, Object value) Sets the value of the specified variable.

Field Detail

GATEWAY_ID_PROP_NAME

static final String GATEWAY_ID_PROP_NAME

Name of global property that holds the gateway identifier.

See Also:

Constant Field Values

Method Detail

createZone

Zone createZone(String id,
              int leftX,
              int topY,
              int bottomZ,
              int width,
              int height,
              int depth)

Creates a new rectangular zone.

Parameters:

id - the identifier of the zone.

leftX - the left X value of the zone.

topY - the top X value of the zone.

width - the width of the zone.

height - the height of the zone.

Returns:

the created zone.

Throws:

IllegalArgumentException - when exists a zone with the same identifier.

createZone

Zone createZone(String id,
              Position center,
              int detectionScope)

Creates a new rectangular zone using a center position.

Parameters:

id - The identifier of the zone.

center - The center position of the new zone.

detectionScope - used to calculate the width/height of the zone. width = detectionScope * 2 height = detectionScope * 2

Returns:

the created zone.

Throws:

IllegalArgumentException - when a zone exists with the same identifier.

removeZone

void removeZone(String id)

Removes a zone given his identifier. Do nothing if such zone does not exist.

Parameters:

id - The zone identifier.

moveZone

void moveZone(String id,
            int leftX,
            int topY,
            int bottomZ)
              throws Exception

Moves a zone to a new top left corner position.

Parameters:

id - The identifier of the zone to move.

leftX - The new X corner value.

topY - The new Y corner value

Throws:

Exception - when new position does not fit in the parent zone.

resizeZone

void resizeZone(String id,
              int width,
              int height,
              int depth)
                throws Exception

Resizes a zone using a new width and height.

Parameters:

id - The identifier of the zone to resize.

width - the new width of the zone.

height - The new height of the zone

depth - The new depth of the zone

Throws:

Exception - Throws an exception when the zone does not fit in the parent zone.

removeAllZones

void removeAllZones()

Removes all zones in the platform.

getZoneVariables

Set<String> getZoneVariables(String zoneId)

Gets the set of available variables names in a given zone.

Parameters:

zoneId - the zone identifier.

Returns:

The set of the variables names of the zone.

getZoneVariableValue

Object getZoneVariableValue(String zoneId,
                          String variableName)

Gets the value of a given variable in a specified zone.

Parameters:

zoneId - The zone identifier to inspect the variables.

variableName - The variable name to retrieve its value.

Returns:

The value of the variable in the given zone.

addZoneVariable

void addZoneVariable(String zoneId,
                   String variableName)

Adds a variable on specified zone. Do nothing if such variable exists.

Parameters:

zoneId - zone identifier

variableName - name of a variable

setZoneVariable

void setZoneVariable(String zoneId,
                   String variableName,
                   Object value)

Sets the value of the specified variable.

Parameters:

zoneId - The zone identifier to inspect the variables.

variableName - The name of the variable to be modified.

value - The new value of the variable.

getZoneIds

Set<String> getZoneIds()

Gets the set of zones' IDs.

Returns:

The set of zones' IDs.

getZones

List<Zone> getZones()

Returns all defined zones. If there is no zone then returns an empty list.

Returns:

all defined zones.

getZone

Zone getZone(String zoneId)

Gets the zone having the specified ID or null if there is no zone with this ID.

Parameters:

zoneId - The ID of the zone to be retrieved.

Returns:

The zone having the specified ID or null.

getZoneFromPosition

Zone getZoneFromPosition(Position position)

Gets the zone containing this position. If several zones contains this positions returns the highest one.

Parameters:

position - A position

Returns:

The zone containing this position.

setParentZone

void setParentZone(String zoneId,
                 String parentId)
                   throws Exception

Sets the zone parent.

Parameters:

zoneId - The ID of zone to be modified.

parentId - The ID of the new parent zone.

Throws:

Exception - when the zone does not fit in the new parent zone.

getDeviceIds

Set<String> getDeviceIds()

Returns serial numbers of all available devices.

Returns:

serial numbers of all available devices.

setDeviceState

void setDeviceState(String deviceId,
                  boolean activatedFlag)

Sets activated flag of a device. If activatedFlag is equals to false, applications cannot use the corresponding device.

Parameters:

deviceId - a device identifier

activatedFlag - activation flag value

getDevice

LocatedDevice getDevice(String deviceId)

Returns an object which represents the device with specified id. It may contain additional information than the device provides such as location.

Parameters:

deviceId - a device serial number

Returns:

an object which represents the device with specified id.

getGenericDevice

GenericDevice getGenericDevice(String deviceId)

Returns device object that corresponds to specified serial number.

Parameters:

deviceId - device serial number

Returns:

device object that corresponds to specified serial number.

getDevices

List<LocatedDevice> getDevices()

Returns a set of objects that represent all available devices. If there is no devices, return an empty collection.

Returns:

a set of objects that represent all available devices.

getDevicePosition

Position getDevicePosition(String deviceId)

Returns current position of specified device.

Parameters:

deviceId - a device identifier

Returns:

current position of specified device.

setDevicePosition

void setDevicePosition(String deviceId,
                     Position position)

Sets the device position.

Parameters:

deviceId - The ID of device to be moved.

position - The new position of device.

moveDeviceIntoZone

void moveDeviceIntoZone(String deviceId,
                      String zoneId)

Moves a device to a zone. The device position is calculated randomly in the zone.

Parameters:

deviceId - The ID of device to be moved.

zoneId - The ID of the zone where the device wll be placed.

getDeviceTypes

Set<String> getDeviceTypes()

Gets the set of devices Types existing in the platform.

Returns:

the set of devices Types existing in the platform.

getProvidedServices

Set<String> getProvidedServices(String deviceType)

Get a set of the Service specification

Parameters:

deviceType - the device type to retrieve its service specifications.

Returns:

the set of specifications, null if any.

getProvidedServices

Set<String> getProvidedServices(LocatedDevice device)

Get a set of Service specifications of specified device.

Parameters:

device - the device type to retrieve its service specifications.

Returns:

the set of specifications of specified devices, null if any.

getGlobalVariables

Set<Variable> getGlobalVariables()

Returns all global variables.

Returns:

all global variables.

getGlobalVariableValue

Object getGlobalVariableValue(String variableName)

Returns the value of a given global variable.

Parameters:

variableName - The variable name to retrieve its value.

Returns:

The value of the variable.

addGlobalVariable

void addGlobalVariable(String variableName)

Adds a global variable.

Parameters:

variableName - name of a global variable

setGlobalVariable

void setGlobalVariable(String variableName,
                     Object value)

Sets specified global variable .

Parameters:

variableName -

value -

addListener

void addListener(IcasaListener listener)

Adds a listener to the platform. The platform determines the type of listener to know where to plug it.

Parameters:

listener - The new listener.

removeListener

void removeListener(IcasaListener listener)

Removes a listener from the platform.

Parameters:

listener -

resetContext

void resetContext()

Removes all zones. If the platform is under simulation, also removes simulated persons and simulated devices.