cim1.model

Class SubGeographicalRegion

java.lang.Object

cim1.model.CIMInstance

cim1.model.IdentifiedObject

cim1.model.SubGeographicalRegion

public class SubGeographicalRegion
extends IdentifiedObject

This file has been automatically generated by CIMGateway Description : This class "SubGeographicalRegion.java" represents the class SubGeographicalRegion extends IdentifiedObject + Region 1..1 GeographicalRegion + Substations 0..-1 Substation (inverseAssociation)

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	idRegion The id of the attribute "region" This id is mainly used to resolve links after parsing an instance
GeographicalRegion	region Attribute "region" Comment from profile: The association is used in the naming hierarchy.
java.util.List<Substation>	substations Attribute "substations" Comment from profile: The association is used in the naming hierarchy.

Fields inherited from class cim1.model.IdentifiedObject

aliasName, description, name

Fields inherited from class cim1.model.CIMInstance

addedToUnresolved, fromBoundary, id, subset

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubGeographicalRegion() Constructor of the class SubGeographicalRegion

Method Summary

Modifier and Type	Method and Description
void	addSubstations(Substation substationsValue, boolean setInverse) Utility to add a value within the "substations" ArrayList of "Substation"
protected void	clearAssociations(Subset subset) Utility to clear the associations of this class belonging to a specific subset
void	clearContent(Subset subset) Utility to "clear" the content of a class when a subset is invalidated
SubGeographicalRegion	clone() Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances
void	copyBase(SubGeographicalRegion otherSubGeographicalRegion) Utility to copy the "base" of an other instance of the same class This utility does not copy the associations with other instances from the instance to copy
static SubGeographicalRegion	create(java.lang.String id) Factory of the class
GeographicalRegion	getRegion() Utility to return the "region"
java.util.List<Substation>	getSubstations() Utility to return the "substations" List of "Substation" enum
ConsistencyCheck	modelConsistency() Utility to check whether this class is consistent in a "merged" context
ConsistencyCheck	modelConsistency(Subset subset) Utility to check whether this class is consistent according to a subset
void	readAttribute(java.lang.String class_name, java.lang.String attr_name, java.lang.String value, CIMModel model) Utility to read an attribute This function is called by the CIMModel
void	readResource(java.lang.String class_name, java.lang.String resource_name, java.lang.String id, CIMModel model) Utility to read a reference to a resource This function is called by the CIMModel
boolean	regionIsSet() Utility to test if the value of "region" has been set
void	resolveLinks(CIMModel model, CIMModel boundaryModel) Utility to resolve the links at the end of parsing
void	setRegion(GeographicalRegion regionValue, boolean setInverse) Utility to set the "regionValue"
boolean	substationsIsSet() Utility to test if the value of "substations" has been set
void	write(javax.xml.stream.XMLStreamWriter xmlsw, boolean writeID) Utility to write the content into the CIM XML format
void	write(javax.xml.stream.XMLStreamWriter xmlsw, Subset subset, boolean writeID) Utility to write the content this class into the CIM/XML format according to a subset

Methods inherited from class cim1.model.IdentifiedObject

aliasNameIsSet, copyBase, descriptionIsSet, getAliasName, getDescription, getName, nameIsSet, setAliasName, setDescription, setName

Methods inherited from class cim1.model.CIMInstance

addToUnresolved, copyBase, getId, getSubset, isAddedToUnresolved, isFromBoundary, removeFromUnresolved, setFromBoundary, setId

Methods inherited from class java.lang.Object

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

Field Detail

region

public GeographicalRegion region

Attribute "region" Comment from profile: The association is used in the naming hierarchy.

idRegion

public java.lang.String idRegion

The id of the attribute "region" This id is mainly used to resolve links after parsing an instance

substations

public java.util.List<Substation> substations

Attribute "substations" Comment from profile: The association is used in the naming hierarchy.

Constructor Detail

SubGeographicalRegion

protected SubGeographicalRegion()

Constructor of the class SubGeographicalRegion

Method Detail

getRegion

public GeographicalRegion getRegion()

Utility to return the "region"

Returns:

the value of the attribute "region"

regionIsSet

public boolean regionIsSet()

Utility to test if the value of "region" has been set

Returns:

boolean if true the attribute "region" is already set if false it isn't yet

setRegion

public void setRegion(GeographicalRegion regionValue,
                      boolean setInverse)
               throws LinkageException

Utility to set the "regionValue"

Parameters:

