xepicur documentation for XML schema

Table of Contents

top

Schema Document Properties

Target Namespace urn:nbn:de:1111-2004033116
Version 1.0
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.
Documentation This file contains the schema of the XML schema on the basis of the XEPICUR transfer syntax for the entire URN administration. This schema has two aims: 1. The integration into OAI 2.0 of the selective harvesting of URN records by the German National Library from a data provider. URN records contain the following information: - A created xml-based metadata record with information about a URN, its associated URL and some attributes. - Also provided is meta-information about records changed by data providers. This situation applies when a URL is updated. - Optionally hierarchical designations (for whole or partial documents) can be provided as can URNs for partial documents. - There is an option of providing semantic information such as the details of a new URN allocated for a new document version. 2. The provision of a separate technical interface for implementing an active process for reporting and updating URNs at the German National Library with the following information: - Initial URN registration - initial registration of a URN for a new version of a document - initial registration of a URN for partial documents - URL updating - URL updating where more than URL is registered against one URN - deleting URNs - inserting URLs As at: February 2004 Version: 1.0 Authors: Kathrin Schroeder

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
epicur urn:nbn:de:1111-2004033116
xsd http://www.w3.org/2001/XMLSchema
xsi http://www.w3.org/2001/XMLSchema-instance
Schema Component Representation
<xsd:schema targetNamespace="urn:nbn:de:1111-2004033116" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0" schemaLocation="http://www.w3.org/2001/XMLSchema http://www.w3.org/2001/XMLSchema.xsd">
...
</xsd:schema>
top

Global Declarations

Element: epicur

Name epicur
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Declaration of "epicur" root element with two sub-elements "administrative_data" and "record". Both elements are mandatory fields and must occur at least once.
XML Instance Representation
<epicur:epicur>
<epicur:administrative_data> epicur:administrative_dataType </epicur:administrative_data> [1]
<epicur:record> epicur:recordType </epicur:record> [1..*]
</epicur:epicur>
Schema Component Representation
<xsd:element name="epicur">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="administrative_data" type=" epicur:administrative_dataType "/>
<xsd:element name="record" type=" epicur:recordType " maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Global Definitions

Complex Type: administrative_dataType

Super-types: None
Sub-types: None
Name administrative_dataType
Abstract no
XML Instance Representation
<...>
<epicur:delivery> epicur:deliveryType </epicur:delivery> [1]
</...>
Schema Component Representation
<xsd:complexType name="administrative_dataType">
<xsd:sequence>
<xsd:element name="delivery" type=" epicur:deliveryType "/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: authorizationType

Super-types: None
Sub-types: None
Name authorizationType
Abstract no
Documentation This element indicates a URN namespace and should be selected if URNs from another namespace are being reported to the German National Library, such as urn:tib-123456789.
XML Instance Representation
<...>
Start Choice [1]
<epicur:person_id> xsd:string </epicur:person_id> [1]
<epicur:system_id> xsd:string </epicur:system_id> [1]
End Choice
Start Choice [1]
<epicur:urn_nid> epicur:urn_nidType </epicur:urn_nid> [1]
<epicur:urn_snid> epicur:urn_snidType </epicur:urn_snid> [1]
End Choice
</...>
Schema Component Representation
<xsd:complexType name="authorizationType">
<xsd:sequence>
<xsd:choice>
<xsd:element name="person_id" type=" xsd:string "/>
<xsd:element name="system_id" type=" xsd:string "/>
</xsd:choice>
<xsd:choice>
<xsd:element name="urn_nid" type=" epicur:urn_nidType "/>
<xsd:element name="urn_snid" type=" epicur:urn_snidType "/>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: deliveryType

Super-types: None
Sub-types: None
Name deliveryType
Abstract no
Documentation The information is used to specify the URN reporting process such as initial URN registration or URL updating, the transfer interface used or the type of response.
XML Instance Representation
<...>
<epicur:authorization> epicur:authorizationType </epicur:authorization> [0..1]
<epicur:update_status> epicur:update_statusType </epicur:update_status> [1]
<epicur:transfer> epicur:transferType </epicur:transfer> [0..1]
<epicur:resupply> epicur:resupplyType </epicur:resupply> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="deliveryType">
<xsd:sequence>
<xsd:element name="authorization" type=" epicur:authorizationType " minOccurs="0"/>
<xsd:element name="update_status" type=" epicur:update_statusType "/>
<xsd:element name="transfer" type=" epicur:transferType " minOccurs="0"/>
<xsd:element name="resupply" type=" epicur:resupplyType " minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: formatType

