UML profile

Overview

To be a valid input into the mapping the application schema should conform to ISO 19109:2005, and GML 3.2 (ISO 19136) Annex E, GML 3.3 and/or ISO/TS 19139.

In addition, extensions to these latter specifications are supported, too, but must be activated in extended encoding rules; see here for details.

Stereotypes

Well-known stereotypes for the purposes of ShapeChange are those defined in the UML specification, and in the ISO 19100-series of specifications, specifically ISO/TS 19103:2005, ISO 19109:2005 and GML 3.2/ISO 19136:2007.

Stereotypes are not case-sensitive. The stereotypes used in the ISO 19100 standards usually start with a upper case letter, but today the common practice is to start with a lower case letter and avoid whitespace.

Standard aliases listed for a stereotype can be used, too. Aliases can be configured.

All stereotypes not listed below are ignored.

There is one additional stereotype, that can be applied to all model elements, <<retired>>. It can be used in UML models to indicate that a model element has been retired and is only left in the model for compatibility with previous versions of the model. The stereotype currently does not have any impact on the standard ShapeChange output targets.

In UML 1, only one stereotype per model element are supported. UML 2 introduced the capability of model elements to carry more than one stereotype.

Stereotypes of packages

StereotypeAliasesDescription
no stereotype<<bundle>>,<<leaf>>A <<leaf>> package is a package that is not an application schema and contains no packages. [ISO/TS 19103]. A <<bundle>> package is a package that is not an application schema and contains other packages [GSIP]. For encoding purposes, these stereotypes are not relevant and thus specified as an aliases to no stereotype.
<<Application Schema>><<applicationSchema>>,<<schema>>,<<requirementsClass>>An application schema according to ISO 19109 [ISO 19109]. The alias <<schema>> has been introduced for packages that should be treated like application schemas, but do not contain feature types.

Stereotypes of classes

StereotypeAliasesDescription
no stereotype<<abstract>>A standard class, instances are plain objects with identify. The stereotype <<abstract>> is used by some models, but should be avoided. If a class is abstract, this must be indicated using the UML flag for abstractness, not the stereotype. If the stereotype is provided, it is ignored.
<<DataType>><<request>>, <<response>> A structured data type without identity [ISO/TS 19103]. The <<request>> and <<response>> stereotype were originally used in AFIS-ALKIS-ATKIS to distinguish data types for use in messages of services. For all encoding purposes these are treated as data types and are configured as aliases.
<<FeatureType>><<feature>>A feature type [ISO 19136]. Some schemas have used <<Feature>>, so this has been added as an alias.
<<Enumeration>> An enumeration.
<<CodeList>><<conceptScheme>>, <<vocabulary>>A code list. <<conceptScheme>> and <<vocabulary>> have been used to identify collections of enumerated values that may also have relationships like 'narrower'; for encoding purposes these are treated like code lists.
<<Union>> A structured data type without identity where exactly one of the properties of the type is present in any instance [ISO/TS 19103].
<<BasicType>> A basic type with a simple representation on most platforms. Usually it is a restriction of CharacterString or Number.
<<Interface>> For the purpose of transfer application schemas, this is the same as <<Type>>, see below.
<<Type>><<interface>>A type that is not directly instantiable, but is used as an abstract collection of operation, attribute and relation signatures. This stereotype should usually not be used in application schemas as these are on a different conceptual level than classes with the <<type>> stereotype. In the encoding these will usually be treated as if no stereotype has been set. <<Type>> has been deprecated in UML 2 and <<Interface>> should be used instead.
<<FachId>> OKSTRA feature types where instances may be referenced through symbolic links. See the OKSTRA documentation (in German)."
<<Schluesseltabelle>> OKSTRA Schlüsseltabellen. See the OKSTRA documentation (in German)."
<<ADEElement>> Feature type in an CityGML Application Domain Extension (ADE) that contains only properties that are generic application extensions.
<<featureConcept>> A feature concept in a feature concept dictionary (see ISO 19126). If a feature type classifier has a dependency to a feature concept classifier of the same name, ShapeChange will use the documentation of the concept as the documentation of the feature type, if the documentation of the feature type classifier is empty.
<<attributeConcept>> An attribute concept in a feature concept dictionary (see ISO 19126). If a feature type classifier has a dependency to an attribute concept classifier and a property of the same name, ShapeChange will use the documentation of the concept as the documentation of the property, if the documentation of the property is empty.
<<valueConcept>> A nominal value concept in a feature concept dictionary (see ISO 19126). If an enumeration has a dependency to an value concept classifier and an enumerant of the same name, ShapeChange will use the documentation of the concept as the documentation of the enumerant, if the documentation of the enumerant is empty.
<<AIXMExtension>> Type defined in an AIXM extension schema. It extends a specific feature or object type or all feature types, usually from the core AIXM schema."

Stereotypes of properties

StereotypeAliasesDescription
no stereotype The standard case for properties.
<<version>> If in an application schema an association role ends at a spatial object type, this stereotype denotes that the value of the property is meant to be a specific version of the spatial object, not the spatial object in general. [INSPIRE]
<<voidable>> If a characteristic of an object is not present, but may be present or applicable in the real world, this can be reflected using this stereotype. This is a shorthand notation for a union type of the normal value range with a void/nil value plus an optional reason for the void/nil value. [INSPIRE]
<<identifier>> An attribute with this stereotype is used to uniquely identify class objects. For database models, the attribute represents a primary key field.
<<property>> Typical stereotype for attribute or association role of a class that is not a code list or enumeration. Usually mapped to no stereotype, but can be useful when writing UML models (via the UmlModel target)."
<<enum>><<enumerationLiteral>>Typical stereotype for attribute of a code list or enumeration. Usually mapped to no stereotype, but can be useful when writing UML models (via the UmlModel target)."