regionValue - instance to set

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

getSubstations

public java.util.List<Substation> getSubstations()

Utility to return the "substations" List of "Substation" enum

Returns:

the list of the attributes "substations"

addSubstations

public void addSubstations(Substation substationsValue,
                           boolean setInverse)
                    throws LinkageException

Utility to add a value within the "substations" ArrayList of "Substation"

Parameters:

substationsValue - value to add within the ArrayList

setInverse - boolean to specify whether to set the inverse association or not

Throws:

LinkageException

substationsIsSet

public boolean substationsIsSet()

Utility to test if the value of "substations" has been set

Returns:

boolean if true the attribute "substations" is already set if false it isn't yet

create

public static SubGeographicalRegion create(java.lang.String id)

Factory of the class

Parameters:

id - id of the class SubGeographicalRegion to create

Returns:

the class created

clearContent

public void clearContent(Subset subset)

Utility to "clear" the content of a class when a subset is invalidated

Overrides:

clearContent in class IdentifiedObject

Parameters:

subset - subset to clean

readAttribute

public void readAttribute(java.lang.String class_name,
                          java.lang.String attr_name,
                          java.lang.String value,
                          CIMModel model)
                   throws InterpretationException

Utility to read an attribute This function is called by the CIMModel

Overrides:

readAttribute in class IdentifiedObject

Parameters:

class_name - the read name of class

attr_name - the read name of attribute

value - the read value of the attribute

model - the interface to the model this class belongs to

Throws:

InterpretationException

readResource

public void readResource(java.lang.String class_name,
                         java.lang.String resource_name,
                         java.lang.String id,
                         CIMModel model)
                  throws InterpretationException,
                         LinkageException

Utility to read a reference to a resource This function is called by the CIMModel

Overrides:

readResource in class IdentifiedObject

Parameters:

class_name - the read name of class

resource_name - the read name of the associated resource

id - the id of the associated resource

model - the model this class belongs to

Throws:

InterpretationException

LinkageException

write

public void write(javax.xml.stream.XMLStreamWriter xmlsw,
                  boolean writeID)

Utility to write the content into the CIM XML format

Overrides:

write in class IdentifiedObject

Parameters:

writeID - specifies whether to write the XML "id" attribute (this is used for describing concrete class)

xmlsw - XMLStreamWriter where are stored the elements to write

write

public void write(javax.xml.stream.XMLStreamWriter xmlsw,
                  Subset subset,
                  boolean writeID)

Utility to write the content this class into the CIM/XML format according to a subset

Overrides:

write in class IdentifiedObject

Parameters:

subset - the subset defining the context in which to write this class

writeID - specifies whether to write the XML "id" attribute (this is used for describing concrete class)

xmlsw - the stream in which are stored the elements to write

resolveLinks

public void resolveLinks(CIMModel model,
                         CIMModel boundaryModel)
                  throws LinkageException

Utility to resolve the links at the end of parsing

Overrides:

resolveLinks in class IdentifiedObject

Parameters:

model - the model this class belongs to

boundaryModel - the model that gather data about the boundarySet, used as a resource force links resolving

Throws:

Linkage - Exception

LinkageException

modelConsistency

public ConsistencyCheck modelConsistency(Subset subset)

Utility to check whether this class is consistent according to a subset

Overrides:

modelConsistency in class IdentifiedObject

Parameters:

subset - the subset defining the context in which to check whether this class is consistent

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

modelConsistency

public ConsistencyCheck modelConsistency()

Utility to check whether this class is consistent in a "merged" context

Overrides:

modelConsistency in class IdentifiedObject

Returns:

a ConsistencyCheck instance whose boolean attribute (consistent) indicates if this class is consistent and whose String attribute (message) indicates why this class is not consistent if it is not

copyBase

public void copyBase(SubGeographicalRegion otherSubGeographicalRegion)

Utility to copy the "base" of an other instance of the same class This utility does not copy the associations with other instances from the instance to copy

Parameters:

otherSubGeographicalRegion - the instance to copy

clearAssociations

protected void clearAssociations(Subset subset)

Utility to clear the associations of this class belonging to a specific subset

Overrides:

clearAssociations in class IdentifiedObject

Parameters:

subset - the subset from which to clear the associations of this class

clone

public SubGeographicalRegion clone()

Utility returning a copy of the "base" of this instance This utility does not copy the associations with other instances

Overrides:

clone in class IdentifiedObject

Returns:

a clone of this instance