LocatorMapping#

Fully qualified class name of the UML model DDI-CDI 1.1beta: DDICDIModels::DDICDILibrary::Classes::FormatDescription::LocatorMapping

Definition#

The physical characteristics of an instance variable which appears in a data set using a binary or highly structured text-based encoding (a structured data set).

Diagram#

Inheritance#

Attributes#

Attributes

Attributes#
Name	Inherited from	Description	Data Type	Multiplicity	Default value
locator	- own class -	Logical expression which resolves to the value(s) whose position within the file is being described. May be a query string, a path expressions, etc. Must be meaningful in the context of the systems which are designed to operate on the type of structure of the file (i.e., an XPath expression for an XML file, SQL for relational data, etc.)	String	1..1
decimalPositions	FormatDescription::PhysicalMapping	The number of decimal positions expressed as an integer. Used when the decimal position is implied (no decimal separator is present) See DDI 3.2 ManagedNumericRepresentation_decimalPositions	Integer	0..1
defaultValue	FormatDescription::PhysicalMapping	A default string indicating the value to substitute for an empty string. From https://www.w3.org/TR/tabular-metadata/ Inherited 5.7 “default - An atomic property holding a single string that is used to create a default value for the cell in cases where the original string value is an empty string. See Parsing Cells in [tabular-data-model] for more details. If not specified, the default for the default property is the empty string, “”. The value of this property becomes the default annotation for the described column.”	String	0..1
format	FormatDescription::PhysicalMapping	This defines the format of the physical representation of the value. From https://www.w3.org/TR/tabular-metadata/ 5.11.2 format: “An atomic property that contains either a single string or an object that defines the format of a value of this type, used when parsing a string value as described in Parsing Cells in [tabular-data-model]. The value of this property becomes the format annotation for the described datatype.” See https://www.w3.org/TR/tabular-metadata/ Tabular 6.4.2 “Formats for numeric datatypes” this may include decimalChar, groupChar, pattern “By default, numeric values must be in the formats defined in [xmlschema11-2]. It is not uncommon for numbers within tabular data to be formatted for human consumption, which may involve using commas for decimal points, grouping digits in the number using commas, or adding percent signs to the number.” See https://www.w3.org/TR/tabular-metadata/ Tabular 6.4. Formats for Booleans “ Boolean values may be represented in many ways aside from the standard 1 and 0 or true and false.” See https://www.w3.org/TR/tabular-metadata/ 6.4.4. Formats for dates and times “By default, dates and times are assumed to be in the format defined in [xmlschema11-2]. However dates and times are commonly represented in tabular data in other formats.” See https://www.w3.org/TR/tabular-metadata/ 6.4.5 Formats for durations “Durations MUST be formatted and interpreted as defined in [xmlschema11-2], using the [ISO8601] format -?PnYnMnDTnHnMnS. For example, the duration P1Y1D is used for a year and a day; the duration PT2H30M for 2 hours and 30 minutes.” See https://www.w3.org/TR/tabular-metadata/ 6.4.6 Formats for other types “If the datatype base is not numeric, boolean, a date/time type, or a duration type, the datatype format annotation provides a regular expression for the string values, with syntax and processing defined by [ECMASCRIPT]. If the supplied value is not a valid regular expression, implementations MUST issue a warning and proceed as if no format had been provided.” From DDI3.2 ManagedNumericRepresentation@format “A format for number expressed as a string.” From DDI3.2 ManagedDateTimeRepresentation_DateFieldFormat “Describes the format of the date field, in formats such as YYYY/MM or MM-DD-YY, etc. If this element is omitted, then the format is assumed to be the XML Schema format corresponding to the type attribute value.”	ControlledVocabularyEntry	0..1
identifier	FormatDescription::PhysicalMapping	Identifier for objects requiring short- or long-lasting referencing and management.	Identifier	0..1
isRequired	FormatDescription::PhysicalMapping	If the value of this property is True indicates that a value is required for the referenced instance variable. From the W3C Recommendation “Metadata Vocabulary for Tabular Data” (https://www.w3.org/TR/tabular-metadata/) 5.7 Inherited Properties: “required: A boolean atomic property taking a single value which indicates whether the cell value can be null. See Parsing Cells in [tabular-data-model] for more details. The default is false, which means cells can have null values. The value of this property becomes the required annotation for the described column.”	Boolean	0..1	false
maximumLength	FormatDescription::PhysicalMapping	The largest possible value of the length of the physical representation of the value. From the W3C Recommendation “Metadata Vocabulary for Tabular Data” (https://www.w3.org/TR/tabular-metadata/) 5.11.2: “maxLength: A numeric atomic property that contains a single integer that is the maximum length of the value. The value of this property becomes the maximum length annotation for the described datatype. See Length Constraints in [tabular-data-model] for details.”	Integer	0..1
minimumLength	FormatDescription::PhysicalMapping	The smallest possible value for the length of the physical representation of the value. From the W3C Recommendation “Metadata Vocabulary for Tabular Data” (https://www.w3.org/TR/tabular-metadata/) 5.11.2: “minLength: An atomic property that contains a single integer that is the minimum length of the value. The value of this property becomes the minimum length annotation for the described datatype. See Length Constraints in [tabular-data-model] for details.”	Integer	0..1
nullSequence	FormatDescription::PhysicalMapping	A string indicating a null value. From the W3C Recommendation “Metadata Vocabulary for Tabular Data” (https://www.w3.org/TR/tabular-metadata/) 4.3: “null: the string or strings which cause the value of cells having string value matching any of these values to be null.” From the same source, Inherited 5.7: “null: An atomic property giving the string or strings used for null values within the data. If the string value of the cell is equal to any one of these values, the cell value is null. See Parsing Cells in [tabular-data-model] for more details. If not specified, the default for the null property is the empty string ‘’. The value of this property becomes the null annotation for the described column.”	String	0..1
numberPattern	FormatDescription::PhysicalMapping	A pattern description of the format of a numeric value. In W3C part of the datatype format From https://www.w3.org/TR/tabular-metadata/ tabular 6.4.2 pattern: “A number format pattern as defined in [UAX35] http://www.unicode.org/reports/tr35/tr35-31/tr35-numbers.html#Number_Format_Patterns. Implementations MUST recognise number format patterns containing the symbols 0, #, the specified decimalChar (or “.” if unspecified), the specified groupChar (or “,” if unspecified), E, +, % and ‰. Implementations MAY additionally recognise number format patterns containing other special pattern characters defined in [UAX35]. If the supplied value is not a string, or if it contains an invalid number format pattern or uses special pattern characters that the implementation does not recognise, implementations MUST issue a warning and proceed as if the property had not been specified. If the datatype format annotation is a single string, this is interpreted in the same way as if it were an object with a pattern property whose value is that string. If the groupChar is specified, but no pattern is supplied, when parsing the string value of a cell against this format specification, implementations MUST recognise and parse numbers that consist of: an optional + or - sign, … Implementations MAY also recognise numeric values that are in any of the standard-decimal, standard-percent or standard-scientific formats listed in the Unicode Common Locale Data Repository. …”	String	0..1
position	FormatDescription::PhysicalMapping	Position of a physical mapping in a sequence within a physical data set. It can be used instead of a physical mapping position object when the position is fixed (that means the physical mapping is not reused across physical data sets)	Integer	0..1
scale	FormatDescription::PhysicalMapping	The scale of the number expressed as an integer. A multiplier to be used in combination with the value to determine the measurement. (E.g., a number expressed in 100’s with a value of 5 and a scale of 100 would be 500).	Integer	0..1

Associations#

Associations

Associations#
Direction	Association	Description	Multiplicity of LocatorMapping	Package of Other Class	Other Class	Multiplicity of other class	Aggregation Kind	Inherited from
from	PhysicalMapping formats InstanceVariable		0..*	Conceptual	InstanceVariable	0..1	none	FormatDescription::PhysicalMapping
to	PhysicalDataSet has PhysicalMapping		0..*	- own package -	PhysicalDataSet	0..*	none	FormatDescription::PhysicalMapping
to	PhysicalMappingPosition indexes PhysicalMapping	Assigns a position to a value mapping within a physical segment.	1..1	- own package -	PhysicalMappingPosition	0..*	none	FormatDescription::PhysicalMapping

Encodings#

Syntax representations / encodings

All syntax representations except the Canonical XMI are provided as reference points for specific implementations, or for use as defaults if sufficient in the form presented.

Canonical XMI

Fragment for the class LocatorMapping (entire model as XMI)

<packagedElement xmlns:StandardProfile="http://www.omg.org/spec/UML/20131001/StandardProfile"
                  xmlns:uml="http://www.omg.org/spec/UML/20131001"
                  xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
                  xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LocatorMapping"
                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#LocatorMapping"
                  xmi:type="uml:Class">
   <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LocatorMapping-ownedComment"
                  xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#LocatorMapping-ownedComment"
                  xmi:type="uml:Comment">
      <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LocatorMapping"/>
      <body>Definition
==========
The physical characteristics of an instance variable which appears in a data set using a binary or highly structured text-based encoding (a structured data set).
</body>
   </ownedComment>
   <name>LocatorMapping</name>
   <generalization xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LocatorMapping-generalization"
                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#LocatorMapping-generalization"
                    xmi:type="uml:Generalization">
      <general xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-PhysicalMapping"/>
   </generalization>
   <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LocatorMapping-locator"
                    xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#LocatorMapping-locator"
                    xmi:type="uml:Property">
      <ownedComment xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LocatorMapping-locator-ownedComment"
                     xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#LocatorMapping-locator-ownedComment"
                     xmi:type="uml:Comment">
         <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LocatorMapping-locator"/>
         <body>Logical expression which resolves to the value(s) whose position within the file is being described. May be a query string, a path expressions, etc. Must be meaningful in the context of the systems which are designed to operate on the type of structure of the file (i.e., an XPath expression for an XML file, SQL for relational data, etc.)
</body>
      </ownedComment>
      <lowerValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LocatorMapping-locator-lowerValue"
                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#LocatorMapping-locator-lowerValue"
                   xmi:type="uml:LiteralInteger">
         <value>1</value>
      </lowerValue>
      <upperValue xmi:id="DDICDIModels-DDICDILibrary-Classes-FormatDescription-LocatorMapping-locator-upperValue"
                   xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#LocatorMapping-locator-upperValue"
                   xmi:type="uml:LiteralUnlimitedNatural">
         <value>1</value>
      </upperValue>
      <name>locator</name>
      <type href="http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#String"
             xmi:type="uml:PrimitiveType"/>
   </ownedAttribute>
</packagedElement>

XML Schema

Fragment for the class LocatorMapping (entire XML Schema)

<xs:element name="LocatorMapping"
            type="LocatorMappingXsdType"
            xml:id="LocatorMapping">
  <!-- based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::LocatorMapping -->
  <xs:annotation>
    <xs:documentation>Definition
          ==========
          The physical characteristics of an instance variable which appears in a data set using a binary or highly structured text-based encoding (a structured data set).</xs:documentation>
  </xs:annotation>
</xs:element>
<xs:complexType name="LocatorMappingXsdType"
                xml:id="LocatorMappingXsdType">
  <xs:annotation>
    <xs:documentation>Definition
          ==========
          The physical characteristics of an instance variable which appears in a data set using a binary or highly structured text-based encoding (a structured data set).</xs:documentation>
  </xs:annotation>
  <xs:complexContent>
    <xs:extension base="PhysicalMappingXsdType">
      <xs:sequence>
        <xs:element name="locator"
                    type="xs:string"
                    minOccurs="1"
                    maxOccurs="1"
                    xml:id="LocatorMapping-locator">
          <xs:annotation>
            <xs:documentation>Logical expression which resolves to the value(s) whose position within the file is being described. May be a query string, a path expressions, etc. Must be meaningful in the context of the systems which are designed to operate on the type of structure of the file (i.e., an XPath expression for an XML file, SQL for relational data, etc.)</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

JSON Schema

Fragment for the class LocatorMapping (entire JSON Schema)

"cls-LocatorMapping": {
  "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/LocatorMapping",
  "type": "object",
  "properties": {
    "@context": {
      "$ref": "#/defs/at-context"
    },
    "@id": {
      "type": "string",
      "format": "iri-reference"
    },
    "@type": {
      "const": "LocatorMapping"
    },
    "locator": {
      "$comment": "cardinality 1..1 – from cdi:LocatorMapping",
      "$ref": "#/defs/xsd:string"
    },
    "decimalPositions": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/xsd:integer"
    },
    "defaultValue": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/xsd:string"
    },
    "format": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/dt-ControlledVocabularyEntry"
    },
    "identifier": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/dt-Identifier"
    },
    "isRequired": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/xsd:boolean"
    },
    "maximumLength": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/xsd:integer"
    },
    "minimumLength": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/xsd:integer"
    },
    "nullSequence": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/xsd:string"
    },
    "numberPattern": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/xsd:string"
    },
    "position": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/xsd:integer"
    },
    "scale": {
      "$comment": "cardinality 0..1 – from cdi:PhysicalMapping",
      "$ref": "#/defs/xsd:integer"
    },
    "formats": {
      "description": "PhysicalMapping_formats_InstanceVariable",
      "$comment": "cardinality 0..1",
       "$ref": "#/defs/target-InstanceVariable"
    },
    "has_PhysicalMapping_OF_PhysicalDataSet": {
      "description": "PhysicalDataSet_has_PhysicalMapping",
      "$comment": "cardinality 0..-1",
      "anyOf": [
        {
          "$ref": "#/defs/target-PhysicalDataSet"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/defs/target-PhysicalDataSet"
          }
        }
      ]
    },
    "indexes_OF_PhysicalMappingPosition": {
      "description": "PhysicalMappingPosition_indexes_PhysicalMapping",
      "$comment": "cardinality 0..-1",
      "anyOf": [
        {
          "$ref": "#/defs/target-PhysicalMappingPosition"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/defs/target-PhysicalMappingPosition"
          }
        }
      ]
    },
    "sameAs": {
      "$ref": "#/defs/owl:sameAs"
    }
  },
  "required": ["locator","@type"],
  "additionalProperties": false
},
"target-LocatorMapping": {
  "description": "all subclasses of http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/LocatorMapping",
  "anyOf": [
    { "$ref": "#/defs/cls-LocatorMapping" },
    { "type": "string", "format": "iri-reference" }
  ]
},

