Migration guide v3.0.0

Breaking changes

Java 21

PowSyBl-Metrix now only supports Java 21 and higher. Please check that your installed SDK is still compatible.

For example, if you are using Ubuntu 20.04 LTS and the preinstalled Maven version, you will need to upgrade your Maven version too at least up to a version 3.9.x.

Computation by range

The following methods were removed:

• ComputationRange.getFirstVariant()
• ComputationRange.setFirstVariant(int)
• ComputationRange.getVariantCount()
• ComputationRange.setVariantCount(int)

Instead, users should now use the methods

• ComputationRange.getRanges()
• ComputationRange.setRanges(List<Range<Integer>>)

Creation of powsybl-metrix-commons

A new artifact has been added:

        <dependency>
            <groupId>com.powsybl</groupId>
            <artifactId>powsybl-metrix-commons</artifactId>
        </dependency>

Class changes

The following classes have been moved:

Class	Old package	New package
MetrixIidmConfiguration	com.powsybl.metrix.mapping.common	com.powsybl.metrix.commons.config
AttributeNameToValue	com.powsybl.metrix.mapping	com.powsybl.metrix.commons.data.datatable
ContentFilter	com.powsybl.metrix.mapping	com.powsybl.metrix.commons.data.datatable
DataTable	com.powsybl.metrix.mapping	com.powsybl.metrix.commons.data.datatable
DataTableStore	com.powsybl.metrix.mapping	com.powsybl.metrix.commons.data.datatable
QueryFilter	com.powsybl.metrix.mapping	com.powsybl.metrix.commons.data.datatable
CalculatedTimeSeriesStore	com.powsybl.metrix.mapping.timeseries	com.powsybl.metrix.commons.data.timeseries
FileSystemTimeSeriesStore	com.powsybl.metrix.mapping.timeseries	com.powsybl.metrix.commons.data.timeseries
InMemoryTimeSeriesStore	com.powsybl.metrix.mapping.timeseries	com.powsybl.metrix.commons.data.timeseries
MmapByteBufferService	com.powsybl.metrix.mapping.timeseries	com.powsybl.metrix.commons.data.timeseries
TimeSeriesMetadataIndex	com.powsybl.metrix.mapping.timeseries	com.powsybl.metrix.commons.data.timeseries
TimeSeriesStoreUtil	com.powsybl.metrix.mapping.timeseries	com.powsybl.metrix.commons.data.timeseries
DataTableException	com.powsybl.metrix.mapping.exception	com.powsybl.metrix.commons.exception
DefaultTimeSeriesMapperObserver	com.powsybl.metrix.mapping	com.powsybl.metrix.commons.observer
TimeSeriesMapperObserver	com.powsybl.metrix.mapping	com.powsybl.metrix.commons.observer
ComputationRange	com.powsybl.metrix.mapping	com.powsybl.metrix.commons
MappingVariable	com.powsybl.metrix.mapping	com.powsybl.metrix.commons
MappingVariableProvider	com.powsybl.metrix.mapping	com.powsybl.metrix.commons
MetrixAnalysis	com.powsybl.metrix.integration.metrix	com.powsybl.metrix.integration.analysis
MetrixAnalysisResult	com.powsybl.metrix.integration.metrix	com.powsybl.metrix.integration.analysis
MetrixInputAnalysis	com.powsybl.metrix.integration.metrix	com.powsybl.metrix.integration.analysis
MetrixInputAnalysisResult	com.powsybl.metrix.integration.metrix	com.powsybl.metrix.integration.analysis
MetrixGeneratorsBinding	com.powsybl.metrix.integration	com.powsybl.metrix.integration.binding
MetrixLoadsBinding	com.powsybl.metrix.integration	com.powsybl.metrix.integration.binding
ChunkCutter	com.powsybl.metrix.integration	com.powsybl.metrix.integration.chunk
MetrixChunk	com.powsybl.metrix.integration	com.powsybl.metrix.integration.chunk
MetrixChunkLogger	com.powsybl.metrix.integration	com.powsybl.metrix.integration.chunk
MetrixChunkParam	com.powsybl.metrix.integration	com.powsybl.metrix.integration.chunk
MetrixConfig	com.powsybl.metrix.integration	com.powsybl.metrix.integration.configuration
MetrixParameters	com.powsybl.metrix.integration	com.powsybl.metrix.integration.configuration
MetrixRunParameters	com.powsybl.metrix.integration	com.powsybl.metrix.integration.configuration
DefaultNetworkSourceImpl	com.powsybl.metrix.integration	com.powsybl.metrix.integration.network
MetrixNetwork	com.powsybl.metrix.integration	com.powsybl.metrix.integration.network
MetrixVariantProvider	com.powsybl.metrix.integration	com.powsybl.metrix.integration.network
MetrixVariantReader	com.powsybl.metrix.integration	com.powsybl.metrix.integration.network
MetrixVariantReaderImpl	com.powsybl.metrix.integration	com.powsybl.metrix.integration.network
MetrixVariantsWriter	com.powsybl.metrix.integration	com.powsybl.metrix.integration.network
NetworkSource	com.powsybl.metrix.integration	com.powsybl.metrix.integration.network
BranchPostProcessingPrefixContainer	com.powsybl.metrix.integration	com.powsybl.metrix.integration.postprocessing
GeneratorPostProcessingPrefixContainer	com.powsybl.metrix.integration	com.powsybl.metrix.integration.postprocessing
MetrixBranchPostProcessingTimeSeries	com.powsybl.metrix.integration	com.powsybl.metrix.integration.postprocessing
MetrixGeneratorPostProcessingTimeSeries	com.powsybl.metrix.integration	com.powsybl.metrix.integration.postprocessing
MetrixLoadPostProcessingTimeSeries	com.powsybl.metrix.integration	com.powsybl.metrix.integration.postprocessing
MetrixLossesPostProcessingTimeSeries	com.powsybl.metrix.integration	com.powsybl.metrix.integration.postprocessing
MetrixPostProcessingTimeSeries	com.powsybl.metrix.integration	com.powsybl.metrix.integration.postprocessing
MetrixComputationType	com.powsybl.metrix.integration	com.powsybl.metrix.integration.type
MetrixHvdcControlType	com.powsybl.metrix.integration	com.powsybl.metrix.integration.type
MetrixHvdcRegulationType	com.powsybl.metrix.integration	com.powsybl.metrix.integration.type
MetrixPtcControlType	com.powsybl.metrix.integration	com.powsybl.metrix.integration.type
BalanceContext	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.balance
BalanceSummary	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.balance
DefaultGenericMetadata	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.config
TimeSeriesMappingConfig	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.config
TimeSeriesMappingConfigChecker	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.config
TimeSeriesMappingConfigLoader	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.config
TimeSeriesMappingConfigStats	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.config
TimeSeriesMappingConfigTableLoader	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.config
TimeSeriesMappingException	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.exception
TimeSeriesMappingConfigJson	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.json
GeneratorBoundLimitBuilder	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.limits
HvdcBoundLimitBuilder	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.limits
DefaultEquipmentTimeSeriesMapperObserver	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.observer
EquipmentGroupTimeSeriesMapperObserver	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.observer
EquipmentGroupTimeSeriesWriterObserver	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.observer
EquipmentTimeSeriesMapperObserver	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.observer
EquipmentTimeSeriesWriterObserver	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.observer
MultipleTimeSeriesMapperObserver	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.observer
DistributionKey	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.references
IndexedMappingKey	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.references
IndexedName	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.references
MappingKey	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.references
NumberDistributionKey	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.references
TimeSeriesDistributionKey	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.references
TimeSeriesMetadataIndex	com.powsybl.metrix.mapping.exception	com.powsybl.metrix.mapping.timeseries
TimeSeriesConstants	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.utils
TimeSeriesUtils	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.utils
EquipmentTimeSeriesWriter	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.writers
TimeSeriesMappingConfigCsvWriter	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.writers
TimeSeriesMappingConfigEquipmentCsvWriter	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.writers
TimeSeriesMappingConfigStatusCsvWriter	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.writers
TimeSeriesMappingConfigSynthesisCsvWriter	com.powsybl.metrix.mapping	com.powsybl.metrix.mapping.writers

Method removal

The following deprecated methods were removed:

• importTimeSeries(List<TimeSeries> timeSeriesList, int version, boolean overwriteExisting, boolean append)
• importTimeSeries(BufferedReader reader, boolean overwriteExisting, boolean append)

Deprecations

Exceptions

The exception classes TimeSeriesMetadataNotFoundException and TimeSeriesStoreNotFoundException are now deprecated, they should be defined in the user applications.