Package fi.tut.mei.capabilityQueryLib.model

Class DeviceWithCapabilities

java.lang.Object

fi.tut.mei.capabilityQueryLib.model.Device

fi.tut.mei.capabilityQueryLib.model.DeviceWithCapabilities

Direct Known Subclasses:

Blueprint, DeviceCombination

public abstract class DeviceWithCapabilities
extends Device

Abstract class that represents a device that directly knows its capabilities i.e. device combination and blueprint. Compared to these an individual device gets its capabilities from its blueprint.

Author:

hylli

Nested Class Summary

Nested classes/interfaces inherited from class fi.tut.mei.capabilityQueryLib.model.Device

Device.Type

Constructor Summary

Constructors

Constructor	Description
DeviceWithCapabilities(String name, Device.Type type)	Create with a given name.

Method Summary

Modifier and Type	Method	Description
void	addCapability(Capability capability)	add a device capability If the capability has already been added does nothing.
void	addParameterObject(String property, ParameterObjectValue value, Capability capability)	Add a ParameterObjectValue for the device.
void	addParameterValue(Parameter param, Object value, Capability capability)	Set a value for a parameter.
void	addResourceCapability(ResourceCapability capability)	Add a resource capability to this device.
Set<Capability>	getCapabilities()	get the capabilities this device has
Collection<String>	getCapabilityParameterObjectProperties(Capability capability)	Get property names that connect the given capability to its ParameterObjectValues.
Set<ParameterObjectValue>	getParameterObjectValue(Capability capability, String property)	Get ParameterObjectValues related to a capability via the given property.
Collection<ParameterValue>	getParameters()	Get parameters and their values for this device.
Set<ParameterValue>	getParameterValuesForCapability(Capability capability)	Get parameter values related to given capability for this device.
Collection<ResourceCapability>	getResourceCapabilities()	Get the resource capabilities of the device.
ResourceCapability	getResourceCapability(Capability capability)	Get a ResourceCapability of this device for the given capability.

Methods inherited from class fi.tut.mei.capabilityQueryLib.model.Device

getBasicInformation, getBlueprint, getDescription, getDescriptionAsPlainText, getDevices, getName, getRdID, getRdURL, getType, setDescription, setRdID, setRdURL, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceWithCapabilities

public DeviceWithCapabilities(String name,
                              Device.Type type)

Create with a given name.

Parameters:

name - name of the device

type - type of the device

Method Detail

getCapabilities

public Set<Capability> getCapabilities()

get the capabilities this device has

Specified by:

getCapabilities in class Device

Returns:

the capabilities

addCapability

public void addCapability(Capability capability)

add a device capability If the capability has already been added does nothing.

Specified by:

addCapability in class Device

Parameters:

capability - capability to be added

addResourceCapability

public void addResourceCapability(ResourceCapability capability)

Description copied from class: Device

Add a resource capability to this device. This is an alternative for Device.addCapability(Capability)

Specified by:

addResourceCapability in class Device

Parameters:

capability - the resource capability

getResourceCapabilities

public Collection<ResourceCapability> getResourceCapabilities()

Description copied from class: Device

Get the resource capabilities of the device. A resource capability contains parameter values for a device capability. The Device class also contains methods for working with the parameters. So you can work with capability parameters through them or directly with the resource capability.

Specified by:

getResourceCapabilities in class Device

Returns:

all resource capabilities of the device

getResourceCapability

public ResourceCapability getResourceCapability(Capability capability)

Description copied from class: Device

Get a ResourceCapability of this device for the given capability.

Specified by:

getResourceCapability in class Device

Parameters:

capability - a capability

Returns:

ResourceCapability for the capability. Null if this device doesn't have the given capability.

addParameterObject

public void addParameterObject(String property,
                               ParameterObjectValue value,
                               Capability capability)

Description copied from class: Device

Add a ParameterObjectValue for the device.

Specified by:

addParameterObject in class Device

Parameters:

property - The property name that connects a device capability and the value

value - The parameter object value

capability - capability the value is related to

getCapabilityParameterObjectProperties

public Collection<String> getCapabilityParameterObjectProperties(Capability capability)

Description copied from class: Device

Get property names that connect the given capability to its ParameterObjectValues. Note this is not necessariliy the same as capability.getParameterObjectProperties since the device might not have ParameterObjectValues for all of the properties.

Specified by:

getCapabilityParameterObjectProperties in class Device

Parameters:

capability - a capability

Returns:

property names that the device has ParameterObjectValues for

getParameterObjectValue

public Set<ParameterObjectValue> getParameterObjectValue(Capability capability,
                                                         String property)

Description copied from class: Device

Get ParameterObjectValues related to a capability via the given property. For example the capability could be Moving and property "hasLinearMovementRanges"

Specified by:

getParameterObjectValue in class Device

Parameters:

capability - a capability

property - a property name

Returns:

ParameterObjectValues

addParameterValue

public void addParameterValue(Parameter param,
                              Object value,
                              Capability capability)

Description copied from class: Device

Set a value for a parameter.

Specified by:

addParameterValue in class Device

Parameters:

param - the parameter whose value is set

value - the parameter value

capability - the capability to which this parameter value is related to

getParameters

public Collection<ParameterValue> getParameters()

Get parameters and their values for this device.

Specified by:

getParameters in class Device

Returns:

The parameter values.

getParameterValuesForCapability

public Set<ParameterValue> getParameterValuesForCapability(Capability capability)

Get parameter values related to given capability for this device.

Specified by:

getParameterValuesForCapability in class Device

Parameters:

capability - Capability whose parameter values will be returned.

Returns:

Set of parameter values. Null if there are no parameters for the capability.