Package com.powsybl.commons.extensions

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

java.lang.Object

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

All Implemented Interfaces:

ExtensionProvider<T,E>, ExtensionXmlSerializer<T,E>, Versionable

Direct Known Subclasses:

BaseVoltageMappingXmlSerializer, BranchObservabilityXmlSerializer, BranchStatusXmlSerializer, BusbarSectionPositionXmlSerializer, CgmesControlAreasXmlSerializer, CgmesDanglingLineBoundaryNodeXmlSerializer, CgmesLineBoundaryNodeXmlSerializer, CgmesSshMetadataXmlSerializer, CgmesSvMetadataXmlSerializer, CgmesTapChangersXmlSerializer, CimCharacteristicsXmlSerializer, CoordinatedReactiveControlXmlSerializer, DiscreteMeasurementsXmlSerializer, EntsoeAreaXmlSerializer, GeneratorFortescueXmlSerializer, GeneratorShortCircuitXmlSerializer, HvdcAngleDroopActivePowerControlXmlSerializer, HvdcOperatorActivePowerRangeXmlSerializer, IdentifiableShortCircuitXmlSerializer, InjectionObservabilityXmlSerializer, LineFortescueXmlSerializer, LinePositionXmlSerializer, LoadAsymmetricalXmlSerializer, LoadDetailXmlSerializer, MeasurementsXmlSerializer, SecondaryVoltageControlXmlSerializer, StandbyAutomatonXmlSerializer, SubstationPositionXmlSerializer, ThreeWindingsTransformerFortescueXmlSerializer, ThreeWindingsTransformerPhaseAngleClockXmlSerializer, ThreeWindingsTransformerToBeEstimatedXmlSerializer, TwoWindingsTransformerFortescueXmlSerializer, TwoWindingsTransformerPhaseAngleClockXmlSerializer, TwoWindingsTransformerToBeEstimatedXmlSerializer, VoltagePerReactivePowerControlXmlSerializer

public abstract class AbstractExtensionXmlSerializer<T extends Extendable,E extends Extension<T>>
extends Object
implements ExtensionXmlSerializer<T,E>

Author:

Geoffroy Jamgotchian

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractExtensionXmlSerializer(String extensionName, String categoryName, Class<? super E> extensionClass, boolean subElements, 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 serialization.
InputStream	getXsdAsStream()	Return the XSD schema describing the extension to serialize in the latest version of its serialization.
boolean	hasSubElements()

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

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

Constructor Detail

AbstractExtensionXmlSerializer

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

Method Detail

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.

hasSubElements

public boolean hasSubElements()

Specified by:

hasSubElements in interface ExtensionXmlSerializer<T extends Extendable,E extends Extension<T>>

getXsdAsStream

public InputStream getXsdAsStream()

Description copied from interface: ExtensionXmlSerializer

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

Specified by:

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

getNamespaceUri

public String getNamespaceUri()

Description copied from interface: ExtensionXmlSerializer

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

Specified by:

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

getNamespacePrefix

public String getNamespacePrefix()

Specified by:

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