Documentation for registryObjects

Table of Contents

Master schema documentation file: registryObjects.xsd.html

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 Type library for Registry Schema

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:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/xml.xsd"/>
...
</xsd:schema>
top

Global Definitions

Attribute Group: collectionAttributes

Name collectionAttributes
XML Instance Representation
dateAccessioned=" xsd:dateTime [0..1]

'The date this object was registered in a managed environment. Must be UTC and of one of the forms described in section 3.2.7 of the W3C\'s Schema Data Types document (http://www.w3.org/TR/xmlschema-2/).'

"
Diagram
Schema Component Representation
<xsd:attributeGroup name="collectionAttributes">
<xsd:attribute name="dateAccessioned" type=" xsd:dateTime " use="optional"/>
</xsd:attributeGroup>
top

Attribute Group: dateRangeAttributes

Name dateRangeAttributes
Used by (from the same schema document) Complex Type nameType , Complex Type locationType
XML Instance Representation
dateFrom=" xsd:dateTime [0..1]

'The date from which the metadata being described was current. This is only applicable where versions of the same metadata is being provided (e.g. name changes). Should be UTC and of one of the forms described in section 3.2.7 of the W3C\'s Schema Data Types document (http://www.w3.org/TR/xmlschema-2/).'

"

dateTo=" xsd:dateTime [0..1]

'The date the metadata being described was no longer current. This is only applicable where versions of the same metadata is being provided (e.g. name changes). Should be UTC and of one of the forms described in section 3.2.7 of the W3C\'s Schema Data Types document (http://www.w3.org/TR/xmlschema-2/).'

"
Diagram
Schema Component Representation
<xsd:attributeGroup name="dateRangeAttributes">
<xsd:attribute name="dateFrom" type=" xsd:dateTime " use="optional"/>
<xsd:attribute name="dateTo" type=" xsd:dateTime " use="optional"/>
</xsd:attributeGroup>
top

Attribute Group: objectAttributes

Name objectAttributes
XML Instance Representation
type=" xsd:string [1]

'A value taken from a controlled vocabulary indicating the type of object being described'

"

dateModified=" xsd:dateTime [0..1]

'The date this object’s metadata was last changed. This only refers to the metadata of the registry object itself. For example if a collection has a new item added to it this does not constitute a modification to the object. Where an object\'s metadata has not changed, this attribute should be set to the object\'s creation date.'

"
Diagram
Schema Component Representation
<xsd:attributeGroup name="objectAttributes">
<xsd:attribute name="type" type=" xsd:string " use="required"/>
<xsd:attribute name="dateModified" type=" xsd:dateTime " use="optional"/>
</xsd:attributeGroup>
top

Attribute Group: registryObjectAttributes

Name registryObjectAttributes
XML Instance Representation
group=" xsd:string [1]

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

"
Diagram
Schema Component Representation
<xsd:attributeGroup name="registryObjectAttributes">
<xsd:attribute name="group" type=" xsd:string " use="required"/>
</xsd:attributeGroup>
top

Complex Type: descriptionType

Super-types: xsd:string < descriptionType (by extension)
Sub-types: None
Name descriptionType
Abstract no
XML Instance Representation
<...
type=" xsd:string [1]

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

"

xml:lang="[0..1]">
xsd:string
</...>
Diagram
Schema Component Representation
<xsd:complexType name="descriptionType">
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="type" type=" xsd:string " use="required"/>
<xsd:attribute ref=" xml:lang"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: electronicAddressType

Super-types: None
Sub-types: None
Name electronicAddressType
Used by (from the same schema document) Complex Type locationType
Abstract no
Documentation An electronic address will generally hold an e-mail address or URL pointing to the object being described. However in the case of a service it is possible to describe the service in terms of its base URL using the <value> element and using the <arg> element to describe the service arguments. A separate collection object which supports the service would then provide a URL to its implementation of the service in its <url> element when describing the <relatedObject>.
XML Instance Representation
<...
type=" xsd:string [0..1]