Stereotypes of dependencies

StereotypeAliasesDescription
no stereotype For package dependencies without a stereotype, <<import>> is implied (source: ISO 19136:2007, section E.2.1.1.1).
<<import>>The model elements of the supplier package are imported.

NOTE: ShapeChange stores package dependencies without stereotypes. In other words, stereotypes on package dependencies are ignored (thus, it does not matter if such a dependency has the stereotype <<import>>, <<include>>, or any other stereotype). ShapeChange determines if an application schema has a dependency on a different application schema by examining the target namespaces of both packages; if they are different, the two packages belong to different application schema – otherwise, they belong to the same schema.

Stereotypes of generalizations

StereotypeAliasesDescription
no stereotype The standard case.
<<disjoint>> The constraint added to a set of generalization relationships indicates that an instance of the parent may be an instance of one and only one of the children within the set. This is implicitly assumed to be the case.

NOTE: ShapeChange ignores stereotypes on generalizations.

Tagged Values

Tagged values are used to represent additional information in the UML model that are either specific to an encoding or which require a name-value-pair.

The following table documents the tagged values that ShapeChange directly supports, i.e. loads from a model without having to be added via the input parameters addTaggedValues or representTaggedValues.

Tagged ValueScope (to which model element(s) does the tag typically apply)Stereotype (if specific)SourceDescriptionShapeChange Process (if specific)Links
AAA:AAAVersionpackageapplicationSchema, no stereotypeGeoInfoDok, German Surveying AgenciesVersion des AAA Schemas von dem das Fachschema abhängt; ggfs. nicht mehr in Verwendung.
AAA:DatumpackageapplicationSchema, no stereotypeGeoInfoDok, German Surveying AgenciesDatum der Version (siehe AAA:Version); für Ableitung von Objektartenkatalogen
AAA:Grunddatenbestandclass, propertyfeatureType, type, dataType, union, enumeration, codeListGeoInfoDok, German Surveying AgenciesKommagetrennte Liste der Modellarten, bei denen die Objektart Teil des Grunddatenbestands ist
AAA:KennungallGeoInfoDok, German Surveying AgenciesÜbergreifende Funktion für verschiedene Ableitungen (z.B. DB Schema und Objektartenkataloge). 5-stellig für Klassen, 3-stellig für Eigenschaften (Ausnahmen sind möglich).
AAA:LetzteAenderungclass, propertyfeatureType, type, dataType, union, enumeration, codeListGeoInfoDok, German Surveying AgenciesDatum und Kommentar der letzten Änderung am Element
AAA:ModellartallGeoInfoDok, German Surveying AgenciesDient der Zuordnung eines Modellelements zu einem oder mehreren Modellen. Der Wert entspricht einem Code aus AA_AdVStandardModell oder AA_WeitereModellart.
AAA:NutzungsartclassfeatureType, type, dataType, union, enumeration, codeListGeoInfoDok, German Surveying AgenciesAngaben für den Nutzungsartenkatalog (AdV intern); für Fachschema nicht relevant
AAA:Nutzungsartkennungclass, propertyfeatureType, type, dataType, union, enumeration, codeListGeoInfoDok, German Surveying AgenciesAngaben für den Nutzungsartenkatalog (AdV intern); für Fachschema nicht relevant
AAA:objektbildendpropertyno stereotypeGeoInfoDok, German Surveying AgenciesKommagetrennte Liste der Modellarten, bei denen die Eigenschaft objektbildend ist – relevant falls Versionierung bei Datenhaltung angewandt werden soll.
AAA:OrganisationpackageapplicationSchema, no stereotypeGeoInfoDok, German Surveying AgenciesName der für das Anwendungsschema verantwortlichen Organisation; für Ableitung von Objektartenkatalogen
AAA:Profileclass, propertyfeatureType, type, dataType, union, enumeration, codeListGeoInfoDok, German Surveying AgenciesKommagetrennte Liste der Profile, zu denen die Objektart gehört
AAA:RevisionsnummerallGeoInfoDok, German Surveying AgenciesDie genaue Regelung ist bislang nicht dokumentiert.
AAA:ThemenclassfeatureType, type, dataType, union, enumeration, codeListGeoInfoDok, German Surveying AgenciesThemen, zu denen die Objektart gehört (siehe Dokumentation AX_Themendefinition im AAA Anwendungsschema). Anwendbar falls Topologie wichtig ist (die Klasse ist dementsprechend aus AG_ObjektMitGemeinsamerGeometrie abzuleiten).
AAA:VersionpackageapplicationSchema, no stereotypeGeoInfoDok, German Surveying AgenciesVersion des Schemas
aliasallAn alias of the name of the model element, usually for presentation to a human.
allowedTypesNASpropertyno stereotypeGeoInfoDok, German Surveying Agencies
alwaysVoidclassIdentifies properties that are always void, for documentation in a feature catalogue (as textual constraint).FeatureCatalogue target
appliesToclassIdentifies network elements to which the class applies, for documentation in a feature catalogue (as textual constraint).FeatureCatalogue target
arcgisDefaultSubtypepropertyInteger code of the ArcGIS subtype that shall be used as default.ArcGISWorkspace targetCreating the ArcGIS workspace UML model
arcgisSubtypeCodeclass, propertyRelevant for defining subtype codes if ArcGIS subtypes are defined by a code list or enumeration and if ArcGIS subtypes are explicitly modelled.ArcGISWorkspace targetCreating the ArcGIS workspace UML model
arcgisSubtypeInitialValuespropertyUsed to define default values for ArcGIS subtypes defined by a code list or enumeration.ArcGISWorkspace targetCreating the ArcGIS workspace UML model
arcgisUsedBySubtypespropertyUsed to identify the subtypes to which an enum or code applies. Relevant for ArcGIS subtypes defined by a code list or enumeration.ArcGISWorkspace targetCreating the ArcGIS workspace UML model
asDictionaryclasscodeListISO 19136, GML 3.3If the value is 'false' the code list will be encoded with the pre-defined enumerants as values in the schema, if 'true' all enumerants will only be maintained in external dictionaries. The default depends on the encoding rule used.
associativeTableassociation, attributeProvides the name of the associative table created for an n:m relationship between types.SQL targetrule-sql-all-associativetables
asXMLAttributepropertyAlias to 'xsdAsAttribute'.XML Schema target
baseclassDefines the value of "base" when creating an anonymous basic type for the class.XML Schema target
broaderListedValuepropertyUsed to establish skos:broader relationships between codes.Ontology targetrule-owl-prop-code-broader-byBroaderListedValue
byValuePropertyTypeclassno stereotype, featureType, typeISO 19136Create a property type that requires that the instance is encoded inline. Should usually be set to false.
codeListclasscodeListdocument on the OGC portalThe URI of a resource representing the code list, for example a code list dictionary.FeatureCatalogue target, GML codelist dictionary target, XML Schema target, ldproxy targetfeature catalogue parameter includeCodeListURI
rule-xsd-prop-targetCodeListURI
rule-xsd-cls-codelist-constraints
rule-xsd-cls-codelist-constraints2
rule-xsd-cls-codelist-gmlsf
rule-ldp-cls-generate-codelist
codeListRepresentationclasscodeListdocument on the OGC portalDefine the representation of a code list. Relevant for deriving Schematron constraints. Allowed values are defined by the relevant conversion rules.XML Schema targetrule-xsd-cls-codelist-constraints
rule-xsd-cls-codelist-constraints2
codeListRestrictionpropertycodeListPrimarily used in metadata profiles, to restrict the type of a property (in metadata profiles typically typed CharacterString) to a specific code list (identified by name via the tagged value). The XML Schema target can then generate Schematron assertions that check the restriction. NOTE: The tagged value can also be derived from OCL constraints via the ConstraintConverter transformation (rule-trf-cls-constraints-codeListRestrictionToTV).ConstraintConverter, XML Schema targetrule-trf-cls-constraints-codeListRestrictionToTV
rule-xsd-cls-codelist-constraints2
codeListSourceclasscodeListProvides a link to a remote or local resource (in a specific representation, defined by tagged value codeListSourceRepresentation) which contains the currently defined codes for a code list. Can be used to load the codes from that source into the model, for example to derive Schematron constraints.Code List Loader transformationrule-trf-cls-loadCodes
codeListSourceCharsetclasscodeListDefines the character set of the resource referenced by tagged value codeListSource.Code List Loader transformationrule-trf-cls-loadCodes
codeListSourceRepresentationclasscodeListIdentifies the type of resource referenced by tagged value codeListSource. For example application/x.iso639_2.Code List Loader transformationrule-trf-cls-loadCodes
codelistTypeclasscodeListDefines application-specific category for a code list. This information can be used by the SQL target to separate code insert statements produced by the target by code list type.SQL targetSqlDdl parameter separateCodeInsertStatementsByCodelistType
codeListValuePatternclasscodeListdocument on the OGC portalValue access pattern for the code list, containing the substitution points {codeList} and {value}, where {codeList} is the base URI of the code list (replaced by the tagged value codeList) and {value} the local identifier of the code list value. Default: "{codeList}/{value}" XML Schema targetrule-xsd-cls-codelist-constraints
dataCaptureStatementallA statement describing how to capture instances of the model element from the real-world.
NOTE: This tagged value is the default source for descriptor 'dataCaptureStatement'.
Descriptor sources
defaultCodeSpaceclasscodeListISO 19136The URI of the default dictionary that contains code list.
definitionallThe normative specification of the model element. Using this tag is one approach to defining the source of descriptor 'definition'.Descriptor sources
descriptionallAdditional informative information about the model element. Using this tag is one approach to defining the source of descriptor 'description'.Descriptor sources
dissolveAssociationassociationIf set to 'false', the association will be excluded from the TypeConverter transformation rule-trf-dissolveAssociations.TypeConverter transformationrule-trf-dissolveAssociations
dissolveAssociationAttributeTypeassociation roleCan be used to define the type of the attribute, which results from transforming the association role using the TypeConverter transformation rule-trf-dissolveAssociations.TypeConverter transformationrule-trf-dissolveAssociations
documentationallUMLThe documentation for the model element. Using this tag is one approach to defining the source of descriptor 'documentation'.Descriptor sources
exampleallAn example illustrating the model element.
NOTE: This tagged value is the default source for descriptor 'example'.
Descriptor sources
extensibilityclasscodeListINSPRIEThis refers to extensions by a third party, not to extensions by the owner of the vocabulary; the owner will always be able to revise the vocabulary. I.e., if the value is 'none', the referenced vocabulary may not be extended by third parties; if the value is 'narrower', the vocabulary may be extended by narrower terms that have an existing term as a parent; if the value is 'any', the vocabulary may be extended by additional terms on any level. This value must be 'any', empty or missing, if the value 'vocabulary' is empty or missing; in this case any vocabulary may be used.Requirements for classes (see req-xsd-cls-codelist-extensibility-values and req-xsd-cls-codelist-extensibility-vocabulary)
fieldTypeclasscodeList, enumerationDefine the ESRI field type for properties that have the code list or enumeration as type. Overrides tagged value 'numericType'.ArcGISWorkspace targetCreating the ArcGIS Workspace UML Model - Conversion of model elements - Class
formcolspropertyUsed in creating an application configuration file (via the as yet undocumented, AppConfiguration target).AppConfiguration target (undocumented)
formrowspropertyUsed in creating an application configuration file (via the as yet undocumented, AppConfiguration target).AppConfiguration target (undocumented)
generationDateTimepackageDate and time that the application schema was generated, for documentation in feature catalogues (currently only frame-based HTML feature catalogues).
NOTE: The tagged value can also be set by transformations, see Common transformer functionality - Setting model generation date and time.
FeatureCatalogue target
geometryclassIdentifies the geometry types allowed for this class if it is flattened to classes with homogeneous geometry. For further details, see Flattener transformation rule-trf-prop-flatten-homogeneousgeometries. (Comma-separated) Value(s) must match @param value(s) of map entries with @rule=rule-trf-prop-flatten-homogeneousgeometries from the Flattener configuration. Example: "P,C".
NOTE: This tagged value can be updated while creating a profile, through definition of the profile parameter "geometry".
NOTE: The tagged value can also be populated through evaluation of geometry restrictions from OCL constraints (which can be performed by the Constraint Converter transformation).
Flattener transformation

