Showing:

Annotations
Attributes
Diagrams
Instances
Model
Properties
Source
Used by
Included schema dictionary.xsd
Namespace http://www.opengis.net/gml/3.2
Annotations
See ISO/DIS 19136 Clause 16.
Many applications require definitions of terms which are used within instance documents as the values of certain properties or as reference information to tie properties to standard information values in some way.  Units of measure and descriptions of measurable phenomena are two particular examples. 
It will often be convenient to use definitions provided by external authorities. These may already be packaged for delivery in various ways, both online and offline. In order that they may be referred to from GML documents it is generally necessary that a URI be available for each definition. Where this is the case then it is usually preferable to refer to these directly. 
Alternatively, it may be convenient or necessary to capture definitions in XML, either embedded within an instance document containing features or as a separate document. The definitions may be transcriptions from an external source, or may be new definitions for a local purpose. In order to support this case, some simple components are provided in GML in the form of 
-	a generic gml:Definition, which may serve as the basis for more specialized definitions
-	a generic gml:Dictionary, which allows a set of definitions or references to definitions to be collected 
These components may be used directly, but also serve as the basis for more specialised definition elements in GML, in particular: coordinate operations, coordinate reference systems, datums, temporal reference systems, and units of measure.  
Note that the GML definition and dictionary components implement a simple nested hierarchy of definitions with identifiers. The latter provide handles which may be used in the description of more complex relationships between terms. However, the GML dictionary components are not intended to provide direct support for complex taxonomies, ontologies or thesauri.  Specialised XML tools are available to satisfy the more sophisticated requirements.

