ddi:physicaldataproduct_ncube_inline:3_0

Global Elements

RecordLayout (RecordLayoutType): [substitution: p:BaseRecordLayout]

Dimension (DimensionType):

MeasureReference (MeasureReferenceType):

NCubeInstance (NCubeInstanceType): Container to group data from common NCubes - this allows for NCube level attributes to be defined

DataItem (DataItemType): Identifies a physical storage location for an individual data entry, serving as a link between the physical location and the logical content description of each data item. Note that only one data item is described here, since the structure describes all data and meta data for the NCube. That is to day that in this desciption, each row of data in the referenced file corresponds to the same NCube of data.

NCubeReference (r:ReferenceType): Reference to the logical NCube description.

Attribute (AttributeType): Component to provide cell level attribute values.

Measure (MeasureType): When individual measures are stored in separately identifiable locations repeat Measure to define each measure and storage location. When multiple measures are stored as an ordered array in a single location list each measure in the array as a MeasureReference with its specified arrayOrder within a single Measure definition.

VariableReference (r:ReferenceType): The variable ID where the coordinate value is found (for files where one of the dimensions of the matrix has a different record for each category and the value of the category is found in a specific variable, e.g., SIC codes in US County Business Patterns).

AttributeReference (r:ReferenceType): Reference to attribute description.

Complex Types

RecordLayoutType: Describes the layout of an NCube data structure.

• Content:
  • Extends: p:BaseRecordLayoutType
  • Base Content
    • Extends: r:IdentifiableType
    • Base Content
      • Extends: AbstractIdentifiableType
      • Base Content
        • Sequence of:
          • [Reference] (Name) - min. 0 - max. unbounded
            • Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
      • Base Attributes
        • id (BaseIDType) - required
          • Assigned ID, unique within its maintainable object.
        • urn (xs:anyURI) - optional
          • DDI-structured URN of the element as described in Part I of the Technical Documentation.
        • action (ActionCodeType) - optional
          • Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
      • Extended Attributes
        • isIdentifiable (xs:boolean) - fixed: true
    • Extended Content
      • Sequence of:
        • [Reference] (PhysicalStructureReference)
        • CharacterSet (r:CodeValueType)
          • Character set used in the data file (e.g., US ASCII, EBCDIC, UTF-8). This is a required field. If the character set is not known, for example for some proprietary data files, enter "unspecified".
        • ArrayBase (xs:integer)
          • Sets the array base for any arrays used in the definition (that is, whether the first value is in position 0 or 1, etc.). This may be the data array in a delimited data file or the measure array for measures that are bundled and stored in a single location. Array base is generally set to either 0 or 1. There is no override provided as systems processing a record would use a consistent array base.
  • Extended Content
    • Sequence of:
      • [Reference] (NCubeInstance) - max. unbounded
        • A container for defining an instance of an NCube, which allows specifying the values of the attributes attached to a NCube.

NCubeInstanceType: A container for defining an instance of an NCube, which allows specifying the values of the attributes attached to a NCube.

• Content:
  • Extends: r:VersionableType
  • Base Content
    • Extends: AbstractVersionableType
    • Base Content
      • Extends: AbstractIdentifiableType
      • Base Content
        • Sequence of:
          • [Reference] (Name) - min. 0 - max. unbounded
            • Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
      • Extended Content
        • Sequence of:
          • VersionResponsibility (xs:string) - min. 0
            • Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
          • [Reference] (VersionRationale) - min. 0 - max. unbounded
            • Textual description of the rationale/purpose for a version change.
      • Base Attributes
        • id (BaseIDType) - required
          • Assigned ID, unique within its maintainable object.
        • urn (xs:anyURI) - optional
          • DDI-structured URN of the element as described in Part I of the Technical Documentation.
        • action (ActionCodeType) - optional
          • Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
      • Extended Attributes
        • version (NewVersionType) - optional
          • Restricted string - numeric with optional decimal points.
        • versionDate (BaseDateType) - optional
          • Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
    • Extended Attributes
      • isVersionable (xs:boolean) - fixed: true
  • Extended Content
    • Sequence of:
      • [Reference] (NCubeReference)
        • Reference to the logical NCube description.
      • [Reference] (Attribute) - min. 0 - max. unbounded
        • This is an attribute attached to the NCube as a whole or a region of the NCube as defined in the logical description. The content of the attribute can be provided as a single value or reference a location in the data store where the attribute value will be found.
      • [Reference] (DataItem) - max. unbounded
        • Identifies a physical storage location for an individual data entry, serving as a link between the physical location and the logical content description of each data item. Note that only one data item is described here, since the structure describes all data and meta data for the NCube. That is to day that in this desciption, each row of data in the referenced file corresponds to the same NCube of data.
      • DefaultDataType (xs:string) - min. 0
        • An explicit definition of the data type that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. This field is necessary in the case of some numeric data formats where the format definition would allow real values, but the values are integer values. Allowed values are: integer (default), real, string.
      • DefaultDelimiter (xs:string) - min. 0
        • Delimiter definition for delimited (free field) data that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. Allowed values are: Empty (default), Tab, Blank, AnyString. If a delimiter is used, free field (delimited data) is assumed; binary formats are not allowed.
      • DefaultDecimalPositions (xs:integer) - min. 0
        • Number of decimal places for data with an implied decimal separator that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. Another expression is the decimal scaling factor (SAS). Default: 0.
      • [Reference] (r:DefaultDecimalSeparator) - min. 0
        • The character used to separate the integer and the fraction part of a number (if an explicit separator is used in the data) that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. Allowed values are: None (default), Dot, Comma, Other. On the basis of the data definition in DDI documents, data processing tools could compute the necessary precision width on the basis of the format width and the existence of separators. Appropriate data types could be used, i.e. float or double, short or long. The decimal separator definition only makes sense with some XML Schema primitives. This is a default which may be overridden in specific cases.
      • [Reference] (r:DefaultDigitGroupSeparator) - min. 0
        • The character used to separate groups of digits (if an explicit separator is used in the data) that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. Allowed values are: None (default), Dot, Comma, Other. The decimal separator definition makes only sense with some XML Schema primitives. This is a default which may be overridden in specific cases.

