Package com.powsybl.iidm.serde.extensions

Class AbstractVersionableNetworkExtensionSerDe<T extends Extendable,E extends Extension<T>>

java.lang.Object

com.powsybl.iidm.serde.extensions.AbstractVersionableNetworkExtensionSerDe<T,E>

All Implemented Interfaces:

ExtensionProvider<T,E>, ExtensionSerDe<T,E>, Versionable

Direct Known Subclasses:

ActivePowerControlSerDe, ConnectablePositionSerDe, GeneratorStartupSerDe, SlackTerminalSerDe, VoltageRegulationSerDe

public abstract class AbstractVersionableNetworkExtensionSerDe<T extends Extendable,E extends Extension<T>>
extends Object
implements ExtensionSerDe<T,E>

Author:

Miora Ralambotiana <miora.ralambotiana at rte-france.com>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractVersionableNetworkExtensionSerDe(String extensionName, Class<? super E> extensionClass, String namespacePrefix, Map<IidmVersion,com.google.common.collect.ImmutableSortedSet<String>> extensionVersions, Map<String,String> namespaceUris)

Method Summary

Modifier and Type	Method	Description
void	checkExtensionVersionSupported(String extensionVersion)	Check that a given extension version exists.
protected void	checkReadingCompatibility(NetworkDeserializerContext networkContext)
boolean	checkWritingCompatibility(String extensionVersion, IidmVersion version)
String	getCategoryName()	Return the category of the extensions provided by this provider.
Class<? super E>	getExtensionClass()	Return the type of extensions provided by this provider.
String	getExtensionName()	Return the name of the extensions provided by this provider.
String	getNamespacePrefix()
String	getNamespaceUri()	Return the namespace URI of the extension in the latest version of its XML serialization.
String	getNamespaceUri(String extensionVersion)	Return the namespace URI of the extension in a given version of its XML serialization.
String	getVersion()	Return the latest version of the serialization of the extension.
String	getVersion(IidmVersion networkVersion)	Get the oldest version of an extension working with a network version.
String	getVersion(String namespaceUri)	Return the version corresponding to the given namespace URI
Set<String>	getVersions()	Return all supported versions for serializing this extension.
boolean	versionExists(IidmVersion networkVersion)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.commons.extensions.ExtensionSerDe

getArrayNameToSingleNameMap, getName, getXsdAsStream, getXsdAsStreamList, isSerializable, read, write

Constructor Details

AbstractVersionableNetworkExtensionSerDe

protected AbstractVersionableNetworkExtensionSerDe(String extensionName,
 Class<? super E> extensionClass,
 String namespacePrefix,
 Map<IidmVersion,com.google.common.collect.ImmutableSortedSet<String>> extensionVersions,
 Map<String,String> namespaceUris)

Method Details

getExtensionName

public String getExtensionName()

Description copied from interface: ExtensionProvider

Return the name of the extensions provided by this provider.

Specified by:

getExtensionName in interface ExtensionProvider<T extends Extendable,E extends Extension<T>>

Returns:

the name of the extensions provided by this provider.

getCategoryName

public String getCategoryName()

Description copied from interface: ExtensionProvider

Return the category of the extensions provided by this provider.

Specified by:

getCategoryName in interface ExtensionProvider<T extends Extendable,E extends Extension<T>>

Returns:

the category of the extensions provided by this provider.

getExtensionClass

public Class<? super E> getExtensionClass()

Description copied from interface: ExtensionProvider

Return the type of extensions provided by this provider.

Specified by:

getExtensionClass in interface ExtensionProvider<T extends Extendable,E extends Extension<T>>

Returns:

the type of extensions provided by this provider.

getNamespaceUri

public String getNamespaceUri()

Description copied from interface: ExtensionSerDe

Return the namespace URI of the extension in the latest version of its XML serialization.

Specified by:

getNamespaceUri in interface ExtensionSerDe<T extends Extendable,E extends Extension<T>>

getNamespaceUri

public String getNamespaceUri(String extensionVersion)

Description copied from interface: ExtensionSerDe

Return the namespace URI of the extension in a given version of its XML serialization.

Specified by:

getNamespaceUri in interface ExtensionSerDe<T extends Extendable,E extends Extension<T>>

getVersion

public String getVersion()

Description copied from interface: ExtensionSerDe

Return the latest version of the serialization of the extension.

Specified by:

getVersion in interface ExtensionSerDe<T extends Extendable,E extends Extension<T>>

Specified by:

getVersion in interface Versionable

versionExists

public boolean versionExists(IidmVersion networkVersion)

getVersion

public String getVersion(IidmVersion networkVersion)

Get the oldest version of an extension working with a network version.

getVersion

public String getVersion(String namespaceUri)

Description copied from interface: ExtensionSerDe

Return the version corresponding to the given namespace URI

Specified by:

getVersion in interface ExtensionSerDe<T extends Extendable,E extends Extension<T>>

getVersions

public Set<String> getVersions()

Description copied from interface: ExtensionSerDe

Return all supported versions for serializing this extension.

Specified by:

getVersions in interface ExtensionSerDe<T extends Extendable,E extends Extension<T>>

checkReadingCompatibility

protected void checkReadingCompatibility(NetworkDeserializerContext networkContext)

checkWritingCompatibility

public boolean checkWritingCompatibility(String extensionVersion,
 IidmVersion version)

getNamespacePrefix

public String getNamespacePrefix()

Specified by:

getNamespacePrefix in interface ExtensionSerDe<T extends Extendable,E extends Extension<T>>

checkExtensionVersionSupported

public void checkExtensionVersionSupported(String extensionVersion)

Description copied from interface: ExtensionSerDe

Check that a given extension version exists.

Specified by:

checkExtensionVersionSupported in interface ExtensionSerDe<T extends Extendable,E extends Extension<T>>