Profile transformation

Constraint Converter transformation
rule-trf-prop-flatten-homogeneousgeometries


Profile parameter


Evaluating geometry restrictions from OCL constraints
gmlArrayPropertypropertyFor properties with a tagged value ‘gmlArrayProperty’ set to ‘true’ and with complex content that is always inline, i.e. the property has the tagged value ‘inlineOrByReference’ set to ‘inline’, an array property is created instead of using the standard GML property types.XML Schema targetrule-xsd-prop-gmlArrayProperty
gmlAsCharacterStringclassunionA union with a tagged value ‘gmlAsCharacterString’ set to ‘true’ is not converted in the usual way, but converted as if it would be a CharacterString.XML Schema targetrule-xsd-cls-union-asCharacterString
gmlAsGroupclassunionA union class with tagged value gmlAsGroup = true is encoded as a global group which is referenced wherever a property is defined that has the union class as its value. (Note that this is only valid if it is clear from the context how to map the individual values to the conceptual model.)
NOTE: Deprecated tagged value 'asGroup' is automatically mapped to 'gmlAsGroup'.
XML Schema targetrule-xsd-cls-union-asGroup
gmlImplementedByNilReasonpropertyPrimarily used by the XML Schema target, see descriptions of rule-xsd-prop-nilReasonAllowed and rule-xsd-cls-union-direct. Also used by the SQL target to determine if a column can be NULL.
NOTE: Deprecated tagged value 'implementedByNilReason' is automatically mapped to 'gmlImplementedByNilReason'.
XML Schema target

