PhysicalDataProduct¶
A module describing the physical storage structures of data files and the relationship of their internal objects to the logical (intellectual) description of the objects found in LogicalProduct. This describes the physical aspects of data files which may be common between one or more data files as described by physical structure of the file and the structure of data items within a record. The PhysicalDataProduct contains the critical links between the physical data store identified by a PhysicalInstance and the logical (intellectual) description of the data as found in the LogicalProduct. In addition to the standard name, label, and description, the module allows for OtherMaterial, and descriptions of PhysicalStructureSchemes and RecordLayoutSchemes in-line or by reference.
Properties¶
Name |
Type |
Description |
|
|---|---|---|---|
PhysicalDataProductName |
0..n |
A name for the PhysicalDataProduct module. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems. |
|
Label |
0..n |
A display label for the PhysicalDataProduct module. Supports multiple language versions of the same content as well as optional formatting of the content. Repeat for labels with different content, for example, labels with differing length limitations. |
|
Description |
0..1 |
A description of the PhysicalDataProduct module. Supports multiple language versions of the same content as well as optional formatting of the content. |
|
PhysicalStructureSchemeReference |
0..n |
A scheme containing a set of PhysicalStructures containing descriptions of overall structure of a physical data storage format. These descriptions provide the primary link to the LogicalRecord found in the data file, general structural information such as use of proprietary storage structures, division of logical records into physical segment, and default values for decimal separators, etc. Each description can apply to one or more data files containing the same logical records in the same overall structure. |
|
RecordLayoutSchemeReference |
0..n |
A scheme containing a set of RecordLayouts describing the location of individual data items within the physical record and how to address them (locate and retrieve). RecordLayouts provide a link to the PhysicalStructure description and to individual variables or NCubes describing the data items. |
Properties Inherited from Maintainable¶
Name |
Type |
Description |
|
|---|---|---|---|
Note |
0..n |
Note allows for the attachment of a piece of additional information to any object with an ID. Note facilitates capturing temporary processing notes such as “Review and approval required”. A single note can be attached to multiple objects by reference to the objects. Note may also contain content for a needed object that has been reported for addition in a later version of the schema. Ideally this should be handled by a local extension, but Note can accommodate run-time extensions when required. The Note should be housed within the Maintainable object that contains the referenced objects. In this way the user is ensured of receiving all known Note attachments when the maintainable content is delivered. This means that if a Note references objects within multiple Maintainable objects, the Note should be repeated in each Maintainable and reference only those objects with that Maintainable. |
|
Software |
0..n |
Indicate the software used to create and/or manage the metadata. This is repeatable to allow for multiple softwares or multiple functions. If this information is important it is advisable to provide it in each maintainable so that it does not become separated from the internal content if the metadata is re-factored. |
|
MetadataQuality |
0..n |
An assessment of the quality of the metadata within the Maintainable object, e.g. the quality of the transcription, completeness, editing status, etc. |
|
ExternalReferenceDefaultURI |
anyURI |
0..1 |
Use to provide a default value for the URI of external references. Use of a URI in a reference within this maintainable overrides the value entered here. Nested maintainables should redeclare the contents of this attribute for clarity. |
Lang |
language |
0..1 |
This is used to designate the language of the metadata content of the maintainable. If a lower level xml:lang attribute conflicts with the content at the maintainable level, the object level value takes precedence. |
Properties Inherited from Versionable¶
Name |
Type |
Description |
|
|---|---|---|---|
URN |
string |
1..1 |
|
Agency |
string |
1..1 |
|
ID |
string |
1..1 |
|
Version |
string |
1..1 |
|
UserID |
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 |
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. |
|
VersionResponsibility |
string |
0..1 |
Person or organization within the MaintenanceAgency responsible for the version change. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, it may be included in this notation. This is primarily intended for internal use. |
VersionResponsibilityReference |
0..1 |
Reference person or organization within the MaintenanceAgency responsible for the version change, as described in an OrganizationScheme. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, a Relation should be created between the individual referenced here and his/her organization. This is primarily intended for internal use. |
|
VersionRationale |
0..1 |
Textual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system. Note that versioning can only take place on objects owned by the specified DDI Agency. If you are creating a local instance of an object from another agency for current or future modification use BasedOnObject. If the changes being made result in what you determine to be new object rather than a version of a previous object, i.e. the change is too extensive to consider it a version of the existing object, create a new object and use BasedOnObject to provide a link to the object or objects that were a basis for the new object. |
|
BasedOnObject |
0..1 |
Use when creating an object that is based on an existing object or objects that are managed by a different agency or when the new object is NOT simply a version change but you wish to maintain a reference to the object that served as a basis for the new object. BasedOnObject may contain references to any number of objects which serve as a basis for this object, a BasedOnRationalDescription of how the content of the referenced object was incorporated or altered, and a BasedOnRationalCode to allow for specific typing of the BasedOnReference according to an external controlled vocabulary. |
|
RelatedOtherMaterialReference |
0..n |
The inclusion of an existing OtherMaterial by reference. Use for any type of OtherMaterial not specifically addressed by an inline description for such as ExternalAid in QuestionItem. |
|
VersionDate |
cogsDate |
0..1 |
Date of version using the union set BaseDateType. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser. |
IsPublished |
boolean |
0..1 |
Indicates that the maintainable will not be changed without versioning, and is a stable target for referencing. |
Item Type Hierarchy¶
- Versionable
- Maintainable
PhysicalDataProduct
