net.solarnetwork.node.control.datumreactor

Class ControlPropertyConfig

java.lang.Object

net.solarnetwork.domain.datum.DatumSamplePropertyConfig<java.lang.String>

net.solarnetwork.node.service.support.ExpressionConfig

net.solarnetwork.node.control.datumreactor.ControlPropertyConfig

public class ControlPropertyConfig
extends net.solarnetwork.node.service.support.ExpressionConfig

Configuration for a single datum property associate with a managed control.

The DatumSamplePropertyConfig.getConfig() value represents the expression.

Version:

1.0

Author:

matt

Constructor Summary

Constructors

Constructor and Description
ControlPropertyConfig() Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getControlId() Get the control ID.
java.math.BigDecimal	getMaxValue() Get a maximum value to limit the output to.
java.math.BigDecimal	getMinValue() Get a minimum value to limit the output to.
boolean	isValid() Test if this instance has a valid configuration.
static ControlPropertyConfig	of(java.lang.String controlId) Create a new configuration instance.
void	setControlId(java.lang.String controlId) Set the control ID.
void	setMaxValue(java.math.BigDecimal maxValue) Set a maximum value to limit the output to.
void	setMinValue(java.math.BigDecimal minValue) Set a minimum value to limit the output to.
static java.util.List<net.solarnetwork.settings.SettingSpecifier>	settings(java.lang.String prefix, java.lang.Iterable<net.solarnetwork.service.ExpressionService> expressionServices) Get settings suitable for configuring an instance of this class.

Methods inherited from class net.solarnetwork.node.service.support.ExpressionConfig

expressionReferenceLink, getDatumPropertyType, getDatumPropertyTypeKey, getExpression, getExpression, getExpressionServiceId, getName, setDatumPropertyType, setDatumPropertyTypeKey, setExpression, setExpressionServiceId, setName, settings, toSettingValues

Methods inherited from class net.solarnetwork.domain.datum.DatumSamplePropertyConfig

getConfig, getPropertyKey, getPropertyType, getPropertyTypeKey, setConfig, setPropertyKey, setPropertyType, setPropertyTypeKey, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlPropertyConfig

public ControlPropertyConfig()

Constructor.

Method Detail

settings

public static java.util.List<net.solarnetwork.settings.SettingSpecifier> settings(java.lang.String prefix,
                                                                                  java.lang.Iterable<net.solarnetwork.service.ExpressionService> expressionServices)

Get settings suitable for configuring an instance of this class.

Parameters:

prefix - a setting key prefix to use

expressionServices - the available expression services

Returns:

the settings, never null

of

public static ControlPropertyConfig of(java.lang.String controlId)

Create a new configuration instance.

Parameters:

controlId - the control ID

Returns:

the configuration, never null

isValid

public boolean isValid()

Test if this instance has a valid configuration.

This method simply verifies the minimum level of configuration is available for the control to be used.

Returns:

true if this configuration is valid for use

getControlId

public java.lang.String getControlId()

Get the control ID.

Returns:

the control ID

setControlId

public void setControlId(java.lang.String controlId)

Set the control ID.

Parameters:

controlId - the control ID to set

getMinValue

public java.math.BigDecimal getMinValue()

Get a minimum value to limit the output to.

Returns:

the minimum value

setMinValue

public void setMinValue(java.math.BigDecimal minValue)

Set a minimum value to limit the output to.

Parameters:

minValue - the minimum value to set, or null for no limit

getMaxValue

public java.math.BigDecimal getMaxValue()

Get a maximum value to limit the output to.

Returns:

the maximum value

setMaxValue

public void setMaxValue(java.math.BigDecimal maxValue)

Set a maximum value to limit the output to.

Parameters:

maxValue - the maximum value to set, or null for no limit