Package energy.eddie.regionconnector.es.datadis

Class DatadisRegionConnectorMetadata

java.lang.Object

energy.eddie.regionconnector.es.datadis.DatadisRegionConnectorMetadata

All Implemented Interfaces:

RegionConnectorMetadata

public class DatadisRegionConnectorMetadata
extends Object
implements RegionConnectorMetadata

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAXIMUM_MONTHS_IN_THE_FUTURE	Datadis can grant permissions for a maximum of 24 months in the future.
static final int	MAXIMUM_MONTHS_IN_THE_PAST	Datadis gives access to metering data for a maximum of 24 months in the past.
static final Period	PERIOD_EARLIEST_START
static final Period	PERIOD_LATEST_END	The maximum time in the future that a permission request can be created for.
static final String	REGION_CONNECTOR_ID
static final List<Class<? extends DataNeed>>	SUPPORTED_DATA_NEEDS
static final List<Granularity>	SUPPORTED_GRANULARITIES
static final ZoneId	ZONE_ID_SPAIN

Method Summary

Modifier and Type	Method	Description
String	countryCode()	Country code of the region covered by a RegionConnector.
long	coveredMeteringPoints()	Number of metering points that are accessible through a RegionConnector.
Period	earliestStart()	The earliest possible start for a region-connector.
static DatadisRegionConnectorMetadata	getInstance()
String	id()	A unique identifier of a RegionConnector.
Period	latestEnd()	The latest possible end for a region-connector.
List<Class<? extends DataNeedInterface>>	supportedDataNeeds()	List of supported Data Needs
List<EnergyType>	supportedEnergyTypes()	The energy types for which the region connector can request validated historical data.
List<Granularity>	supportedGranularities()	List of supported granularities.
ZoneId	timeZone()

Methods inherited from class java.lang.Object

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

Methods inherited from interface energy.eddie.api.v0.RegionConnectorMetadata

countryCodes, granularitiesFor

Field Details

REGION_CONNECTOR_ID

public static final String REGION_CONNECTOR_ID

See Also:

• Constant Field Values

ZONE_ID_SPAIN

public static final ZoneId ZONE_ID_SPAIN

MAXIMUM_MONTHS_IN_THE_PAST

public static final int MAXIMUM_MONTHS_IN_THE_PAST

Datadis gives access to metering data for a maximum of 24 months in the past.

See Also:

• Constant Field Values

MAXIMUM_MONTHS_IN_THE_FUTURE

public static final int MAXIMUM_MONTHS_IN_THE_FUTURE

Datadis can grant permissions for a maximum of 24 months in the future. If no end date is provided, the end date will be set to the current date plus 24 months.

See Also:

• Constant Field Values

PERIOD_LATEST_END

public static final Period PERIOD_LATEST_END

The maximum time in the future that a permission request can be created for. 24 months minus one day. Datadis API is exclusive on the end date, so we need to subtract one day here.

PERIOD_EARLIEST_START

public static final Period PERIOD_EARLIEST_START

SUPPORTED_GRANULARITIES

public static final List<Granularity> SUPPORTED_GRANULARITIES

SUPPORTED_DATA_NEEDS

public static final List<Class<? extends DataNeed>> SUPPORTED_DATA_NEEDS

Method Details

getInstance

public static DatadisRegionConnectorMetadata getInstance()

id

public String id()

Description copied from interface: RegionConnectorMetadata

A unique identifier of a RegionConnector.

Specified by:

id in interface RegionConnectorMetadata

countryCode

public String countryCode()

Description copied from interface: RegionConnectorMetadata

Country code of the region covered by a RegionConnector. Must be uppercase.

Specified by:

countryCode in interface RegionConnectorMetadata

coveredMeteringPoints

public long coveredMeteringPoints()

Description copied from interface: RegionConnectorMetadata

Number of metering points that are accessible through a RegionConnector.

Specified by:

coveredMeteringPoints in interface RegionConnectorMetadata

earliestStart

public Period earliestStart()

Description copied from interface: RegionConnectorMetadata

The earliest possible start for a region-connector.

Specified by:

earliestStart in interface RegionConnectorMetadata

latestEnd

public Period latestEnd()

Description copied from interface: RegionConnectorMetadata

The latest possible end for a region-connector.

Specified by:

latestEnd in interface RegionConnectorMetadata

supportedGranularities

public List<Granularity> supportedGranularities()

Description copied from interface: RegionConnectorMetadata

List of supported granularities.

Specified by:

supportedGranularities in interface RegionConnectorMetadata

timeZone

public ZoneId timeZone()

Specified by:

timeZone in interface RegionConnectorMetadata

supportedEnergyTypes

public List<EnergyType> supportedEnergyTypes()

Description copied from interface: RegionConnectorMetadata

The energy types for which the region connector can request validated historical data.

Specified by:

supportedEnergyTypes in interface RegionConnectorMetadata

Returns:

the supported energy types

supportedDataNeeds

public List<Class<? extends DataNeedInterface>> supportedDataNeeds()

Description copied from interface: RegionConnectorMetadata

List of supported Data Needs

Specified by:

supportedDataNeeds in interface RegionConnectorMetadata