Skip to end of metadata
Go to start of metadata

 

Link to Core Group page

 

Classification of object types into properties and relationships

(Proposed by Dan, Simon and Flavio)

The main criteria would be whether the object is characterizable or not. 
if it is, then it is a property.
If it is not, then it is a relationship.

An object is characterizable when it has a well defined set of attributes that describes it.

Examples:

  • Address is characterizable: attributes can be clearly specified.
  • BasedOn is not characterizable: the target object could be of any type.
Pre IASSIST sprint discussions

Core Meeting Notes Date: 2014-05-16

Attendees: Johan Fihn, Wendy Thomas, Jon Johnson, Joachim Wackerow

 

What we have:

-          Definitions of Primitive and Extended primitive

-          List of elements to be included in core (part of spread sheet of elements to be imported into Drupal. Set of Primitives, Extended primitives and Basic elements.

 

Problems to be solved:

-          Finalize which candidates goes into core and which doesn’t

-          How to organize uml packages with regards to external packages. Should external namespaces (e.g. dc or xhtml) go into their own packages?

-          How do we export primitives to xmi and into Enterprise Architect? This needs to be tested.

-          We should wait until 3.2 import into Drupal is done before adding elements to Drupal.

 

Next steps:

-          Wendy to finish document with definitions (see below)

-          Johan to set up a better document with Core elements.

-          As soon as import of 3.2 elements into Drupal is done Johan will add Primitives and Extended primitives to Drupal

 

Next call:

-          Not needed. Communication before Toronto will be done by email.

 

Edit Document

Containment and Reference

Issue statement

Technical Committee 2014-05-16

Issue:

Objects in the DDI Library should have a clear set of rules regarding their classification as Primitives, Extended Primitives, Property, and Relationship. There is currently a clear definition of objects that fall into Primitives and Extended Primitives (treated as data types), but there is no clear definition of which other objects should be included in an object as a property rather than as a relationship. Defining this distinction now will make assignment of objects clearer as we progress.

Suggested Definitions

Type

Definition

Status

Comments

Primitive

Classic primitive types such as character, integer, string, etc.

Agreed

Defined at the NADDI Sprint

Extended Primitive

A set of complex DDI objects that are never used directly, only as types. i.e. InternationalStringType, CodeValueType, etc.

Agreed

Defined at the NADDI Sprint

Property

Objects whose data type is a primitive or extended primitive

Agreed

These objects are clearly entered as properties

“Gray Area”

Objects currently without identifiers (3.2 import treats these as properties); heavily reused objects; i.e. Label, Description, Citation, etc. [see list below]

Discussion, proposal and decision required.

Is there a way to define this group as a whole or as two subsets which belong to Property and Relationship respectively?

Relationship

XML complexTypes requiring identification (objects managed in their own right)

Agreed

These objects as defined here are clearly entered as relationships.

 

Currently the 3.2 content has been entered in such a way as to identify commonly reused primitives, extended primitives, and basic objects. There is no clear definition of which objects should be considered “Basic” objects.

Suggests Base Rules:

  1. Objects used only within a specific set of objects in the library should be provided in that object set
  2. Objects used in multiple sets where specification should always be the same should go into a “base set of available common objects”
  3. Objects that are “common objects” that are never used directly by name (only as a type definition) should be considered for Extended Primitives



Keep, Toss, Review tag

Used ONLY as a Type

NOTES

Object Type

Documentation

K

 

Used only in Agent in DDI 4

AddressType

Location address identifying each part of the address as separate elements.

K

x

Used in representations and record layouts

ArrayBaseCodeType

The array base is the value of the designation for the first item in an array and is set to either 0 or 1. Unix based systems and most current programming systems use an array base of 0. Traditional codebooks normally set the array base at 1, for example the first data item in a fixed format ASCII file record begins at character 1.

K

 

Used only in Other Materials type

AudioType

Describes the type and length of the audio segment.

R

 

Used (3.2) in all versionable objects

BasedOnObjectType

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.

K

x

Used in a number of citation objects

BibliographicNameType

Full name of the contributor. Language equivalents should be expressed within the International String structure.

K

 

Used across all objects requiring the input output information

BindingType

A structure used to bind the content of a parameter declared as the source to a parameter declared as the target. For example, binding the output of a question to the input of a generation instruction. Question A has an OutParameter X. Generation Instruction has an InParameter Y used in the recode instruction. Binding defines the content of InParameter Y to be whatever is provided by OutParameter X for use in the calculation of the recode.

K

 

Used in geographic coverage and geographic location

BoundingBoxType

The Bounding Box is a 'rectangle, oriented to the x and y axes, which bounds a geographic feature or a geographic dataset. It is specified by two coordinate xmin, ymin and xmax, ymax.' [FGDC]. In the DDI, it describes the full extent of the geographic coverage, and is designed to be used by systems that search for geography by coordinates. It is compatible with the description and structure found in FGDC and other geographic metadata structures.

K, R, T

 

Used in all publishable objects and Other material

CitationType

A citation for the item. May additionally be rendered in native qualified Dublin Core (dc and dcterms).

K, R

 

Used in all locations where machine actionable instructions are provided

CommandCodeType

Information on the command used to generate an alternative means of determining sequence changes. If used, the ItemSequenceType should be "Other".

K

 

Part of CommandCode

CommandFileType

Identifies and provides a link to an external copy of the command, for example, a SAS Command Code script.

K

 

Part of CommandCode

CommandType

This is an in-line provision of the command itself.

K

 

Used in all statistics representations (variable, category) - controlled vocabulary

ComputationBaseType

Defines the cases included in determining the statistic. The options are total=all cases, valid and missing (invalid); validOnly=Only valid values, missing (invalid) are not included in the calculation; missingOnly=Only missing (invalid) cases included in the calculation.

K

 

Used only in Agent in DDI 4

ContactInformationType

Contact information for the organization including location specification, address, URL, phone numbers, and other means of communication access. Address, location, telephone, and other means of communication can be repeated to express multiple means of a single type or change over time. Each major piece of contact information (with exception of URL contains the element EffectiveDates in order to date stamp the period for which the information is valid.

R

 

Used in all representations

ContentDateOffsetType

Identifies the difference between the date applied to the data as a whole and this specific item such as previous year's income or residence 5 years ago.

K

 

Only used in citation

ContributorType

The name of a contributing author or creator, who worked in support of the primary creator given above.

K

 

Used in AddressType and GeographicCoverageType

CountryCodeType

Country of the location

K

 

Only used in citation

CreatorType

Person, corporate body, or agency responsible for the substantive and intellectual content of the described object.

R

 

Used as both as "Date" and as type 23 locations

DateType

Provides a date or range of dates for the described data collection event as well as  a cycle number when the collection is part of a series of data collection events.

K

x

Used in all identifiables

DDIIDType

Identifies the format of the DDI URN as being canonical or deprecated.

K

 

Used only in Agent in DDI 4

EmailType

Generic email address for the location

R

x

Used by AccessPermission which is available in all access information locations

FormType

A link to a form used to provide access to the data or metadata including a statement of the purpose of the form.

R

 

Used in DateType by 5 specified dates

HistoricalDateType

A simple date expressed in a historical date format, including a specification of the date format and calendar used.

K

x

Used in Instruction and as extension base for Private Image

ImageType

An image associated with the Instruction, located at the provided URN or URL.

K

 

Used only in Agent in DDI 4

IndividualNameType

The name or names by which the individual is known. The legal or formal name of the individual should have the isFormal attribute set to true. The preferred name should be noted with the isPreferred attribute.

K

 

Used across all objects requiring the input output information

InParameterType

A parameter that may accept content from outside the Instruction. In addition to standard parameter content may provide the instructions for limiting the allowable array index.

K

 

Used only in Agent in DDI 4

InstantMessagingType

Instant Messaging identification for the location

K

 

Used on in citation

InternationalIdentifierType

An identifier whose scope of uniqueness is broader than the local archive. Common forms of an international identifier are ISBN, ISSN, DOI or similar designator.

K

 

Used only in Agent in DDI 4

InternetEmailType

The email address express as a string (restricted to the Internet format).

T

 

Used in all objects intended to be managed (96 locations)

LabelType

A display label for the Archive module. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.

R

x

Restriction that allows a list of languages used in 4 locations

LanguageList

Language of the data file expressed as a delimited list of language codes.

K

x

Used 2 times in each Bounding Box

LatitudeType

North latitude of the bounding box. (ymax)

K

x

Used 2 times in each Bounding Box

LongitudeType

West longitude of the bounding box. (xmin)

 

x

Used in all objects intended to be managed (96 locations)

NameType

A name for XXX. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.

K

 

Available in all 3.2 maintainable objects

NoteType

Notes specific to the object within the fragment.

K

 

Available in all 3.2 maintainable objects plus 20 locations as type or extension base

OtherMaterialType

References to one or more external budget documents.

K

 

Used in AddressType and PolygonType

PointType

Geographic coordinate point for the location

K

 

Used only in GeographicBoundaryType

PolygonType

A description of the boundaries of the polygon either in-line or by a reference to an external file containing the boundaries. Repeatable to describe non-contiguous areas such as islands or Native American Reservations in some parts of the United States.

K

 

Used only in Agent in DDI 4

PrivacyCodeType

Specify the level privacy for the all information on the organization as public, restricted, or private.

K

 

Used only in Agent in DDI 4

PrivateImageType

Image of the individual with date and privacy information.

R

 

Used in physicalInstance and all NoteTypes

ProprietaryInfoType

Contains information proprietary to the software package which produced the data file. This is expressed as a set of name-value pairs. The value may be taken from a controlled vocabulary.

K

 

Used on in citation

PublisherType

Person or organization responsible for making the resource available in its present form.

K

 

Used in multiple representations

RangeType

Use when multiple values are included. This uses the unique Value provided for the Code as a means of identification. Provides the range of Values for this dimension that are within the area being defined. Repeat for non-contiguous values.

K

 

Part of RangeType

RangeValueType

Maximum value in the range.

R

 

Used in LifecycleEvent, OtherMaterial, and Note

RelationshipType

Allows linking a lifecycle event to one or more sections of metadata. If no relationship is noted the lifecycle event relates to its full parent StudyUnit, Group, or Resource Package.

T

 

Used in OtherMaterial and 1 representation type

SegmentType

Identifies the region of the object where the action needs to occur based on the object type by specifying a segment of the object.

K

 

Used only in Agent in DDI 4

SexSpecificationType

Sex allows for the specification of male, female or neutral. The purpose of providing this information is to assist others in the appropriate use of pronouns when addressing the individual. Note that many countries/languages may offer a neutral pronoun form.

R

 

Used in all maintainables and PhysicalInstance/GrossFileStructure, and Methodology

SoftwareType

Indicates the software that was used to create the data file.

K

 

All Versionables, comparison maps and ProprietaryInfoType

StandardKeyValuePairType

A structure that supports the use of a standard key value pair. Note that this information is often not interoperable and is provided to support the use of the metadata within specific systems.

K

 

All Variable and category statistics

StatisticType

The value of the statistics and whether it is weighted and/or includes missing values.

K

 

Part of InternationalString

StringType

A non-formatted string of text with an attribute that designates the language of the text. Repeat this object to express the same content in another language.

K

 

Used only in Agent in DDI 4

TelephoneType

Telephone number for the location

K

 

Used in DynamicTextType

TextType

The value of the static text string. Supports the optional use of XHTML formatting tags within the string structure. If the content of a literal text contains more than one language, i.e. "What is your understanding of the German word 'Gesundheit'?", the foreign language element should be placed in a separate LiteralText component with the appropriate xmlang value and, in this case, isTranslatable set to "false". If the existence of white space is critical to the understanding of the content (such as inclusion of a leading or trailing white space), set the attribute of Text xmspace to "preserve".

K

x

Used once

URIType

A URN or URL for the data file with a flag to indicate if it is a public copy.

K

 

Used once

URLType

URL for the location's website.

R

 

Used in all identifiables and all References

URNType

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

R

 

Used in all identifiables

UserIDType

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.

K

 

Used in 14 locations across DDI

ValueType

Provides a default value for the parameter if there is no value provided by the object it is bound to or the process that was intended to produce a value.

K

 

Used in OtherMaterial and 1 representation type

VideoType

Describes the type and length of the video segment.

 

Discussions at NADDI Sprint
  • Agreement was reached on the division of the coverage of the original Core and Foundational work tasks.
  • Core is split into Primitives and Extended Primitives
  • Foundational is split into Conceptual Objects and Basic Reusables
  • These new work tasks have the following coverage descriptions:
    • Primitives - XML basic types such as xs:string, xs:boolean, etc. These items are never used directly within other library objects, they are only used as data types.
    • Extended Primitives - Complex objects that are used only as data types such as InternationalString, CodeValue, etc. These items are never used directly within other library objects, they are only used as data types.
    • Conceptual Objects - The core set of objects reflected in a ISO 11179 Data Element or GSIM Represented Variable. These form the theoretical core of Variables.
    • Basic Reusables - This is a set of generic objects that are used in a consistent way throughout DDI and are available for direct use or as an extension base by other objects in the library. Examples: Label, Value, Description, CommandCode, etc.
  • All of these task groups with the exception of Conceptual Objects are being addressed by the Core Work Group. This group will review all current DDI objects and identify those belonging to each group. The list will be reviewed, the objects moved from pre-loaded 3.2 objects into their appropriate Task Group and follow the standard review process for movement into the Library. This is a high priority task as a great many DDI objects are based on the objects in these three task groups.
  • Once these items are in Drupal, the group working with Conceptual Objects can finalize the entry work and continue with the standard review process.