'A value taken from a controlled vocabulary indicating the type of electronic address.'

"
>
<value> xsd:anyURI </value> [1]
<arg
required=" xsd:string (value comes from list: {'true'|'false'}) [1]

'Indicates whether the argument is required (true) or optional (false).'

"

type=" xsd:string [1]

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

"

use=" xsd:string [0..1]

'A value taken from a controlled vocabulary indicating the type of use for the argument.'

"
> [0..*]
xsd:string
</arg>
</...>
Diagram
Schema Component Representation
<xsd:complexType name="electronicAddressType">
<xsd:sequence>
<xsd:element name="value" type=" xsd:anyURI " minOccurs="1" maxOccurs="1"/>
<xsd:element name="arg" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="required" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="true"/>
<xsd:enumeration value="false"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="type" type=" xsd:string " use="required"/>
<xsd:attribute name="use" type=" xsd:string " use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="type" type=" xsd:string " use="optional"/>
</xsd:complexType>
top

Complex Type: identifierType

Super-types: xsd:string < identifierType (by extension)
Sub-types: None
Name identifierType
Abstract no
XML Instance Representation
<...
type=" xsd:string [1]

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

"
>
xsd:string
</...>
Diagram
Schema Component Representation
<xsd:complexType name="identifierType">
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="type" type=" xsd:string " use="required"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: locationType

Super-types: None
Sub-types: None
Name locationType
Abstract no
Documentation The location element can hold physical and/or electronic addresses as well as geographical references. Use the <address> element for physical or electronic address and the <spatial> element for geographical references. An electronic address could be a website containing details about the activity or email address whereas physical addresses can be provided for snail mail, billing, enquiries. Physical addresses are split into parts should a more granular division of address be required.
XML Instance Representation
<...
type=" xsd:string [0..1]

'A value taken from a controlled vocabulary indicating the type of location being described.'

"

dateFrom=" xsd:dateTime [0..1]

'The date from which the metadata being described was current. This is only applicable where versions of the same metadata is being provided (e.g. name changes). Should be UTC and of one of the forms described in section 3.2.7 of the W3C\'s Schema Data Types document (http://www.w3.org/TR/xmlschema-2/).'

"

dateTo=" xsd:dateTime [0..1]

'The date the metadata being described was no longer current. This is only applicable where versions of the same metadata is being provided (e.g. name changes). Should be UTC and of one of the forms described in section 3.2.7 of the W3C\'s Schema Data Types document (http://www.w3.org/TR/xmlschema-2/).'

"
>
<address> [0..*]
<electronic> electronicAddressType </electronic> [0..*]
<physical> physicalAddressType </physical> [0..*]
</address>
<spatial> spatialType </spatial> [0..*]
</...>
Diagram
h2123398637 h945515378 h-715758375 h-1407797270
Schema Component Representation
<xsd:complexType name="locationType">
<xsd:sequence>
<xsd:element name="address" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="electronic" type=" electronicAddressType " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="physical" type=" physicalAddressType " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="spatial" type=" spatialType " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="type" type=" xsd:string " use="optional"/>
<xsd:attributeGroup ref=" dateRangeAttributes "/>
</xsd:complexType>
top

Complex Type: nameType

Super-types: None
Sub-types: None
Name nameType
Abstract no
XML Instance Representation
<...
dateFrom=" xsd:dateTime [0..1]

'The date from which the metadata being described was current. This is only applicable where versions of the same metadata is being provided (e.g. name changes). Should be UTC and of one of the forms described in section 3.2.7 of the W3C\'s Schema Data Types document (http://www.w3.org/TR/xmlschema-2/).'

"

dateTo=" xsd:dateTime [0..1]

'The date the metadata being described was no longer current. This is only applicable where versions of the same metadata is being provided (e.g. name changes). Should be UTC and of one of the forms described in section 3.2.7 of the W3C\'s Schema Data Types document (http://www.w3.org/TR/xmlschema-2/).'