GML is an OGC Standard.
Copyright (c) 2007, 2010, 2016, 2018 Open Geospatial Consortium.
To obtain additional rights of use, visit http://www.opengeospatial.org/legal/ .
Properties
attribute form default unqualified
element form default qualified
version 3.2.2
Element gml:remarks
Namespace http://www.opengis.net/gml/3.2
Diagram
Diagram
Type string
Properties
content simple
Used by
Complex Types gml:AbstractCRSType, gml:AbstractCoordinateOperationType, gml:AbstractCoordinateSystemType, gml:AbstractDatumType, gml:AbstractGeneralConversionType, gml:AbstractGeneralDerivedCRSType, gml:AbstractGeneralOperationParameterType, gml:AbstractGeneralTransformationType, gml:AffineCSType, gml:BaseUnitType, gml:CartesianCSType, gml:CompoundCRSType, gml:ConcatenatedOperationType, gml:ConventionalUnitType, gml:ConversionType, gml:CoordinateSystemAxisType, gml:CylindricalCSType, gml:DefinitionProxyType, gml:DefinitionType, gml:DerivedCRSType, gml:DerivedUnitType, gml:DictionaryType, gml:EllipsoidType, gml:EllipsoidalCSType, gml:EngineeringCRSType, gml:EngineeringDatumType, gml:GeocentricCRSType, gml:GeodeticCRSType, gml:GeodeticDatumType, gml:GeographicCRSType, gml:IdentifiedObjectType, gml:ImageCRSType, gml:ImageDatumType, gml:LinearCSType, gml:ObliqueCartesianCSType, gml:OperationMethodType, gml:OperationParameterGroupType, gml:OperationParameterType, gml:PassThroughOperationType, gml:PolarCSType, gml:PrimeMeridianType, gml:ProjectedCRSType, gml:SphericalCSType, gml:TemporalCRSType, gml:TemporalCSType, gml:TemporalDatumBaseType, gml:TemporalDatumType, gml:TimeCSType, gml:TimeCalendarEraType, gml:TimeCalendarType, gml:TimeClockType, gml:TimeCoordinateSystemType, gml:TimeOrdinalEraType, gml:TimeOrdinalReferenceSystemType, gml:TimeReferenceSystemType, gml:TransformationType, gml:UnitDefinitionType, gml:UserDefinedCSType, gml:VerticalCRSType, gml:VerticalCSType, gml:VerticalDatumType
Source
<element name="remarks" type="string"/>
Element gml:Definition
Namespace http://www.opengis.net/gml/3.2
Annotations
The basic gml:Definition element specifies a definition, which can be included in or referenced by a dictionary. 
The content model for a generic definition is a derivation from gml:AbstractGMLType.  
The gml:description property element shall hold the definition if this can be captured in a simple text string, or the gml:descriptionReference property element may carry a link to a description elsewhere.
The gml:identifier element shall provide one identifier identifying this definition. The identifier shall be unique within the dictionaries using this definition. 
The gml:name elements shall provide zero or more terms and synonyms for which this is the definition.
The gml:remarks element shall be used to hold additional textual information that is not conceptually part of the definition but is useful in understanding the definition.
Diagram
DiagramgmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#namegmlBase_xsd.tmp#StandardObjectPropertiesgmlBase_xsd.tmp#AbstractGMLTypegmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#namedictionary_xsd.tmp#DefinitionBaseTypedictionary_xsd.tmp#remarksdictionary_xsd.tmp#DefinitionTypereferenceSystems_xsd.tmp#AbstractCRScoordinateOperations_xsd.tmp#AbstractCoordinateOperationcoordinateSystems_xsd.tmp#AbstractCoordinateSystemdatums_xsd.tmp#AbstractDatumcoordinateOperations_xsd.tmp#AbstractGeneralOperationParametercoordinateSystems_xsd.tmp#CoordinateSystemAxisdeprecatedTypes_xsd.tmp#DefinitionCollectiondeprecatedTypes_xsd.tmp#DefinitionProxydictionary_xsd.tmp#Dictionarydatums_xsd.tmp#EllipsoidcoordinateOperations_xsd.tmp#OperationMethoddatums_xsd.tmp#PrimeMeridiantemporalReferenceSystems_xsd.tmp#TimeReferenceSystemunits_xsd.tmp#UnitDefinitiongmlBase_xsd.tmp#AbstractGML
Type gml:DefinitionType
Type hierarchy
Properties
content complex
Substitution Group
Substitution Group Affiliation
Used by
Model
Children gml:description, gml:descriptionReference, gml:identifier, gml:metaDataProperty, gml:name, gml:remarks
Instance
<gml:Definition gml:id="" xmlns:gml="http://www.opengis.net/gml/3.2">
  <gml:metaDataProperty about="" xlink:actuate="" xlink:arcrole="" xlink:href="" nilReason="" gml:remoteSchema="" xlink:role="" xlink:show="" xlink:title="" xlink:type="simple">{0,unbounded}</gml:metaDataProperty>
  <gml:description xlink:actuate="" xlink:arcrole="" xlink:href="" nilReason="" gml:remoteSchema="" xlink:role="" xlink:show="" xlink:title="" xlink:type="simple">{0,1}</gml:description>
  <gml:descriptionReference xlink:actuate="" xlink:arcrole="" xlink:href="" nilReason="" owns="false" gml:remoteSchema="" xlink:role="" xlink:show="" xlink:title="" xlink:type="simple">{0,1}</gml:descriptionReference>
  <gml:identifier codeSpace="">{1,1}</gml:identifier>
  <gml:name codeSpace="">{0,unbounded}</gml:name>
  <gml:remarks>{0,1}</gml:remarks>
</gml:Definition>
Attributes
QName Type Use Annotation
gml:id ID required
The attribute gml:id supports provision of a handle for the XML element representing a GML Object. Its use is mandatory for all GML objects. It is of XML type ID, so is constrained to be unique in the XML document within which it occurs.
Source
<element name="Definition" type="gml:DefinitionType" substitutionGroup="gml:AbstractGML">
  <annotation>
    <documentation>The basic gml:Definition element specifies a definition, which can be included in or referenced by a dictionary. The content model for a generic definition is a derivation from gml:AbstractGMLType. The gml:description property element shall hold the definition if this can be captured in a simple text string, or the gml:descriptionReference property element may carry a link to a description elsewhere. The gml:identifier element shall provide one identifier identifying this definition. The identifier shall be unique within the dictionaries using this definition. The gml:name elements shall provide zero or more terms and synonyms for which this is the definition. The gml:remarks element shall be used to hold additional textual information that is not conceptually part of the definition but is useful in understanding the definition.</documentation>
  </annotation>
