PhysicalRecordSegmentType

A description of the physical record segment as found in the data store. A logical record may be stored in one or more segments housed hierarchically in a single file or in separate data files. All logical records have at least one segment. Identifies the Key variable identifying the segment if the identifier exists in the record, a file name identifier if the segment identification is expressed as part of the file name (used when each segment is stored in a separate file), the order of this segment in relation to other physical segments as part of the logical record, and a flag indicating whether or not the physical segment contains a key.

Properties

Name

Type

Description

KeyVariableReference

Variable

0..1

Reference to the Unique key variable for segment identification.

KeyVariableValue

ValueType

0..1

Value of the variable for this segment.

FileNameIdentification

string

0..1

If the file containing this segment has a standard section of its file name, include it here. For example a segment number. For example, in the files 2000SF10001.csv and 2000SF10002.csv the last 4 digits contain the segment number. There is no standard means of specifying this information in a machine-actionable way. This statement is informational but in some legacy files may be the only location where the segment identification is found.

SegmentOrder

nonNegativeInteger

0..1

Indicates the position of this physical record segment within the logical record expressed as an integer.

HasSegmentKey

boolean

0..1

Set to true if there is a variable identifying the segment order. If true a segment key should be declared in a KeyVariableReference. Set to false if there are multiple segments and the identification of a particular segment is based on the order of the records within the file.

Properties Inherited from IdentifiableType

Name

Type

Description

URN

string

1..1

The URN of the entity matching the DDI URN pattern associated with the value of the attribute typeOfIdentifier (Canonical or Deprecated).

Agency

string

1..1

This is the registered agency code with optional sub-agencies separated by dots.

ID

string

1..1

The ID of the object. This must conform to the allowed structure of the DDI Identifier and must be unique within the declared scope of uniqueness (Agency or Maintainable).

Version

string

1..1

The version number of the object. For the identifiable object this is the version number of its parent versionable at the point of creation or alteration of the non-administrative metadata of the identifiable. Versionable and Maintainable items increment their version number whenever the non-administrative metadata contained by the object changes.

UserID

UserIDType

0..n

Allows for the specification of identifiers other than the specified DDI identification of the object. This may be a legacy ID from DDI-C, a system specific ID such as for a database or registry, or a non-DDI unique identifier. As the identifier is specific to a system the system must be identified with the UserID structure.

UserAttributePair

StandardKeyValuePairType

0..n

A system specific user defined property of the object expressed as a key/value pair. As this is specific to an individual system the use of controlled vocabularies for the key is strongly recommended.

Item Type Hierarchy

Relationships

The following identified item types reference this type.

stub