Super-types: xsd:string < formatType (by extension)
Sub-types: None
Name formatType
Abstract no
Documentation The element is used to capture a publication's MimeType.
XML Instance Representation
<...
scheme="NMTOKEN <<value = {'imt'}>> [1]">
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="formatType">
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="scheme" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:NMTOKEN ">
<xsd:enumeration value="imt"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: hasVersionType

Super-types: xsd:string < hasVersionType (by extension)
Sub-types: None
Name hasVersionType
Abstract no
Documentation The "hasVersion" element is optional and is used to detail whether another persistent identifier, such as DOI, exists in addition to a Persistent Identifier already registered such as "urn:nbn:de:...". The "external" Persistent Identifier must be specified using "scheme".
XML Instance Representation
<...
scheme="token <<value = {'urn'|'urn:nbn'|'urn:nbn:de'|'urn:nbn:ch'|'urn:nbn:at'|'doi'|'handle'|'urn:issn'|'urn:isbn'}>> [1]">
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="hasVersionType">
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="scheme" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:token ">
<xsd:enumeration value="urn"/>
<xsd:enumeration value="urn:nbn"/>
<xsd:enumeration value="urn:nbn:de"/>
<xsd:enumeration value="urn:nbn:ch"/>
<xsd:enumeration value="urn:nbn:at"/>
<xsd:enumeration value="doi"/>
<xsd:enumeration value="handle"/>
<xsd:enumeration value="urn:issn"/>
<xsd:enumeration value="urn:isbn"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: identifierType

Super-types: xsd:string < identifierType (by extension)
Sub-types: None
Name identifierType
Abstract no
XML Instance Representation
<...
scheme="string <<value = {'urn'|'urn:nbn'|'urn:nbn:de'|'urn:nbn:at'|'urn:nbn:ch'|'url'}>> [1]"
type="string <<value = {'frontpage'}>> [0..1]"
status="string <<value = {'old'|'new'}>> [0..1]"
role="string <<value = {'primary'}>> [0..1]"
origin="string <<value = {'original'|'extern'|'archive'}>> [0..1]"
target="string <<value = {'transfer'}>> [0..1]">
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="identifierType">
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="scheme" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="urn"/>
<xsd:enumeration value="urn:nbn"/>
<xsd:enumeration value="urn:nbn:de"/>
<xsd:enumeration value="urn:nbn:at"/>
<xsd:enumeration value="urn:nbn:ch"/>
<xsd:enumeration value="url"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="type">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="frontpage"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="status">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="old"/>
<xsd:enumeration value="new"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="role">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="primary"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="origin">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="original"/>
<xsd:enumeration value="extern"/>
<xsd:enumeration value="archive"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="target">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="transfer"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: isPartOfType

Super-types: None
Sub-types: None
Name isPartOfType
Abstract no
Documentation The element with two sub-elements is used to illustrate information about URNs and their associated URLs allocated for partial documents.

URN and URL of the complete document

This element contains information about URNs and URLs for partial documents. It is repeatable.
XML Instance Representation
<...>
Start Sequence [1..*]
<epicur:identifier> epicur:identifierType </epicur:identifier> [1]
<epicur:resource> epicur:resourceType </epicur:resource> [1]
End Sequence
</...>
Schema Component Representation
<xsd:complexType name="isPartOfType">
<xsd:sequence maxOccurs="unbounded">
<xsd:element name="identifier" type=" epicur:identifierType "/>
<xsd:element name="resource" type=" epicur:resourceType "/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: isVersionOfType

Super-types: xsd:string < isVersionOfType (by extension)
Sub-types: None
Name isVersionOfType
Abstract no
Documentation This element identifies URNs assigned to new document versions. This takes into account the schema set out below.
XML Instance Representation
<...
scheme="token <<value = {'urn'|'urn:nbn'|'urn:nbn:de'|'urn:nbn:ch'|'urn:nbn:at'}>> [1]">
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="isVersionOfType">
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="scheme" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:token ">
<xsd:enumeration value="urn"/>
<xsd:enumeration value="urn:nbn"/>
<xsd:enumeration value="urn:nbn:de"/>
<xsd:enumeration value="urn:nbn:ch"/>
<xsd:enumeration value="urn:nbn:at"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Complex Type: recordType