</element>
Element gml:Dictionary
Namespace http://www.opengis.net/gml/3.2
Annotations
Sets of definitions may be collected into dictionaries or collections.
A gml:Dictionary is a non-abstract collection of definitions.
The gml:Dictionary content model adds a list of gml:dictionaryEntry properties that contain or reference gml:Definition objects.  A database handle (gml:id attribute) is required, in order that this collection may be referred to. The standard gml:identifier, gml:description, gml:descriptionReference and gml:name properties are available to reference or contain more information about this dictionary. The gml:description and gml:descriptionReference property elements may be used for a description of this dictionary. The derived gml:name element may be used for the name(s) of this dictionary. for remote definiton references gml:dictionaryEntry shall be used. If a Definition object contained within a Dictionary uses the descriptionReference property to refer to a remote definition, then this enables the inclusion of a remote definition in a local dictionary, giving a handle and identifier in the context of the local dictionary.
Diagram
DiagramgmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#namegmlBase_xsd.tmp#StandardObjectPropertiesgmlBase_xsd.tmp#AbstractGMLTypegmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#namedictionary_xsd.tmp#DefinitionBaseTypedictionary_xsd.tmp#remarksdictionary_xsd.tmp#DefinitionTypegmlBase_xsd.tmp#AggregationAttributeGroupdictionary_xsd.tmp#dictionaryEntrydeprecatedTypes_xsd.tmp#indirectEntrydictionary_xsd.tmp#DictionaryTypedictionary_xsd.tmp#Definition
Type gml:DictionaryType
Type hierarchy
Properties
content complex
Substitution Group Affiliation
Model
Children gml:description, gml:descriptionReference, gml:dictionaryEntry, gml:identifier, gml:indirectEntry, gml:metaDataProperty, gml:name, gml:remarks
Instance
<gml:Dictionary aggregationType="" gml:id="" xmlns:gml="http://www.opengis.net/gml/3.2">
  <gml:metaDataProperty about="" xlink:actuate="" xlink:arcrole="" xlink:href="" nilReason="" gml:remoteSchema="" xlink:role="" xlink:show="" xlink:title="" xlink:type="simple">{0,unbounded}</gml:metaDataProperty>
  <gml:description xlink:actuate="" xlink:arcrole="" xlink:href="" nilReason="" gml:remoteSchema="" xlink:role="" xlink:show="" xlink:title="" xlink:type="simple">{0,1}</gml:description>
  <gml:descriptionReference xlink:actuate="" xlink:arcrole="" xlink:href="" nilReason="" owns="false" gml:remoteSchema="" xlink:role="" xlink:show="" xlink:title="" xlink:type="simple">{0,1}</gml:descriptionReference>
  <gml:identifier codeSpace="">{1,1}</gml:identifier>
  <gml:name codeSpace="">{0,unbounded}</gml:name>
  <gml:remarks>{0,1}</gml:remarks>
  <gml:dictionaryEntry xlink:actuate="" xlink:arcrole="" xlink:href="" nilReason="" owns="false" gml:remoteSchema="" xlink:role="" xlink:show="" xlink:title="" xlink:type="simple">{1,1}</gml:dictionaryEntry>
  <gml:indirectEntry>{1,1}</gml:indirectEntry>
</gml:Dictionary>
Attributes
QName Type Use Annotation
aggregationType gml:AggregationType optional
gml:id ID required
The attribute gml:id supports provision of a handle for the XML element representing a GML Object. Its use is mandatory for all GML objects. It is of XML type ID, so is constrained to be unique in the XML document within which it occurs.
Source
<element name="Dictionary" type="gml:DictionaryType" substitutionGroup="gml:Definition">
  <annotation>
    <documentation>Sets of definitions may be collected into dictionaries or collections. A gml:Dictionary is a non-abstract collection of definitions. The gml:Dictionary content model adds a list of gml:dictionaryEntry properties that contain or reference gml:Definition objects. A database handle (gml:id attribute) is required, in order that this collection may be referred to. The standard gml:identifier, gml:description, gml:descriptionReference and gml:name properties are available to reference or contain more information about this dictionary. The gml:description and gml:descriptionReference property elements may be used for a description of this dictionary. The derived gml:name element may be used for the name(s) of this dictionary. for remote definiton references gml:dictionaryEntry shall be used. If a Definition object contained within a Dictionary uses the descriptionReference property to refer to a remote definition, then this enables the inclusion of a remote definition in a local dictionary, giving a handle and identifier in the context of the local dictionary.</documentation>
  </annotation>
