Package edu.ie3.datamodel.io.processor.result

Class ResultEntityProcessor

java.lang.Object

edu.ie3.datamodel.io.processor.Processor<T>

edu.ie3.datamodel.io.processor.EntityProcessor<ResultEntity>

edu.ie3.datamodel.io.processor.result.ResultEntityProcessor

public class ResultEntityProcessor
extends EntityProcessor<ResultEntity>

'Serializer' for ResultEntitys into a fieldName to value representation to allow for an easy processing into a database or file sink e.g. .csv It is important that the units used in this class are equal to the units used SystemParticipantResultFactory to prevent invalid interpretation of unit prefixes!

Since:

31.01.20

Field Summary

Fields

Modifier and Type	Field	Description
static final List<Class<? extends ResultEntity>>	eligibleEntityClasses	The entities that can be used within this processor

Fields inherited from class edu.ie3.datamodel.io.processor.EntityProcessor

headerElements, log

Fields inherited from class edu.ie3.datamodel.io.processor.Processor

logger, registeredClass

Constructor Summary

Constructors

Constructor	Description
ResultEntityProcessor(Class<? extends ResultEntity> registeredClass)

Method Summary

Modifier and Type	Method	Description
protected List<Class<? extends ResultEntity>>	getEligibleEntityClasses()	Returns a (unmodifiable) List of classes that this Processors is capable of processing
protected Optional<String>	handleProcessorSpecificQuantity(javax.measure.Quantity<?> quantity, String fieldName)	This method should handle all quantities that are model processor specific e.g.

Methods inherited from class edu.ie3.datamodel.io.processor.EntityProcessor

getHeaderElements, handleEntity

Methods inherited from class edu.ie3.datamodel.io.processor.Processor

getRegisteredClass, handleQuantity, mapFieldNameToGetter, mapFieldNameToGetter, processMethodResult, processObject, processOperationTime, processUUIDArray, processVoltageLevel, processZonedDateTime, putUuidFirst, quantityValToOptionalString

Methods inherited from class java.lang.Object

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

Field Details

eligibleEntityClasses

public static final List<Class<? extends ResultEntity>> eligibleEntityClasses

The entities that can be used within this processor

Constructor Details

ResultEntityProcessor

public ResultEntityProcessor(Class<? extends ResultEntity> registeredClass)

Method Details

handleProcessorSpecificQuantity

protected Optional<String> handleProcessorSpecificQuantity(javax.measure.Quantity<?> quantity,
 String fieldName)

Description copied from class: Processor

This method should handle all quantities that are model processor specific e.g. we need to handle active power p different for ResultEntitys and SystemParticipantInputs Hence from the generalized method Processor.handleQuantity(Quantity, String), this allows for the specific handling of child implementations. See the implementation @ ResultEntityProcessor for details.

Overrides:

handleProcessorSpecificQuantity in class EntityProcessor<ResultEntity>

Parameters:

quantity - the quantity that should be processed

fieldName - the field name the quantity is set to

Returns:

an optional string with the normalized to StandardUnits value of the quantity or empty if an error occurred during processing

getEligibleEntityClasses

protected List<Class<? extends ResultEntity>> getEligibleEntityClasses()

Description copied from class: Processor

Returns a (unmodifiable) List of classes that this Processors is capable of processing

Specified by:

getEligibleEntityClasses in class Processor<ResultEntity>

Returns:

The unmodifiable List of eligible classes