com.whizzosoftware.hobson.api.property

Class PropertyContainerClass

java.lang.Object

com.whizzosoftware.hobson.api.property.PropertyContainerClass

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ActionClass, HubConfigurationClass, TaskConditionClass

public class PropertyContainerClass
extends java.lang.Object
implements java.io.Serializable

A generic container that defines a set of typed properties that can be assigned values. This is used to define what the supported properties (configurable aspects) of an entity are. The actual assignment of real values to those supported properties is done via a PropertyContainer object which has both a reference to a PropertyContainerClass and a set of values for its supported properties. For example, a Hub will have multiple PropertyContainerClass instances that expose each element of it configuration (e.g. name, log level, etc.)

Author:

Dan Noguerol

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PropertyContainerClass(PropertyContainerClassContext context, PropertyContainerClassType type)
PropertyContainerClass(PropertyContainerClassContext context, PropertyContainerClassType type, java.util.List<TypedProperty> supportedProperties)

Method Summary

Modifier and Type	Method and Description
void	addSupportedProperty(TypedProperty property)
boolean	evaluatePropertyConstraints(java.util.Collection<java.lang.String> publishedVariableNames) Evaluates whether all the property constraints associated with this property container class are met (if they exist).
PropertyContainerClassContext	getContext()
java.util.Collection<TypedProperty>	getSupportedProperties()
TypedProperty	getSupportedProperty(java.lang.String id)
PropertyContainerClassType	getType()
boolean	hasSupportedProperties()
void	setContext(PropertyContainerClassContext context)
void	setSupportedProperties(java.util.List<TypedProperty> supportedProperties)
void	validate(java.util.Map<java.lang.String,java.lang.Object> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyContainerClass

public PropertyContainerClass(PropertyContainerClassContext context,
                              PropertyContainerClassType type)

PropertyContainerClass

public PropertyContainerClass(PropertyContainerClassContext context,
                              PropertyContainerClassType type,
                              java.util.List<TypedProperty> supportedProperties)

Method Detail

getContext

public PropertyContainerClassContext getContext()

setContext

public void setContext(PropertyContainerClassContext context)

getType

public PropertyContainerClassType getType()

hasSupportedProperties

public boolean hasSupportedProperties()

getSupportedProperties

public java.util.Collection<TypedProperty> getSupportedProperties()

getSupportedProperty

public TypedProperty getSupportedProperty(java.lang.String id)

setSupportedProperties

public void setSupportedProperties(java.util.List<TypedProperty> supportedProperties)

addSupportedProperty

public void addSupportedProperty(TypedProperty property)

validate

public void validate(java.util.Map<java.lang.String,java.lang.Object> values)

evaluatePropertyConstraints

public boolean evaluatePropertyConstraints(java.util.Collection<java.lang.String> publishedVariableNames)

Evaluates whether all the property constraints associated with this property container class are met (if they exist).

Parameters:

publishedVariableNames - a list of all published variable names

Returns:

a boolean