SQL target
rule-xsd-cls-union-direct


rule-xsd-prop-nilReasonAllowed


Support for nillable and nilReason
gmlListPropertypropertyFor properties with a tagged value ‘gmlListProperty’ set to ‘true’ and with a simple type as value, maxOccurs is suppressed and a list type is created.XML Schema targetrule-xsd-prop-gmlListProperty
gmlMixinclassno stereotype, type, featureTypeIdentifies the type as a mixin type that will not be encoded as a separate element/type in the XML encoding, but properties will be copied to subtypes. This is a ShapeChange extension which supports multiple inheritance for application schema types in specific cases.Support for Mixin Classes
gmlProfileSchemapackageapplicationSchemaISO 19136URL of the schema location of a GML profile (where applicable).XML Schema targetrule-xsd-pkg-gmlProfileSchema
HasMclassfeatureTypeControls setting of HasM for ArcGIS feature classes.ArcGIS Workspace targetrule-arcgis-cls-hasM
HasZclassfeatureTypeControls setting of HasZ for ArcGIS feature classes.ArcGIS Workspace targetrule-arcgis-cls-hasZ
infoURLclasscodeList, enumerationCan be used to define the @codeSpace of gml:identifiers of dictionary content.Codelist Dictionary targetsDictionaries target
inlineOrByReferencepropertyISO 19136Controls whether property values may be encoded inline or by reference. Valid values are 'inline', 'byReference' and 'inlineOrByReference'. Default is 'inlineOrByReference'.
isCollectionclassno stereotype, featureType, typeISO 19136Identifies the type as a collection.
isFlatTargetassociation roleCan be used to control how complex type flattening is applied in case of a bi-directional association, which is made uni-directional through application of rule-trf-prop-removeNavigabilityBasedOnIsFlatTarget based upon the isFlatTarget setting.Flattener transformationrule-trf-prop-removeNavigabilityBasedOnIsFlatTarget
isMetadatapropertyISO 19136Indicates whether the property is considered metadata about the instance – and not information about the phenomenon in the real world. 'true' or 'false', the default is 'false'.
jsonBaseURIschema packageOWS-9 System Security Interoperability (SSI) UML-to-GML-Application-Schema (UGAS) Conversion Engineering ReportCan be used to define the base of the URI that is used as value of the 'id' field of a JSON Schema file generated by ShapeChange. Takes precedence over the JSON Schema target parameter jsonBaseURI.JSON Schema targetJSON Schema target parameter jsonBaseURI
jsonDirectoryschema packageOWS-9 System Security Interoperability (SSI) UML-to-GML-Application-Schema (UGAS) Conversion Engineering ReportUsed to define a subdirectory within the URI that is used as value of the 'id' field of a JSON Schema file generated by ShapeChange.JSON Schema targetJSON Schema target parameter jsonBaseURI
jsonEncodingRuleallOWS-9 System Security Interoperability (SSI) UML-to-GML-Application-Schema (UGAS) Conversion Engineering ReportControls the applicable conversion rule on a model element. Typically this will be set only on the application schema level or provided as external input to the conversion processJSON Schema target
jsonLayerTableURIclassfeatureTypeOWS-9 System Security Interoperability (SSI) UML-to-GML-Application-Schema (UGAS) Conversion Engineering ReportThe URI of the associated Layer/Table resource in a GeoServices REST API Feature Service. This can usually not be set as there will be more then one service that provides information on a feature type. However, if it is provided, explicit "links" properties as specified by JSON Schema can be provided in the schema of the feature type.JSON Schema target
languageallThe default language, if no language information is provided in definitions, descriptions, examples, etc.
NOTE: This tagged value is the default source for descriptor 'language'.
Descriptor sources
legalBasisallThe legal basis for the model element:
NOTE: This tagged value is the default source for descriptor 'legalBasis'.
Descriptor sources
lengthclass, propertyUsed to define the maximum length of a string valued attribute. Sometimes also used on classes.CDB and XML Schema targetsrule-xsd-cls-basictype