Ontology (Turtle)

Fragment for the class LocatorMapping (main ontology)

# class LocatorMapping
# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::LocatorMapping
cdi:LocatorMapping
  a rdfs:Class, owl:Class, ucmis:Class;
  rdfs:label "LocatorMapping";
  rdfs:comment "Definition\n==========\nThe physical characteristics of an instance variable which appears in a data set using a binary or highly structured text-based encoding (a structured data set)."@en;
  rdfs:subClassOf cdi:PhysicalMapping;
.

cdi:LocatorMapping-locator
  a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
  rdfs:label "locator";
  rdfs:comment "Logical expression which resolves to the value(s) whose position within the file is being described. May be a query string, a path expressions, etc. Must be meaningful in the context of the systems which are designed to operate on the type of structure of the file (i.e., an XPath expression for an XML file, SQL for relational data, etc.)"@en;
  rdfs:domain cdi:LocatorMapping;
  rdfs:range xsd:string;
.

JSON-LD

Fragment for the class LocatorMapping (entire JSON-LD)

{
  "@context": [
    "PhysicalMapping.jsonld",
    {
      "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
      "xsd": "http://www.w3.org/2001/XMLSchema#",

      "locator": {
        "@id": "cdi:LocatorMapping-locator",
        "@type": "xsd:string"
      },
      
      " comment ": "tag:json-should-support-trailing-commas"
    }
  ],
  "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2026-04-15 14:38:40.",
  "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::Classes::FormatDescription::LocatorMapping"
}

