buzz.getcoco.iot

Class ResourceCondition

java.lang.Object

buzz.getcoco.iot.ResourceCondition

All Implemented Interfaces:

Rule.Condition

Direct Known Subclasses:

ResourceCondition.EditableResourceCondition

public class ResourceCondition
extends java.lang.Object
implements Rule.Condition

Resource condition is a pair of capability and one of its command. Resource condition encapsulates the information about the condition of a resource upon which Scene and Rule can be triggered.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceCondition.EditableResourceCondition This class serves as a mutable version of Resource Action.
static class	ResourceCondition.OperatorType An enum defining inequality operators applicable to decide the resource condition.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RESOURCE_CONDITION_ID Default value for id.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ResourceCondition(Capability capability, Capability.AttributeId attributeId, ResourceCondition.OperatorType operatorType, long conditionDuration, Attribute.DataType dataType, java.lang.Object thresholdAttributeValue) An overloaded constructor that uses DEFAULT_RESOURCE_CONDITION_ID as ID.
protected	ResourceCondition(int id, Capability capability, int attributeId, int operatorType, long conditionDuration, Attribute.DataType dataType, java.lang.Object thresholdAttributeValue) Base Constructor ResourceCondition.
	ResourceCondition(Resource resource, Capability.AttributeId attributeId, ResourceCondition.OperatorType operatorType, long conditionDuration, Attribute.DataType dataType, java.lang.Object thresholdAttributeValue) An overloaded constructor that takes the Resource.

Method Summary

Modifier and Type	Method and Description
ResourceCondition	duplicate() A function that creates new copy of the ResourceCondition.
Attribute	getAttribute() A function to get Attribute associated with this ResourceCondition.
Attribute.DataType	getAttributeDataType() A function to return Attribute.DataType of Attribute associated with this ResourceCondition.
Capability.AttributeId	getAttributeId() A function to get Capability.AttributeId associated with this ResourceCondition.
long	getConditionDuration() A function to get conditionDuration.
int	getId() A function to get ID of this condition.
ResourceCondition.OperatorType	getOperatorType() A function to get ResourceCondition.OperatorType associated with this ResourceCondition.
Capability	getParentCapability() A function to get Capability associated with this ResourceCondition.
java.lang.Object	getThresholdAttributeValue() A function to get thresholdAttributeValue.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESOURCE_CONDITION_ID

public static final int DEFAULT_RESOURCE_CONDITION_ID

Default value for id.

See Also:

Constant Field Values

Constructor Detail

ResourceCondition

protected ResourceCondition(int id,
                            Capability capability,
                            int attributeId,
                            int operatorType,
                            long conditionDuration,
                            Attribute.DataType dataType,
                            java.lang.Object thresholdAttributeValue)

Base Constructor ResourceCondition.

Parameters:

id - ID of the ResourceCondition.

capability - Parent Capability of the attributeId.

attributeId - Capability.AttributeId whose value is used to trigger this condition.

operatorType - ResourceCondition.OperatorType of this condition.

conditionDuration - Time for which condition has to hold true.

dataType - Attribute.DataType of the attribute.

thresholdAttributeValue - ThresholdAttribute value at which this condition should trigger.

ResourceCondition

public ResourceCondition(Resource resource,
                         Capability.AttributeId attributeId,
                         ResourceCondition.OperatorType operatorType,
                         long conditionDuration,
                         Attribute.DataType dataType,
                         java.lang.Object thresholdAttributeValue)

An overloaded constructor that takes the Resource.

Parameters:

resource - Resource which contains required Attribute.

attributeId - Capability.AttributeId whose value is used to trigger this condition.

operatorType - Mathematical operator that needs to be used to compare values of Attribute and thresholdAttributeValue.

conditionDuration - Time in milliseconds for which condition has to hold true.

dataType - Date type of the attributeId.

thresholdAttributeValue - Threshold is a value used to compare with attributeId} using specified ResourceCondition.OperatorType to trigger condition.

ResourceCondition

public ResourceCondition(Capability capability,
                         Capability.AttributeId attributeId,
                         ResourceCondition.OperatorType operatorType,
                         long conditionDuration,
                         Attribute.DataType dataType,
                         java.lang.Object thresholdAttributeValue)

An overloaded constructor that uses DEFAULT_RESOURCE_CONDITION_ID as ID.

Parameters:

capability - Parent Capability of attributeId.

attributeId - Capability.AttributeId whose value is used to in comparison with thresholdAttributeValue to trigger rule.

operatorType - Mathematical operator that needs to be used to compare values of Attribute and thresholdAttributeValue.

conditionDuration - Time for which condition has to hold true.

dataType - Date type of the attributeId.

thresholdAttributeValue - Threshold is a value used to compare with attributeId} using specified ResourceCondition.OperatorType to trigger condition.

Method Detail

getId

public int getId()

A function to get ID of this condition.

Returns:

ID

getAttributeId

public Capability.AttributeId getAttributeId()

A function to get Capability.AttributeId associated with this ResourceCondition.

Returns:

Capability.AttributeId of the ResourceCondition.

getParentCapability

public Capability getParentCapability()

A function to get Capability associated with this ResourceCondition.

Returns:

Capability of the ResourceCondition

getAttribute

public Attribute getAttribute()

A function to get Attribute associated with this ResourceCondition.

Returns:

Attribute of the ResourceCondition

getOperatorType

public ResourceCondition.OperatorType getOperatorType()

A function to get ResourceCondition.OperatorType associated with this ResourceCondition.

Returns:

ResourceCondition.OperatorType of the ResourceCondition.

getConditionDuration

public long getConditionDuration()

A function to get conditionDuration.

Returns:

conditionDuration.

getAttributeDataType

public Attribute.DataType getAttributeDataType()

A function to return Attribute.DataType of Attribute associated with this ResourceCondition.

Returns:

Attribute.DataType of the Attribute for the ResourceCondition.

getThresholdAttributeValue

public java.lang.Object getThresholdAttributeValue()

A function to get thresholdAttributeValue.

Returns:

thresholdAttributeValue.

duplicate

public ResourceCondition duplicate()

A function that creates new copy of the ResourceCondition.

Specified by:

duplicate in interface Rule.Condition

Returns:

ResourceCondition duplicate copy.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object