</element>
Element gml:dictionaryEntry
Namespace http://www.opengis.net/gml/3.2
Annotations
This property element contains or refers to the definitions which are members of a dictionary. 
The content model follows the standard GML property pattern, so a gml:dictionaryEntry may either contain or refer to a single gml:Definition. Since gml:Dictionary is substitutable for gml:Definition, the content of an entry may itself be a lower level dictionary. 
Note that if the value is provided by reference, this definition does not carry a handle (gml:id) in this context, so does not allow external references to this specific definition in this context.  When used in this way the referenced definition will usually be in a dictionary in the same XML document.
Diagram
DiagramgmlBase_xsd.tmp#OwnershipAttributeGroupgmlBase_xsd.tmp#AbstractMemberTypegmlBase_xsd.tmp#AssociationAttributeGroupdictionary_xsd.tmp#Definitiondictionary_xsd.tmp#DictionaryEntryTypedeprecatedTypes_xsd.tmp#definitionMember
Type gml:DictionaryEntryType
Type hierarchy
Properties
content complex
Substitution Group
Used by
Complex Type gml:DictionaryType
Model
Children gml:Definition
Instance
<gml:dictionaryEntry xlink:actuate="" xlink:arcrole="" xlink:href="" nilReason="" owns="false" gml:remoteSchema="" xlink:role="" xlink:show="" xlink:title="" xlink:type="simple" xmlns:gml="http://www.opengis.net/gml/3.2">
  <gml:Definition gml:id="">{1,1}</gml:Definition>
</gml:dictionaryEntry>
Attributes
QName Type Fixed Default Use
gml:remoteSchema anyURI optional
nilReason gml:NilReasonType optional
owns boolean false optional
xlink:actuate xlink:actuateType optional
xlink:arcrole xlink:arcroleType optional
xlink:href xlink:hrefType optional
xlink:role xlink:roleType optional
xlink:show xlink:showType optional
xlink:title xlink:titleAttrType optional
xlink:type xlink:typeType simple optional
Source
<element name="dictionaryEntry" type="gml:DictionaryEntryType">
  <annotation>
    <documentation>This property element contains or refers to the definitions which are members of a dictionary. The content model follows the standard GML property pattern, so a gml:dictionaryEntry may either contain or refer to a single gml:Definition. Since gml:Dictionary is substitutable for gml:Definition, the content of an entry may itself be a lower level dictionary. Note that if the value is provided by reference, this definition does not carry a handle (gml:id) in this context, so does not allow external references to this specific definition in this context. When used in this way the referenced definition will usually be in a dictionary in the same XML document.</documentation>
  </annotation>
</element>
Complex Type gml:DefinitionType
Namespace http://www.opengis.net/gml/3.2
Diagram
DiagramgmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#namegmlBase_xsd.tmp#StandardObjectPropertiesgmlBase_xsd.tmp#AbstractGMLTypegmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#namedictionary_xsd.tmp#DefinitionBaseTypedictionary_xsd.tmp#remarks
Type extension of gml:DefinitionBaseType
Type hierarchy
Used by
Model
Children gml:description, gml:descriptionReference, gml:identifier, gml:metaDataProperty, gml:name, gml:remarks
Attributes
QName Type Use Annotation
gml:id ID required
The attribute gml:id supports provision of a handle for the XML element representing a GML Object. Its use is mandatory for all GML objects. It is of XML type ID, so is constrained to be unique in the XML document within which it occurs.
Source
<complexType name="DefinitionType">
  <complexContent>
    <extension base="gml:DefinitionBaseType">
      <sequence>
        <element ref="gml:remarks" minOccurs="0"/>
      </sequence>
    </extension>
  </complexContent>