Super-types: None
Sub-types: None
Name recordType
Abstract no
Documentation The element record is directly sub-ordinate to the "epicur" root element. It can be repeated in order to generate multiple registrations. This situation can occur when implementing URN reporting or updating procedures using a separate URN interface. When integrating the schema into OAI 2.0 the "record" element is restricted to the cardinality 1.
XML Instance Representation
<...>
<epicur:identifier> epicur:identifierType </epicur:identifier> [1]
<epicur:isVersionOf> epicur:isVersionOfType </epicur:isVersionOf> [0..1]
<epicur:hasVersion> epicur:hasVersionType </epicur:hasVersion> [0..1]
<epicur:resource> epicur:resourceType </epicur:resource> [0..*]
<epicur:isPartOf> epicur:isPartOfType </epicur:isPartOf> [0..*]
</...>
Schema Component Representation
<xsd:complexType name="recordType">
<xsd:sequence>
<xsd:element name="identifier" type=" epicur:identifierType "/>
<xsd:element name="isVersionOf" type=" epicur:isVersionOfType " minOccurs="0"/>
<xsd:element name="hasVersion" type=" epicur:hasVersionType " minOccurs="0"/>
<xsd:element name="resource" type=" epicur:resourceType " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="isPartOf" type=" epicur:isPartOfType " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: resourceType

Super-types: None
Sub-types: None
Name resourceType
Abstract no
XML Instance Representation
<...>
Start Sequence [1..*]
<epicur:identifier> epicur:identifierType </epicur:identifier> [1]
<epicur:format> epicur:formatType </epicur:format> [0..1]
End Sequence
</...>
Schema Component Representation
<xsd:complexType name="resourceType">
<xsd:sequence maxOccurs="unbounded">
<xsd:element name="identifier" type=" epicur:identifierType "/>
<xsd:element name="format" type=" epicur:formatType " minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: resupplyType

Super-types: None
Sub-types: None
Name resupplyType
Abstract no
Documentation Target address for information on successful or failed processing. This entry is optional.
XML Instance Representation
<...
type="NMTOKEN <<value = {'email'|'ftp'}>> [1]"/>
Schema Component Representation
<xsd:complexType name="resupplyType">
<xsd:attribute name="type" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:NMTOKEN ">
<xsd:enumeration value="email"/>
<xsd:enumeration value="ftp"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
top

Complex Type: transferType

Super-types: None
Sub-types: None
Name transferType
Abstract no
Documentation Transfer interface or protocol details. This element is optional.
XML Instance Representation
<...
type="NMTOKEN <<value = {'oai'|'email'|'http'|'ftp'}>> [1]"/>
Schema Component Representation
<xsd:complexType name="transferType">
<xsd:attribute name="type" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:NMTOKEN ">
<xsd:enumeration value="oai"/>
<xsd:enumeration value="email"/>
<xsd:enumeration value="http"/>
<xsd:enumeration value="ftp"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
top

Complex Type: update_statusType

Super-types: None
Sub-types: None
Name update_statusType
Abstract no
XML Instance Representation
<...
type="NMTOKEN <<value = {'urn_new'|'urn_new_version'|'urn_alternative'|'url_update'|'url_update_general'|'url_delete'|'url_insert'}>> [1]"/>
Schema Component Representation
<xsd:complexType name="update_statusType">
<xsd:attribute name="type" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:NMTOKEN ">
<xsd:enumeration value="urn_new"/>
<xsd:enumeration value="urn_new_version"/>
<xsd:enumeration value="urn_alternative"/>
<xsd:enumeration value="url_update"/>
<xsd:enumeration value="url_update_general"/>
<xsd:enumeration value="url_delete"/>
<xsd:enumeration value="url_insert"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
top

Simple Type: urn_nidType

Super-types: xsd:string < urn_nidType (by restriction)
Sub-types: None
Name urn_nidType
Content
  • Built-in XSD Type: string
  • pattern = urn:.*
Documentation Validation of whether the "urn_nid" element complies with the chosen schema.
Schema Component Representation
<xsd:simpleType name="urn_nidType">
<xsd:restriction base=" xsd:string ">
<xsd:pattern value="urn:.*"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: urn_snidType

Super-types: xsd:string < urn_snidType (by restriction)
Sub-types: None
Name urn_snidType
Content
  • Built-in XSD Type: string
  • pattern = urn:nbn:.*
Documentation Validation of whether the "urn_snid" element complies with the chosen schema.
Schema Component Representation
<xsd:simpleType name="urn_snidType">
<xsd:restriction base=" xsd:string ">
<xsd:pattern value="urn:nbn:.*"/>
</xsd:restriction>
</xsd:simpleType>
top

Legend

Complex Type: AusAddress
Schema Component Type 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

Generated by xs3p.