Package com.powsybl.commons.extensions

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

java.lang.Object

com.powsybl.commons.extensions.AbstractExtensionSerDe<T,E>

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseVoltageMappingSerDe, BranchObservabilitySerDe, BranchStatusSerDe, BusbarSectionPositionSerDe, CgmesControlAreasSerDe, CgmesDanglingLineBoundaryNodeSerDe, CgmesLineBoundaryNodeSerDe, CgmesMetadataModelsSerDe, CgmesTapChangersSerDe, CimCharacteristicsSerDe, CoordinatedReactiveControlSerDe, DiscreteMeasurementsSerDe, EntsoeAreaSerDe, GeneratorEntsoeCategorySerDe, GeneratorFortescueSerDe, GeneratorShortCircuitSerDe, HvdcAngleDroopActivePowerControlSerDe, HvdcOperatorActivePowerRangeSerDe, IdentifiableShortCircuitSerDe, InjectionObservabilitySerDe, LineFortescueSerDe, LinePositionSerDe, LoadAsymmetricalSerDe, LoadDetailSerDe, MeasurementsSerDe, OperatingStatusSerDe, ReferencePrioritiesSerDe, ReferenceTerminalsSerDe, RemoteReactivePowerControlSerDe, SecondaryVoltageControlSerDe, StandbyAutomatonSerDe, SubstationPositionSerDe, ThreeWindingsTransformerFortescueSerDe, ThreeWindingsTransformerPhaseAngleClockSerDe, ThreeWindingsTransformerToBeEstimatedSerDe, TwoWindingsTransformerFortescueSerDe, TwoWindingsTransformerPhaseAngleClockSerDe, TwoWindingsTransformerToBeEstimatedSerDe, VoltagePerReactivePowerControlSerDe

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

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractExtensionSerDe(String extensionName, String categoryName, Class<? super E> extensionClass, String xsdFileName, String namespaceUri, String namespacePrefix)

Method Summary

Modifier and Type	Method	Description
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	getVersion(String namespaceUri)	Return the version corresponding to the given namespace URI
InputStream	getXsdAsStream()	Return the XSD schema describing the extension to serialize in the latest version of its XML serialization.

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

checkExtensionVersionSupported, getArrayNameToSingleNameMap, getName, getNamespaceUri, getVersion, getVersions, getXsdAsStreamList, isSerializable, read, write

Constructor Details

AbstractExtensionSerDe

protected AbstractExtensionSerDe(String extensionName,
 String categoryName,
 Class<? super E> extensionClass,
 String xsdFileName,
 String namespaceUri,
 String namespacePrefix)

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.

getXsdAsStream

public InputStream getXsdAsStream()

Description copied from interface: ExtensionSerDe

Return the XSD schema describing the extension to serialize in the latest version of its XML serialization.

Specified by:

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

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>>

getNamespacePrefix

public String getNamespacePrefix()

Specified by:

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

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>>