rule-xsd-prop-constrainingFacets


rule-xsd-prop-length-size-pattern
maxLengthclass, propertyUsed to define the maximum length of a string valued attribute. Sometimes also used on classes.XML Schema targetrule-xsd-cls-basictype


rule-xsd-prop-constrainingFacets
maxOccurspropertyUsed to control how many copies of a property are created while flattening multiplicity.Flattener transformationrule-trf-prop-flatten-multiplicity
metadataTypepropertypropertyMetadataUGAS-2019 reportIdentifies the type of the metadata that can be associated with the property (more specifically, its value(s)).
namepackage, class, propertyTypically used to define an additional name for a model element. Can be used by the (old) OWS-8 ontology target to define the skos:prefLabel of a skos:ConceptScheme.Flattener transformation, OWS-8 ontology targetrule-trf-prop-flatten-types


UML to RDF/OWL target (based on OWS-8 encoding rule)
neverVoidclassIdentifies properties that are never void, for documentation in a feature catalogue (as textual constraint).FeatureCatalogue target
nillablepropertyIf set to 'true' on a property, this states that the property is voidable (also called nillable).Support for nillable and nilReason


rule-xsd-prop-nillable


rule-xsd-prop-nilReasonAllowed


rule-arcgis-prop-isNullable


Property conversion in the SqlDdl target
nilReasonAllowedpropertytrue', if the nilReason attribute is allowed in the XML encoding of the property.XML Schema targetrule-xsd-prop-nilReasonAllowed
noncomparableMeasureattributedocument on the OGC portalValid non-comparable unit. Example: "flightLevel"
noPropertyTypeclassno stereotype, featureType, type, dataType, unionISO 19136Set to 'true' to suppress creation of a standard property type that supports inline or by-reference encoding. For data types only inline encoding is supported. Should usually be set to 'false'.XML Schema target
numericTypeclasscodeList, enumerationSetting this tagged value on a code list or enumeration indicates that the codes are numeric. The tagged value contains the name of the conceptual type that represents the code values best, for example 'Number' or 'Integer'.

This tagged value is used by the SQL and ArcGIS workspace targets:
- ArcGIS Workspace target: The ArcGIS data type will be determined by mapping that type using the map entries defined in the configuration. NOTE: The field type determined by processing this tagged value will be overridden if tagged value "fieldType" is also set on the code list / enumeration.
- SQL target: The SQL data type will be determined by mapping that type using the map entries defined in the configuration, resulting in a DBMS specific implementation of the SQL data type.
ArcGISWorkspace and SQL targetsCreating the ArcGIS Workspace UML Model - conversion of model elements - classes


rule-sql-cls-code-lists
obligationpropertyINSPIREThe value type of the property must be a code list. The use of the referenced code list may be made legally required in the implementing rule ('implementingRule') or only in the technical guidance ('technicalGuidance'). This value must be empty or missing, if the value 'vocabulary' in the value type is empty or missing.
oclExpressionsclassUsed on XMI encoded models, to define OCL expressions of a class. Note that due to a lack of use, the logic for loading of XMI models has not been maintained in ShapeChange for quite some time.
omitWhenFlattenedclassCan be used to control naming of properties while flattening complex types. Primarily set to 'true' on helper classes that aggregate a number of properties which are used by multiple classes (e.g. WaterResourceInfo). Helps reducing the length of names of flattened model elements. This mechanism only works if the maximum multiplicity of properties with the class (C) that has omitWhenFlattened=true as value type is exactly 1. In addition, classes that own such properties must not contain a property with a name that equals the name of one of the properties from (C). Otherwise the result would be ambiguous.Flattener transformationrule-trf-prop-flatten-types
oneToManyReferenceColumnNameclassdatatypeCan be used to define the name of the additional reference column which is added to the table that represents the data type.SQL targetrule-sql-cls-data-types-oneToMany-oneTable
ontologyNamepackageCan be used to define the name of the ontology that is derived from a package. Note: Defining the ontology name by tagged value is useful if ontologies shall be derived from multiple schemas, and each shall have a specific ontology name that is defined in the UML model.Ontology targetrule-owl-pkg-ontologyName-byTaggedValue
owlDisjointPropertiespropertyOGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property EnrichmentUsed to define the OWL property axiom 'disjoint' for the OWL property that represents the UML property with this tagged value.Ontology targetrule-owl-prop-propertyEnrichment
owlEquivalentPropertiespropertyOGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property EnrichmentUsed to define the OWL property axiom 'equivalent' for the OWL property that represents the UML property with this tagged value.Ontology targetrule-owl-prop-propertyEnrichment
owlInversePropertiespropertyOGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property EnrichmentUsed to define the OWL property axiom 'inverse' for the OWL property that represents the UML property with this tagged value.Ontology targetrule-owl-prop-propertyEnrichment
owlLogicalCharacteristicspropertyOGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property EnrichmentUsed to define the OWL property axioms 'functional', 'inverse-functional', 'reflexive', 'irreflexive', 'symmetric', 'asymmetric', and 'transitive' for the OWL property that represents the UML property with this tagged value.Ontology targetrule-owl-prop-propertyEnrichment
owlSubPropertyOfpropertyOGC Testbed-14: Application Schema-based Ontology Development Engineering Report (OGC 18-032r2) - chapter OWL Property EnrichmentUsed to define the OWL property axiom 'subPropertyOf' for the OWL property that represents the UML property with this tagged value.Ontology targetrule-owl-prop-propertyEnrichment
parentproperty, classclass (itself, or that owns the property): codelist, enumerationOGC Engineering Report OWS-8 Cross Community Interoperability (CCI) Semantic Mediation, OGC document number 11-063r6. See sub-clause 8.1Can be used to define hierarchical code lists (as specified in the IMGeo specification in the Netherlands).(old) OWS-8 ontology targetUML to RDF/OWL target (based on OWS-8 encoding rule) - rule-rdf-prop-parent
physicalQuantityattributedocument on the OGC portalPhysical quantity of the referenced unit. Example: "length"
precisionproperty, also class (representing a numeric code list [SQL target])Can be used to define the precision for the target representation of the property (or properties with numeric code list).ArcGIS Workspace and SQL targetsrule-arcgis-all-precision


