Package org.openmuc.jeebus.spine.utils.features.measurement

Class MeasurementSeriesListDataFunction

java.lang.Object

org.openmuc.jeebus.spine.spi.function.FeatureFunction

org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS,ListFeatureFunctionTypeInfo<DATA,DATA_LIST,SELECTOR,ELEMENTS>>

org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeatureFunction<org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataSelectorsType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataElementsType>

org.openmuc.jeebus.spine.utils.features.measurement.MeasurementSeriesListDataFunction

All Implemented Interfaces:

java.lang.AutoCloseable, Shutdownable

public class MeasurementSeriesListDataFunction
extends MeasurementFeatureFunction<org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataSelectorsType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataElementsType>

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	logger
static ListFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataSelectorsType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataElementsType>	TYPE_INFO

Fields inherited from class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction

allowedReadListCmdOptions, dataListHolder, listFeatureFunctionNotifier

Method Summary

Modifier and Type	Method	Description
SpineAcknowledgment	call(org.openmuc.jeebus.spine.xsd.v1.CmdType cmd, org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType sourceAddress)
boolean	checkAndSetDataOutOfRange(org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType data)	Checks if data is out of range and sets value state to out of range is so.
TYPE	getTypeInfo()
DataValidation<DATA>	getUseCaseDataValidation()
void	setUseCaseDataValidation(DataValidation<DATA> useCaseDataValidation)
protected void	validateData(org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType data)	Validates the given data.
protected void	validateReadCmd(java.util.List<org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataSelectorsType> measurementSeriesListDataSelectorsTypes, org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataElementsType elements, ReadListCmdOption readListCmdOption)	Validates the read command.
protected void	validateRecommendedBehaviour(org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType data)

Methods inherited from class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeatureFunction

isStrictMode, setStrictMode

Methods inherited from class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction

addData, addData, close, getAllowedReadCmdOptions, getDataCopies, getDataCopiesFor, getDataCopy, getDataCopyForFirst, read, removeData, removeData, setAllowedReadCmdOptions, setFeature, setUseCaseReadValidation, updateData, updateData, write

Methods inherited from class org.openmuc.jeebus.spine.spi.function.FeatureFunction

bindingRequired, getFunctionName, getFunctionProperty, isCallable, isReadable, isWritable, matchAddress, requireBinding, setCallable, setReadable, setWritable

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_INFO

public static final ListFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataSelectorsType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataElementsType> TYPE_INFO

logger

protected static final org.slf4j.Logger logger

Method Detail

validateReadCmd

protected void validateReadCmd(java.util.List<org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataSelectorsType> measurementSeriesListDataSelectorsTypes,
                               org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataElementsType elements,
                               ReadListCmdOption readListCmdOption)
                        throws SpineException

Description copied from class: ReadListFeatureFunction

Validates the read command. Must be implemented by the specific Feature Function. Throws SpineException if the validation fails.

Specified by:

validateReadCmd in class ReadListFeatureFunction<org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataSelectorsType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataElementsType,ListFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesListDataSelectorsType,org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataElementsType>>

Parameters:

measurementSeriesListDataSelectorsTypes - the list of given selectors, may be empty

elements - the elementsType object, may be null

readListCmdOption - the CmdOption that was used by the request

Throws:

SpineException - if the validation fails

validateData

protected void validateData(org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType data)
                     throws DataValidationException

Validates the given data. Must be implemented by the specific Feature Function.

Parameters:

data - the data to validate

Throws:

DataValidationException - if the validation fails

checkAndSetDataOutOfRange

public boolean checkAndSetDataOutOfRange(org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType data)

Checks if data is out of range and sets value state to out of range is so.

Parameters:

data - the data to check

Returns:

if the data is out of range

validateRecommendedBehaviour

protected void validateRecommendedBehaviour(org.openmuc.jeebus.spine.xsd.v1.MeasurementSeriesDataType data)
                                     throws DataValidationException

Throws:

DataValidationException

call

public SpineAcknowledgment call(org.openmuc.jeebus.spine.xsd.v1.CmdType cmd,
                                org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType sourceAddress)

Specified by:

call in class FeatureFunction

Parameters:

cmd - the command data belonging to this function call

sourceAddress - the feature address of the client feature

Returns:

an acknowledgment stating the result of the operation

getUseCaseDataValidation

public DataValidation<DATA> getUseCaseDataValidation()

setUseCaseDataValidation

public void setUseCaseDataValidation(DataValidation<DATA> useCaseDataValidation)

getTypeInfo

public TYPE getTypeInfo()