Package energy.eddie.aiida.schemas.cim

Class BaseCimFormatterStrategy<T,S,V,W>

java.lang.Object

energy.eddie.aiida.schemas.cim.BaseCimFormatterStrategy<T,S,V,W>

Type Parameters:

T - The version-specific RTDEnvelope class.

S - The version-specific TimeSeries class.

V - The version-specific StandardCodingSchemeTypeList class.

W - The version-specific QuantityTypeKind class.

All Implemented Interfaces:

CimFormatterStrategy<T>

Direct Known Subclasses:

CimStrategy, CimStrategy

public abstract class BaseCimFormatterStrategy<T,S,V,W>
extends Object
implements CimFormatterStrategy<T>

This is the base class for CIM formatter strategies. Each strategy formats an AIIDA record to a specific CIM version.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DOCUMENT_TYPE
protected static final String	REGION_CONNECTOR
protected static final ZoneId	UTC
protected static final String	VERSION

Constructor Summary

Constructors

Constructor	Description
BaseCimFormatterStrategy()

Method Summary

Modifier and Type	Method	Description
protected final W	aiidaRecordValueToQuantityTypeKind(AiidaRecordValue recordValue)
protected final AiidaLocalDataNeed	dataNeedOfPermissionOrThrow(Permission permission)
protected final DataSource	dataSourceOfPermissionOrThrow(Permission permission)
protected final boolean	isAiidaRecordValueSupported(AiidaRecordValue recordValue)
protected abstract Map<ObisCode,W>	obisToQuantityTypeKindMap()
protected final V	standardCodingSchemeFromValue(String countryCode, Function<String,V> fromValue)
abstract List<AiidaRecordValue>	timeSeriesToAiidaRecordValues(S timeSeries)
protected final BigDecimal	toBigDecimalOrThrow(AiidaRecordValue aiidaRecordValue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface energy.eddie.aiida.schemas.cim.CimFormatterStrategy

toRealTimeDataEnvelope

Field Details

DOCUMENT_TYPE

protected static final String DOCUMENT_TYPE

See Also:

• Constant Field Values

REGION_CONNECTOR

protected static final String REGION_CONNECTOR

See Also:

• Constant Field Values

UTC

protected static final ZoneId UTC

VERSION

protected static final String VERSION

See Also:

• Constant Field Values

Constructor Details

BaseCimFormatterStrategy

public BaseCimFormatterStrategy()

Method Details

timeSeriesToAiidaRecordValues

public abstract List<AiidaRecordValue> timeSeriesToAiidaRecordValues(S timeSeries)
                                                              throws CimSchemaFormatterException

Throws:

CimSchemaFormatterException

obisToQuantityTypeKindMap

protected abstract Map<ObisCode,W> obisToQuantityTypeKindMap()

toBigDecimalOrThrow

protected final BigDecimal toBigDecimalOrThrow(AiidaRecordValue aiidaRecordValue)
                                        throws CimSchemaFormatterException

Throws:

CimSchemaFormatterException

dataSourceOfPermissionOrThrow

protected final DataSource dataSourceOfPermissionOrThrow(Permission permission)
                                                  throws CimSchemaFormatterException

Throws:

CimSchemaFormatterException

dataNeedOfPermissionOrThrow

protected final AiidaLocalDataNeed dataNeedOfPermissionOrThrow(Permission permission)
                                                        throws CimSchemaFormatterException

Throws:

CimSchemaFormatterException

isAiidaRecordValueSupported

protected final boolean isAiidaRecordValueSupported(AiidaRecordValue recordValue)

aiidaRecordValueToQuantityTypeKind

@Nullable
protected final W aiidaRecordValueToQuantityTypeKind(AiidaRecordValue recordValue)
                                              throws CimSchemaFormatterException

Throws:

CimSchemaFormatterException

standardCodingSchemeFromValue

@Nullable
protected final V standardCodingSchemeFromValue(String countryCode,
 Function<String,V> fromValue)