rule-sql-all-precisionAndScale
primaryCodeallThe primary code for the model element.
NOTE: This tagged value is the default source for descriptor 'primaryCode'.
Descriptor sources
profilesproperty, classIdentifies the profiles to which the model element belongs.

Note:
- The Model Export target can be used to export a model, including defined profiles, in SCXML format, for subsequent profile definition via the Profile Management Tool.
- The Profile Transfer EA target can be used to write profile definitions into schemas contained in an EA repository.
- The Application Schema Metadata target can be used to identify the profiles defined in a schema.
Profiler transformation
Model Export, Profile Transfer EA, and Application Schema Metadata targets


Model export target


Profile transfer to EA target


rule-asm-all-identify-profiles
prohibitedInProfileproperty, classSet to 'true' to indicate that the property or the class is prohibited. This can be used to prevent creation of (Schematron) property assertions in rule-xsd-cls-codelist-constraints2.
Note: The tagged value can be set by rule-trf-cls-createGeneralOutOfScopeConstraints of the Profile Constraint Transformer transformation (which is used in the creation of metadata profiles as defined by ISO 19115/19139).
XML Schema target, Profile Constraint transformerrule-xsd-all-propertyAssertion-ignoreProhibited


rule-xsd-cls-codelist-constraints2


rule-trf-cls-createGeneralOutOfScopeConstraints
rangeMaximumproperty, also class (XML Schema target)Define the maximum range of the property, or of a basic XML Schema type.ArcGIS Workspace, SQL, CDB, and XML Schema targets

rule-arcgis-cls-rangeDomainFromTaggedValues


rule-xsd-prop-constrainingFacets


rule-xsd-cls-basictype


OGC Testbed-13: NAS Profiling Engineering Report - The CDB Geomatics Attributes Dictionary
rangeMinimumproperty, also class (XML Schema target)Define the minimum range of the property, or of a basic XML Schema type.ArcGIS Workspace, SQL, CDB, and XML Schema targetsrule-sql-cls-check-constraint-for-range


rule-sql-prop-check-constraint-for-range


rule-arcgis-cls-rangeDomainFromTaggedValues


rule-xsd-prop-constrainingFacets


rule-xsd-cls-basictype


OGC Testbed-13: NAS Profiling Engineering Report - The CDB Geomatics Attributes Dictionary
recommendedMeasureattributedocument on the OGC portalUnit recommended for use with this property. The unit must be consistent with the physicalQuantity value. Example: "metre"
ReiterpropertyUsed in creating an application configuration file (via the as yet undocumented, AppConfiguration target).AppConfiguration target (undocumented)
reportablepropertyUsed to define the subsets under which the property is published.LD Proxy targetLdproxy target parameter enablePropertiesReportable
resourceURIproperty (of an enumeration or code list)Used to produce XPath expressions when generating Schematron. If an enum or code (modelled as attribute of an enumeration or code list) has tagged value “resourceURI”, it is used as literal value during the translation of the enum/code to a literal value within an XPath expression, instead of the enum/code name.Targets that generate Schematron
reverseRoleNASpropertyno stereotypeGeoInfoDok, German Surveying AgenciesWert des UML Tagged Value „reverseRoleNAS“ wird im XML Schema in appinfo-Annotationen an dem Element ausgegeben, das der Assoziationsrolle entspricht. Kann bei Modellierung ignoriert werden wenn Historisierung keine Rolle spielt. Wird bei Bedarf automatisch durch NAS-Transformation zu Implementierungsschema gesetzt.
scaleproperty, also class (representing a numeric code list [SQL target])Can be used to define the scale for the target representation of the property (or properties with numeric code list).ArcGIS Workspace and SQL targetsrule-arcgis-all-scale


rule-sql-all-precisionAndScale
sequenceNumberpropertyISO 19136Used to sort/order the properties of the class to which the property belongs. The value shall be an integer value that is unique for the properties of that class.
Note: ShapeChange also supports sequence numbers with integer components separated by dots (e.g. '10.4.3').
shortNameproperty, classDefine a short name for a model element, for shortening the names of representations in a given encoding.ArcGIS Workspace and SQL targetsrule-sql-all-constraintNameUsingShortName