SHACL

Fragment for the class LocatorMapping (entire SHACL - Shapes Constraint Language)

# class LocatorMapping
# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::LocatorMapping
<#LocatorMapping> a sh:NodeShape;
    sh:targetClass cdi:LocatorMapping;
	sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/LocatorMapping";
	sh:closed true;
	sh:ignoredProperties ( owl:sameAs );
    sh:property [
			sh:path rdf:type;
			sh:in (   cdi:LocatorMapping
			 ) ;
    ];
    # attributes
    sh:property <#LocatorMapping-locator>;
    # associations from LocatorMapping
    # associations to LocatorMapping

    # ---- superclass: PhysicalMapping
    # attributes
    sh:property <#PhysicalMapping-decimalPositions>;
    sh:property <#PhysicalMapping-defaultValue>;
    sh:property <#PhysicalMapping-format>;
    sh:property <#PhysicalMapping-identifier>;
    sh:property <#PhysicalMapping-isRequired>;
    sh:property <#PhysicalMapping-maximumLength>;
    sh:property <#PhysicalMapping-minimumLength>;
    sh:property <#PhysicalMapping-nullSequence>;
    sh:property <#PhysicalMapping-numberPattern>;
    sh:property <#PhysicalMapping-position>;
    sh:property <#PhysicalMapping-scale>;
    # associations from PhysicalMapping
    sh:property <#PhysicalMapping_formats_InstanceVariable>;
    # associations to PhysicalMapping
    sh:property <#rev_PhysicalDataSet_has_PhysicalMapping>;
    sh:property <#rev_PhysicalMappingPosition_indexes_PhysicalMapping>;





.

<#LocatorMapping-locator> a sh:PropertyShape ;
    sh:path cdi:LocatorMapping-locator;
    sh:datatype xsd:string;
    sh:minCount 1;
    sh:maxCount 1;
.

ShEx

Fragment for the class LocatorMapping (entire ShEx - Shape Expressions)

# class LocatorMapping
# based on the UML class DDICDIModels::DDICDILibrary::Classes::FormatDescription::LocatorMapping
cdi:LocatorMappingShape CLOSED {
	a [cdi:LocatorMapping];
	cdi:LocatorMapping-locator	xsd:string;
		&cdi:PhysicalMappingProperties;
	}

DDI-CDI 1.1beta UML Model Documentation

Table of Contents

LocatorMapping

Contents