org.universAAL.lddi.smarthome.exporter.devices

Class AbstractStatusValueCallee

java.lang.Object

org.universAAL.middleware.bus.member.BusMember

org.universAAL.middleware.bus.member.Callee

org.universAAL.middleware.service.ServiceCallee

org.universAAL.lddi.smarthome.exporter.devices.AbstractCallee

org.universAAL.lddi.smarthome.exporter.devices.AbstractStatusValueCallee

All Implemented Interfaces:

GenericDevice

Direct Known Subclasses:

ContactSensorWrapper, PresenceSensorWrapper, SwitchActuatorWrapper, SwitchControllerWrapper, SwitchSensorWrapper, WaterflowSensorWrapper, WindowSensorWrapper

public abstract class AbstractStatusValueCallee
extends AbstractCallee

Field Summary

Fields

Modifier and Type	Field and Description
static String	IN_DEVICE Argument suffix.
static String	IN_SET_VALUE Service suffix.
protected String	namespace
protected ServiceProfile[]	newProfiles
static String	OUT_GET_VALUE Argument suffix.
static String	SERVICE_GET_VALUE Service suffix.
static String	SERVICE_SET_VALUE Service suffix.

Fields inherited from class org.universAAL.middleware.bus.member.BusMember

busResourceURI, owner, theBus

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStatusValueCallee(ModuleContext context, ServiceProfile[] realizedServices, String namespace)

Method Summary

Modifier and Type	Method and Description
void	communicationChannelBroken() This abstract method is called for each member of the bus when the bus is being stopped.
abstract StatusValue	executeGet() When a GET STATUS service request is received, this method is called automatically.
abstract boolean	executeSet(StatusValue value) When a SET STATUS service request is received, this method is called automatically.
static ServiceProfile	getServiceProfileGET(String namespace, Device instance)
static ServiceProfile[]	getServiceProfiles(String namespace, Device instance) Get the typical service profiles for a controller: GET/SET the has value prop.
static ServiceProfile	getServiceProfileSET(String namespace, Device instance)
ServiceResponse	handleCall(ServiceCall call) The actual service method of the ServiceCallee.
void	unregister() This will be called when its time to close.

Methods inherited from class org.universAAL.middleware.service.ServiceCallee

addNewServiceProfiles, addNewServiceProfiles, busDyingOut, getMyID, handleRequest, removeMatchingProfiles

Methods inherited from class org.universAAL.middleware.bus.member.BusMember

close, getComment, getLabel, getType, getURI, setComment, setLabel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.universAAL.lddi.smarthome.exporter.devices.GenericDevice

publish

Field Detail

SERVICE_GET_VALUE

public static final String SERVICE_GET_VALUE

Service suffix.

See Also:

Constant Field Values

OUT_GET_VALUE

public static final String OUT_GET_VALUE

Argument suffix.

See Also:

Constant Field Values

SERVICE_SET_VALUE

public static final String SERVICE_SET_VALUE

Service suffix.

See Also:

Constant Field Values

IN_SET_VALUE

public static final String IN_SET_VALUE

Service suffix.

See Also:

Constant Field Values

IN_DEVICE

public static final String IN_DEVICE

Argument suffix.

See Also:

Constant Field Values

namespace

protected String namespace

newProfiles

protected ServiceProfile[] newProfiles

Constructor Detail

AbstractStatusValueCallee

protected AbstractStatusValueCallee(ModuleContext context,
                                    ServiceProfile[] realizedServices,
                                    String namespace)

Method Detail

unregister

public void unregister()

Description copied from interface: GenericDevice

This will be called when its time to close. Free any resources (This is intended for Callees, that should be closed).

communicationChannelBroken

public void communicationChannelBroken()

Description copied from class: ServiceCallee

This abstract method is called for each member of the bus when the bus is being stopped.

Specified by:

communicationChannelBroken in class ServiceCallee

handleCall

public ServiceResponse handleCall(ServiceCall call)

Description copied from class: ServiceCallee

The actual service method of the ServiceCallee. It is called by the bus whenever there is a call that need to be serviced by this ServiceCallee.

Specified by:

handleCall in class ServiceCallee

Parameters:

call - the call that needs to be serviced.

Returns:

the result of the call execution.

executeGet

public abstract StatusValue executeGet()

When a GET STATUS service request is received, this method is called automatically.

Returns:

The StatusValue value representing the status property of the actuator.

executeSet

public abstract boolean executeSet(StatusValue value)

When a SET STATUS service request is received, this method is called automatically.

Parameters:

value - The StatusValue representing the dimmed value

Returns:

true if succeeded

getServiceProfiles

public static ServiceProfile[] getServiceProfiles(String namespace,
                                                  Device instance)

Get the typical service profiles for a controller: GET/SET the has value prop.

Parameters:

namespace - Must be the same as the one set in the constructor

actuator - The instance of the ontological representation of the device

Returns:

getServiceProfileGET

public static ServiceProfile getServiceProfileGET(String namespace,
                                                  Device instance)

getServiceProfileSET

public static ServiceProfile getServiceProfileSET(String namespace,
                                                  Device instance)