rule-sql-all-indexNameUsingShortName


rule-arcgis-all-relationshipClassNameByTaggedValueOfClasses
sizepropertyUsed to define the maximum length of a string valued attribute. Sometimes also used on classes.ArcGIS Workspace, SQL, and XML Schema targetsSqlDdl target - Textual Data Type with Limited or Unlimited Length


rule-sql-prop-replicationSchema-maxLength-from-size


rule-arcgis-prop-lengthFromTaggedValue


rule-arcgis-prop-lengthFromTaggedValueForCodelistOrEnumerationValueType


rule-xsd-prop-constrainingFacets


rule-xsd-prop-length-size-pattern
skosConceptSchemeSubclassNameclasscodeListCan be used to define the name of the skos:ConceptScheme subclass created for a code list.Ontology targetrule-owl-cls-codelist-19150-2-conceptSchemeSubclass
soft-typedpropertySet to 'true' in order for the property to be encoded in XML with an additional 'name' attribute. Used in the SWE Common Data Model 2.0 encoding rule.XML Schema targetrule-xsd-prop-soft-typed
sqlEncodingRuleallSQL encoding rule to apply. Default is '*'.SQL target
sqlOnDeleteproperty, associationDefine the foreign key option for the case of a deletion (of the record that is referenced by the foreign key).SQL targetSqlDdl target Foreign key constraint options
sqlOnUpdateproperty, associationDefine the foreign key option for the case of an update (of the record that is referenced by the foreign key).SQL targetSqlDdl target Foreign key constraint options
sqlUniquepropertyIf set to 'true', then:
- in the SQL target: a unique constraint can be created for the column that represents the property
- in the ArcGIS Workspace target: an attribute index can be created for the field that represents the property
SQL and ArcGIS Workspace targetsrule-arcgis-prop-attIndex
statusclassCan be used to prevent loading of classes, if input parameter 'prohibitLoadingClassesWithStatusTaggedValue' is set. If the tagged value matches one of the values of this parameter, the class will not be loaded.
Note: Also relevant for the Profile Transfer EA target, since it only transfers profiles to non-prohibited classes.
Input parameter prohibitLoadingClassesWithStatusTaggedValue


Profile transfer to EA target
suppressclassUsed to suppress the creation of object elements, local properties and property types for the class in the XML Schema.
Also used by the Profile Constraint Transformer for creating constraints to prohibit use of certain schema classes in a metadata profile. Note that these constraints would be translated into Schematron rules by a subsequent processing step (involving the Xml Schema target) in the ShapeChange workflow.
rule-xsd-cls-suppress


Profile constraint transformer
targetNamespacepackageapplicationSchemaISO 19136The target XML namespace of the application schema.
NOTE: Deprecated tagged value 'xmlNamespace' is automatically mapped to 'targetNamespace'.
TitleclasscodeList, enumerationUsed (as alias for tagged value 'name') in the (old) OWS-8 ontology target to define the skos:prefLabel of skos:ConceptSchemes created for the codelist/enumeration.(old) OWS-8 ontology targetUML to RDF/OWL target (based on OWS-8 encoding rule)
toCodelistclassenumerationIf set to 'false', the enumeration is not converted to a code list by the TypeConverter transformation rule-trf-enumeration-to-codelist.TypeConverter transformationrule-trf-enumeration-to-codelist
toFeatureTypeclassSet to 'true', in order for a class being transformed to a feature type by the Type Converter rule-trf-toFeatureType.TypeConverter transformationrule-trf-toFeatureType
uomResourceRepresentationpackageschema, applicationSchemadocument on the OGC portalMIME type indicating the units dictionary representation. Currently, only one value is specified: "application/gml+xml;version=3.2" for a GML dictionary (as currently used in the MDR).
Default: "application/gml+xml;version=3.2"
uomResourceURIpackageschema, applicationSchemadocument on the OGC portalBase URI of the units dictionary Example: "http://metadata.ces.mil/mdr/ns/GSIP/uom/"
uomResourceValuePatternpackageschema, applicationSchemadocument on the OGC portalAccess pattern for the unit, containing the following substitution points:
- {resource}: The base URI of the units dictionary, to be replaced by the tagged value uomResourceURI from the schema.
- {quantity}: The quantity type of the unit, to be replaced with the value of the tagged value physicalQuantity (or the value ‘noncomparable’) from the property.
- {uom}: The local identifier of the unit in the units dictionary, to be replaced with the value of the tagged value recommendedMeasure or noncomparableMeasure from the property, or a valid value from the resource that represents the physicalQuantity.
Default: "{resource}/{quantity}/{uom}".
validatepropertyUsed in creating an application configuration file (via the as yet undocumented, AppConfiguration target).AppConfiguration target (undocumented)
versionpackageapplicationSchemaISO 19136Current version of the application schema.
vocabularyclasscodeListINSPIREURI of the vocabulary/code list in a registry. Alias to 'codeList'.
voidReasonTypepropertyUsed to indicate which absence reasons apply for a given (typically: voidable) property. The tag value identifies an enumeration that defines the absence reasons.
xmlnspackageapplicationSchemaISO 19136Namespace prefix to be used as short form of the target namespace.
NOTE: Deprecated tagged value 'xmlNamespaceAbbreviation' is automatically mapped to 'xmlns'.
xmlSchemaTypeclasstypeISO 19136If the type has a canonical XML Schema encoding the XML Schema typename corresponding to the data type shall be given as the value.
xsdAsAttributepropertyIf the tagged value ‘asXMLAttribute’ (or ‘xsdAsAttribute’) is set to ‘true’ on a property, the property has a maximum multiplicity of 1 and the value of the property is simple, the property is converted to an XML attribute instead of an XML element.XML Schema targetrule-xsd-prop-xsdAsAttribute
xsdDocumentpackageapplicationSchema, no stereotypeISO 19136Name of an XML Schema document to create representing the content of the package.
NOTE: Deprecated tagged value 'xsdName' is automatically mapped to 'xsdDocument'.
xsdEncodingRuleallXML Schema encoding rule to apply. Default is iso19136_2007.XML Schema target

