org.universAAL.lddi.abstraction

Interface ComponentIntegrator

public interface ComponentIntegrator

As a "specialist" for certain component types, it cooperates with all communication gateways that have access to external components of those types in order to integrate such external components in the universAAL network by (1) publishing related events to the universAAL context bus and / or (2) registering related service profiles to the universAAL service bus. For a better understanding, please refer to both the package documentation and the documentation of the methods further below.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_CORRESPONDING_COMPONENT A constant string that can be used by component integrators to map the ontological representation of an external component to its corresponding original ExternalComponent.

Method Summary

Modifier and Type	Method and Description
void	processComponents(ExternalComponent[] components) Used by communication gateways to share with this integrator the external components reachable through that gateway after this integrator subscribes to them for external components of certain types.
void	processEvent(ExternalDatapoint datapoint, Object value) Used by communication gateways to notify the integrator about the change of the value of a datapoint that is within the scope of a previous subscription of this integrator to the notifying gateway, no matter if the subscription was done by calling CommunicationGateway.startEventing(ComponentIntegrator, ExternalDatapoint, byte) or any of the wildcarding versions of it.

Field Detail

PROP_CORRESPONDING_COMPONENT

static final String PROP_CORRESPONDING_COMPONENT

A constant string that can be used by component integrators to map the ontological representation of an external component to its corresponding original ExternalComponent.

See Also:

Constant Field Values

Method Detail

processComponents

void processComponents(ExternalComponent[] components)

Used by communication gateways to share with this integrator the external components reachable through that gateway after this integrator subscribes to them for external components of certain types. Therefore, the array of components provided here as parameter is expected to contain only external components already subscribed for. Additionally, the components in the array must already contain the mapping of ontological properties to external datapoints so that this integrator can make use of them when utilizing some of the other methods of the gateway.

processEvent

void processEvent(ExternalDatapoint datapoint,
                  Object value)

Used by communication gateways to notify the integrator about the change of the value of a datapoint that is within the scope of a previous subscription of this integrator to the notifying gateway, no matter if the subscription was done by calling CommunicationGateway.startEventing(ComponentIntegrator, ExternalDatapoint, byte) or any of the wildcarding versions of it.

Parameters:

datapoint - the datapoint whose value has changed; the integrator can use ExternalDatapoint.getComponent() and ExternalDatapoint.getProperty() for getting the ontological info needed for further processing the event (mostly for publishing a context event onto the context bus).

value - The new value of the given datapoint.