"

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

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

"

xml:lang="[0..1]">
<namePart
type=" xsd:string [0..1]

'A value taken from a controlled vocabulary indicating the type of electronic address.'

"
> [1..*]

'Either a single string (using one <namePart> element) or the name represented in compound form with the content of each namePart being described by the type attribute.'


xsd:string
</namePart>
</...>
Diagram
h-1407797270 h-1961631311
Schema Component Representation
<xsd:complexType name="nameType">
<xsd:sequence>
<xsd:element name="namePart" minOccurs="1" maxOccurs="unbounded">
<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:sequence>
<xsd:attributeGroup ref=" dateRangeAttributes "/>
<xsd:attribute name="type" type=" xsd:string " use="optional"/>
<xsd:attribute ref=" xml:lang"/>
</xsd:complexType>
top

Complex Type: physicalAddressType

Super-types: None
Sub-types: None
Name physicalAddressType
Used by (from the same schema document) Complex Type locationType
Abstract no
XML Instance Representation
<...
type=" xsd:string [0..1]

'A value taken from a controlled vocabulary indicating the type of physical address.'

"

xml:lang="[0..1]">
<addressPart
type=" xsd:string [1]

'A value taken from a controlled vocabulary indicating the type of address part.'

"
> [1..*]
xsd:string
</addressPart>
</...>
Diagram
h-1961631311
Schema Component Representation
<xsd:complexType name="physicalAddressType">
<xsd:sequence>
<xsd:element name="addressPart" minOccurs="1" maxOccurs="unbounded">
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="type" type=" xsd:string " use="required"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="type" type=" xsd:string " use="optional"/>
<xsd:attribute ref=" xml:lang"/>
</xsd:complexType>
top

Complex Type: relatedObjectType

Super-types: None
Sub-types: None
Name relatedObjectType
Abstract no
XML Instance Representation
<...>
<key> xsd:string </key> [1]

'Element holding a key which uniquely identifies a related registry object.'

<relation
type=" xsd:string [1]

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

"
> [1..*]

'A wrapper element containing metadata about the current registry object\'s relationship to another registry object.'


<description
xml:lang="[0..1]"> [0..1]

'A plain text description of the relation.'


xsd:string
</description>
<url> xsd:anyURI </url> [0..1]

'A URI expressing or implementing the relationship. For example if describing a collection\'s relation to a service, the URL which implements the related service in the collection\'s context can be represented in this element.'

</relation>
</...>
Diagram
Schema Component Representation
<xsd:complexType name="relatedObjectType">
<xsd:sequence>
<xsd:element name="key" type=" xsd:string " minOccurs="1" maxOccurs="1"/>
<xsd:element name="relation" minOccurs="1" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="description" minOccurs="0" maxOccurs="1">
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute ref=" xml:lang"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
<xsd:element name="url" type=" xsd:anyURI " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="type" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: spatialType

Super-types: xsd:string < spatialType (by extension)
Sub-types: None
Name spatialType
Used by (from the same schema document) Complex Type locationType
Abstract no
XML Instance Representation
<...
type=" xsd:string [1]

'A value taken from a controlled vocabulary indicating the type of spatial location.'

"

xml:lang="[0..1]">
xsd:string
</...>
Diagram
Schema Component Representation
<xsd:complexType name="spatialType">
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="type" type=" xsd:string " use="required"/>
<xsd:attribute ref=" xml:lang"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: subjectType

Super-types: xsd:string < subjectType (by extension)
Sub-types: None
Name subjectType
Abstract no
XML Instance Representation
<...
type=" xsd:string [1]

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

"

xml:lang="[0..1]">
xsd:string
</...>
Diagram
Schema Component Representation
<xsd:complexType name="subjectType">
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="type" type=" xsd:string " use="required"/>
<xsd:attribute ref=" xml:lang"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
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