Documentation for registryObjects

Table of Contents

top

Schema Document Properties

Target Namespace http://ands.org.au/standards/rif-cs/registryObjects
Version 1.0.1
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
Documentation An early draft of an ISO2146 schema to promote discussion. This is intended as an alternative to that currently published on the draft ISO2146 web site. It is based on experience from the pilot collection and services registry developed under the APSR ORCA project (see http://www.apsr.edu.au/orca/index.htm).

The schema structure has been based on the original PREMIS approach where the core objects are provided their own schema. This may be useful in a maintenance context, a usability context, in establishing focussed working groups, and even swapping out alternative models should better representations of core entities become available in the future. It may be useful in allowing more targetted processing and data exchange.

Each sub-schema represents one of the object sub-types. While there are commonalities across the different entities, the content model of a property may in future be better controlled/tailored if they are tied to their object type. In this schema the common elements are replicated in each of the different registry object classes. This will in future allow different rules (content models) to be imposed on how they are expressed. While at a theoretical level this is redundant (and theoreticians may shudder!) in practice this is likely to be needed and will make an implementors job a little easier.

Change history v0.1 - 7 Dec 2007 * Initial Draft v0.2 - 4 Feb 2008 (ORCA developer meeting) * enumeration values moved to external vocabularies * dateCreated attribute added to all repository objects * type attribute added to description element * collection/service relation model applied to party, activity * profile element removed * type library created and imports added to object schemas * type attribute added to collection element v0.3 - 20 Feb 2008 * Added group attribute to registry objects v0.4 - 29 Feb 2008 (Review feedback during ORCA redevelopment) * Removed dateRangeType and converted to attribute group * Registry object wrapper element and relocation of key element and common attributes * Remove type attribute from common attributes (in support of object wrapper element) * Change relation type element from NMTOKENS to xsd:string to support simpler processing of relations * Electronic address element type attribute now optional * Removed type attribute from relatedObjectType * Removed uri element from relatedObjectType * Add type attribute to complexNameType * Drop uri element from electronicAddressType, add value element in its place * Remove args element from relatedObject * Add description element and type attribute to relation element v1.0 - 13 March 2009 * remove dateCreated attribute * move dateModified attribute to individual object classes and make optional * add dateAccessioned attribute to collection * add originatingSource element under registryObject with optional type attribute * change simpleNameType and complexType to a single nameType * make the relation element's description element optional * move date range attributes from physical and spatial up to the location element * import namespace in registryTypes.xsd updated to proper XML namespace and schema location * update default and target namespace to reflect ANDS ownership * remove xml:lang from namePart and addressPart v1.0.1 - 4 June 2009 * added type attribute to location

Declared Namespaces

Prefix Namespace
Default namespace http://ands.org.au/standards/rif-cs/registryObjects
xml http://www.w3.org/XML/1998/namespace
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema version="1.0.1" targetNamespace="http://ands.org.au/standards/rif-cs/registryObjects" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xsd:include schemaLocation="activity.xsd"/>
<xsd:include schemaLocation="collection.xsd"/>
<xsd:include schemaLocation="party.xsd"/>
<xsd:include schemaLocation="service.xsd"/>
...
</xsd:schema>
top

Global Declarations

Element: registryObjects

Name registryObjects
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Wrapper element for registryObject elements.
Logical Diagram
XML Instance Representation
<registryObjects>
<registryObject
group=" xsd:string [1]

'A string available for grouping of repository objects, typically by organisation.'

"
> [0..*]

'This element is a wrapper element containing descriptive and administrative metadata for a single registry object.'


<key> xsd:string </key> [1]

'The key (or primary identifier) of an object. It must unique within its context of use.'

<originatingSource
type=" xsd:string [0..1]

'A value taken from a controlled vocabulary indicating the type of originating source.'

"
> [1]

'A string or URI identifying the entity holding the managed version of the registry object metadata. For example in a federated aggregation context this must identify the original repository or owning institution from which the metadata was harvested *not* the aggregator from which it was harvested.'


xsd:string
</originatingSource>
Start Choice [1]
<activity> ... </activity> [1]
<collection> ... </collection> [1]
<party> ... </party> [1]
<service> ... </service> [1]
End Choice
</registryObject>
</registryObjects>
Diagram
h-390389518 h-997134399 h-592744477 h85315698 h1599477711
Schema Component Representation
<xsd:element name="registryObjects">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="registryObject" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="key" type=" xsd:string " minOccurs="1" maxOccurs="1"/>
<xsd:element name="originatingSource" minOccurs="1" maxOccurs="1">
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="type" type=" xsd:string " use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
<xsd:choice>
<xsd:element ref=" activity " minOccurs="1" maxOccurs="1"/>
<xsd:element ref=" collection " minOccurs="1" maxOccurs="1"/>
<xsd:element ref=" party " minOccurs="1" maxOccurs="1"/>
<xsd:element ref=" service " minOccurs="1" maxOccurs="1"/>
</xsd:choice>
</xsd:sequence>
<xsd:attributeGroup ref=" registryObjectAttributes "/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top