OCL Constraints

In an extension to the standard encoding rules, ShapeChange supports also parsing of OCL constraints in the application schema (not for XMI 1.0 models, as these have no standard mechanism for representing constraints). The supported set of expressions is documented here.

If the UML tool does not support OCL constraints directly, constraints may also be represented in a tagged value “oclExpressions”.

Requirements of the XML Schema output target

All model elements in application schema packages must meet the requirements in this section, if the XML Schema target is used.

Requirements for all model elements

None at the moment

Requirements for packages

IdentifierDescriptions
req-xsd-pkg-xsdDocument-uniqueAll tagged values xsdDocument in a UML model must be unique.

Requirements for classes

IdentifierDescriptions
req-xsd-cls-ncnameEach class name must be a NCName.
req-xsd-cls-name-uniqueAll class names within the same application schema must be unique.
req-xsd-cls-mixin-supertypesMixin classes must have no instantiable supertypes.
req-xsd-cls-mixin-supertypes-overruleOverrules req-xsd-cls-mixin-supertypes and allows that mixin classes may have supertypes that are not mixin.

Requirements for properties

IdentifierDescriptions
req-xsd-prop-value-type-existsThe value type shall either be a predefined type or a class defined in the UML model.
req-xsd-prop-data-typeIf the value type is data type, the property must be an attribute or a composition.
req-xsd-prop-ncnameThe property name must be a NCName.

GML requires that a tagged value “sequenceNumber” shall be specified for every attribute. The value shall be an integer and be unique for all attributes and association ends of a class. As the sequenceNumber values are used to organize the properties of a class, this cannot be tested in the validation step, but errors are reported during the initial processing of the model.

ShapeChange supports a more flexible approach for sequenceNumber values than the GML standard:

  • the value may omitted in which case ShapeChange determines its own order;
  • the value may be a structured integer, e.g. values like “4.2.3”.

Multiplicities and visibility are also evaluated during the initial model read process and cannot be validated at a later stage. Any errors and warnings are reported while reading the model.

Requirements for associations

Navigability is evaluated during the initial model read process and cannot be validated at a later stage. Any errors and warnings are reported while reading the model.

Additional Requirements

These requirements may be added in encoding rules.

Requirements for all model elements

IdentifierDescriptions
req-all-all-documentationName and definition separators ('-- Name --' and '-- Definition --') must be included in the documentation (Source: INSPIRE).

Requirements for packages

IdentifierDescriptions
req-xsd-pkg-targetNamespaceThe tagged value targetNamespace must be set, if the package is an application schema. If the tagged value is missing a default value will be used.
req-xsd-pkg-xmlnsThe tagged value xmlns must be set, if the package is an application schema.
rec-xsd-pkg-versionThe tagged value version should be set, if if the package is an application schema. If the tagged value is missing a default value will be used.
req-xsd-pkg-xsdDocumentThe tagged value xsdDocument must be set, if the package is an application schema. If the tagged value is missing a name will still be constructed from the package name.
req-xsd-pkg-dependenciesAll dependencies must be between schema packages (i.e., packages with a targetNamespace).
"req-xsd-pkg-namespace-schema-only"
The tagged values targetNamespace and xmlns may only be set, if the package is an application schema.

Requirements for classes

IdentifierDescriptions
req-xsd-cls-generalization-consistentA generalization relationship may be specified only between two classes that are either: both feature types, both object types, or both data types.
req-xsd-cls-codelist-asDictionary-trueFor code lists the tagged value asDictionary must be 'true' (Source: INSPIRE).
req-xsd-cls-codelist-extensibility-valuesFor code lists the tagged value extensibility must be empty, narrower, any (Source: INSPIRE).
req-xsd-cls-codelist-extensibility-vocabularyFor code lists the tagged value extensibility!=any implies that a vocabulary is provided (Source: INSPIRE).
req-xsd-cls-codelist-no-supertypesCode lists must have no supertypes (Source: INSPIRE?).
req-xsd-cls-datatype-noPropertyTypeFor data types the tagged value noPropertyType must be 'false' (Source: INSPIRE).
req-xsd-cls-enum-no-supertypesEnumerations must have no supertypes (Source: INSPIRE).
req-xsd-cls-objecttype-byValuePropertyTypeFor types with identity the tagged value byValuePropertyType must be 'false' (Source: INSPIRE).
req-xsd-cls-objecttype-noPropertyTypeFor types with identity the tagged value noPropertyType must be 'false' (Source: INSPIRE).
req-xsd-cls-suppress-no-propertiesIf the tagged value suppress is 'true' the class must have no properties (Source: Metadata profiling).
req-xsd-cls-suppress-subtypeIf the tagged value suppress is 'true' the class must have no unsuppressed subtype (Source: Metadata profiling).
req-xsd-cls-suppress-supertypeIf the tagged value suppress is 'true' the class must have an instantiable supertype (Source: Metadata profiling).

Requirements for properties

IdentifierDescriptions
req-xsd-prop-codelist-obligationFor code lists, a tagged value obligation must exist (Source: INSPIRE).

Requirements for associations

None at the moment