</complexType>
Complex Type gml:DefinitionBaseType
Namespace http://www.opengis.net/gml/3.2
Diagram
DiagramgmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#namegmlBase_xsd.tmp#StandardObjectPropertiesgmlBase_xsd.tmp#AbstractGMLTypegmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#name
Type restriction of gml:AbstractGMLType
Type hierarchy
Used by
Complex Type gml:DefinitionType
Model
Children gml:description, gml:descriptionReference, gml:identifier, gml:metaDataProperty, gml:name
Attributes
QName Type Use Annotation
gml:id ID required
The attribute gml:id supports provision of a handle for the XML element representing a GML Object. Its use is mandatory for all GML objects. It is of XML type ID, so is constrained to be unique in the XML document within which it occurs.
Source
<complexType name="DefinitionBaseType">
  <complexContent>
    <restriction base="gml:AbstractGMLType">
      <sequence>
        <element ref="gml:metaDataProperty" minOccurs="0" maxOccurs="unbounded"/>
        <element ref="gml:description" minOccurs="0"/>
        <element ref="gml:descriptionReference" minOccurs="0"/>
        <element ref="gml:identifier"/>
        <element ref="gml:name" minOccurs="0" maxOccurs="unbounded"/>
      </sequence>
      <attribute ref="gml:id" use="required"/>
    </restriction>
  </complexContent>
</complexType>
Complex Type gml:DictionaryType
Namespace http://www.opengis.net/gml/3.2
Diagram
DiagramgmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#namegmlBase_xsd.tmp#StandardObjectPropertiesgmlBase_xsd.tmp#AbstractGMLTypegmlBase_xsd.tmp#iddeprecatedTypes_xsd.tmp#metaDataPropertygmlBase_xsd.tmp#descriptiongmlBase_xsd.tmp#descriptionReferencegmlBase_xsd.tmp#identifiergmlBase_xsd.tmp#namedictionary_xsd.tmp#DefinitionBaseTypedictionary_xsd.tmp#remarksdictionary_xsd.tmp#DefinitionTypegmlBase_xsd.tmp#AggregationAttributeGroupdictionary_xsd.tmp#dictionaryEntrydeprecatedTypes_xsd.tmp#indirectEntry
Type extension of gml:DefinitionType
Type hierarchy
Used by
Model
Children gml:description, gml:descriptionReference, gml:dictionaryEntry, gml:identifier, gml:indirectEntry, gml:metaDataProperty, gml:name, gml:remarks
Attributes
QName Type Use Annotation
aggregationType gml:AggregationType optional
gml:id ID required
The attribute gml:id supports provision of a handle for the XML element representing a GML Object. Its use is mandatory for all GML objects. It is of XML type ID, so is constrained to be unique in the XML document within which it occurs.
Source
<complexType name="DictionaryType">
  <complexContent>
    <extension base="gml:DefinitionType">
      <choice minOccurs="0" maxOccurs="unbounded">
        <element ref="gml:dictionaryEntry"/>
        <element ref="gml:indirectEntry"/>
      </choice>
      <attributeGroup ref="gml:AggregationAttributeGroup"/>
    </extension>
  </complexContent>
</complexType>
Complex Type gml:DictionaryEntryType
Namespace http://www.opengis.net/gml/3.2
Diagram
DiagramgmlBase_xsd.tmp#OwnershipAttributeGroupgmlBase_xsd.tmp#AbstractMemberTypegmlBase_xsd.tmp#AssociationAttributeGroupdictionary_xsd.tmp#Definition
Type extension of gml:AbstractMemberType
Type hierarchy
Used by
Model
Children gml:Definition
Attributes
QName Type Fixed Default Use
gml:remoteSchema anyURI optional
nilReason gml:NilReasonType optional
owns boolean false optional
xlink:actuate xlink:actuateType optional
xlink:arcrole xlink:arcroleType optional
xlink:href xlink:hrefType optional
xlink:role xlink:roleType optional
xlink:show xlink:showType optional
xlink:title xlink:titleAttrType optional
xlink:type xlink:typeType simple optional
Source
<complexType name="DictionaryEntryType">
  <complexContent>
    <extension base="gml:AbstractMemberType">
      <sequence minOccurs="0">
        <element ref="gml:Definition"/>
      </sequence>
      <attributeGroup ref="gml:AssociationAttributeGroup"/>
    </extension>
  </complexContent>
</complexType>