DataItemType: Identifies a physical storage location for an individual data entry, serving as a link between the physical location and the logical content description of each data item.

• Content:
  • Sequence of:
    • [Reference] (Dimension) - max. unbounded
      • Specifies this coordinate in the standard matrix descriptive pattern (1,2,3,.n)
    • [Reference] (Attribute) - min. 0 - max. unbounded
      • This is an attribute which is attached to the specified DataItem. The content of the attribute can be provided as a single value or reference a location in the data store where the attribute value will be found.
    • [Reference] (Measure) - max. unbounded
      • Value of the measure type
• Attributes:
  • [Reference] (xml:lang) - optional

DimensionType: A dimension describes the rank or order of the dimension within the NCube structure and provides the specific coordinate value of the dimension for the data item.

• Content:
  • Sequence of:
    • [Reference] (VariableReference) - min. 0
      • References the Variable holding the dimension value. Use this instead of the value attribute when the value must be obtained from the data file at the location of the variable indicated in the reference.
• Attributes:
  • rank (xs:integer) - required
    • Enter the rank (placement) order in which the value from this dimension appears in the coordinate address of any cell in the NCube matrix.
  • value (xs:string) - optional
    • The value of this dimension for this particular data item.

MeasureType: When individual measures are stored in separately identifiable locations repeat Measure to define each measure and storage location. When multiple measures are stored as an ordered array in a single location list each measure in the array as a MeasureReference with its specified arrayOrder within a single Measure definition.

• Content:
  • Sequence of:
    • [Reference] (MeasureReference) - max. unbounded
      • Reference to the measure description.
    • Value (xs:string)
      • Value of the attribute.

MeasureReferenceType: Reference to measure description.

• Content:
  • Extends: r:ReferenceType
  • Base Content
    • Sequence of:
      • [Reference] (Module) - min. 0
        • References the module of the entity that is being referenced, in cases where there have been local modifications.
      • [Reference] (Scheme) - min. 0
        • Containing scheme of the entity that is being referenced.
      • Choice Of: - max. 2
        • [Reference] (URN)
          • URN of the entity that is being referenced.
        • Sequence of:
          • [Reference] (ID)
            • ID of the entity that is being referenced.
          • IdentifyingAgency (xs:NCName) - min. 0
            • Maintaining agency as described in Part 1 of the Technical Specification.
          • [Reference] (Version) - min. 0
            • If referencing a versioned or maintained element you must include Version. The version can be identified as lateBound, meaning that the latest version should be used.
  • Base Attributes
    • isExternal (xs:boolean) - default: false
      • Indicates that the reference is made to an external source. If the value is true, then a URI must be provided.
    • URI (xs:anyURI) - optional
      • URI identifying the location of an external reference.
    • isReference (xs:boolean) - fixed: true
      • A fixed attribute value identifying which elements are references.
    • lateBound (xs:boolean) - default: false
  • Extended Attributes
    • arrayOrder (xs:integer) - default: 0
      • Oder within the array. Note that this attribute assumes an array base of 0. The array order assumes that the measures will always be displayed in the same order and that sparse content (a missing value in the array) will be clear between two delimiters in this array. For example 1,1,1 or 1,,1

AttributeType: Provides for a choice between an explicit value, or a location in a file where the value can be found.

• Content:
  • Sequence of:
    • [Reference] (AttributeReference)
      • Reference to attribute description.
    • Value (xs:string)
      • Value of the attribute.