complexType "Model"
Namespace:
Content:
complex, 15 elements
Defined:
globally in vo-dml.xsd; see XML source
Includes:
definitions of 15 elements
Used:
XML Representation Summary
<...>
   
Content: 
name, description?, identifier?, uri, title, author*, version, previousVersion?, lastModified, import*, primitiveType*, enumeration*, dataType*, objectType*, package*
</...>
Content Model Elements (15):
All Direct / Indirect Based Elements (1):
Known Usage Locations
Annotation
Represents a complete data model and is the type of the (single) declared root element for VO-DML/XML representation documents.
XML Source (see within schema source)
<xsd:complexType name="Model">
<xsd:annotation>
<xsd:documentation>
Represents a complete data model and is the type of the (single) declared root element for
VO-DML/XML representation documents.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="ModelName">
<xsd:annotation>
<xsd:documentation>
Short name of the model.
NOTE this name MUST be used as prefix in any utype reference to elements in this model.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="description" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
The description of the model.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="identifier" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
A string holding the identifier by which the model is registered in an
IVOA compatible registry. Its structure must therefore conform to the IVOA Identifier
specification in http://www.ivoa.net/documents/IVOAIdentifiers/.
If the model is an IVOA standard, the naming authority for the identifier should be the
IVOA DM working group.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="uri" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
Each model has an associated model URI that MUST be used to reference it, for example in ModelImports
or in VOTable annotations.
Dereferencing the model URI and following redirects yields the latest VO-DML for the data model
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="1" name="title" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
The title of the model by which it is officially known.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="author" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
List of authors of the model, only defined by name so far.
TBD could be expanded with email, affiliation and so on.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="1" name="version" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Label giving the version of the model.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="previousVersion" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
URI identifying a VO-DML model that is the version from which the current version of model is derived.
TBD could be an IVO Identifier once models get properly registered?
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="lastModified" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
Timestamp when the last change to the current model was made.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="import" type="ModelImport">
<xsd:annotation>
<xsd:documentation>
An 'import' element indicates a dependency on an external, predefined VO-DML data model.
Types from that model may be used for referencing, extension and assignment to
attributes.
Types from the external model MUST NOT be used for
composition relationships.
'identification' relations to elements from that model may be used to indicate some kind of
equivalence between
elements in the current model and the external elements.
</xsd:documentation>
<xsd:documentation>
TBD We might require that every data model MUST include a version of the IVOA data model
to gain access to the standard
primitive types and some other types.
We may require that that standard model should be included *completely*,
i.e. including all its type definitions explicitly.
This would be similar to treating it as a UML Profile, rather than an import.
This would mean that the most common type assignments for attributes
can be checked within the model and not require
importing the remote model during validation.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="primitiveType" type="PrimitiveType">
<xsd:annotation>
<xsd:documentation>
Collection of PrimitiveType definitions directly under the model, i.e. not contained in a
Package.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="enumeration" type="Enumeration">
<xsd:annotation>
<xsd:documentation>
Collection of Enumeration definitions directly under the model, i.e. not contained in a Package.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="dataType" type="DataType">
<xsd:annotation>
<xsd:documentation>
Collection of DataType definitions directly under the model, i.e. not contained in a Package.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="objectType" type="ObjectType">
<xsd:annotation>
<xsd:documentation>
Collection of ObjectType definitions directly under the model, i.e. not contained in a Package.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="package" type="Package">
<xsd:annotation>
<xsd:documentation>
The collection of packages which can contain further detailed name spacing to
the type definitions in the model.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
Content Element Detail (all declarations; 15)
author
Type:
xsd:string, simple content
Defined:
locally within (this) Model complexType
List of authors of the model, only defined by name so far. TBD could be expanded with email, affiliation and so on.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="author" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
List of authors of the model, only defined by name so far.
TBD could be expanded with email, affiliation and so on.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

dataType
Type:
DataType, complex content
Defined:
locally within (this) Model complexType
Collection of DataType definitions directly under the model, i.e. not contained in a Package.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="dataType" type="DataType">
<xsd:annotation>
<xsd:documentation>
Collection of DataType definitions directly under the model, i.e. not contained in a Package.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

description
Type:
xsd:string, simple content
Defined:
locally within (this) Model complexType
The description of the model.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="description" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
The description of the model.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

enumeration
Type:
Enumeration, complex content
Defined:
locally within (this) Model complexType
Collection of Enumeration definitions directly under the model, i.e. not contained in a Package.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="enumeration" type="Enumeration">
<xsd:annotation>
<xsd:documentation>
Collection of Enumeration definitions directly under the model, i.e. not contained in a Package.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

identifier
Type:
xsd:string, simple content
Defined:
locally within (this) Model complexType
A string holding the identifier by which the model is registered in an IVOA compatible registry. Its structure must therefore conform to the IVOA Identifier specification in http://www.ivoa.net/documents/IVOAIdentifiers/. If the model is an IVOA standard, the naming authority for the identifier should be the IVOA DM working group.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="identifier" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
A string holding the identifier by which the model is registered in an
IVOA compatible registry. Its structure must therefore conform to the IVOA Identifier
specification in http://www.ivoa.net/documents/IVOAIdentifiers/.
If the model is an IVOA standard, the naming authority for the identifier should be the
IVOA DM working group.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

import
Type:
ModelImport, complex content
Defined:
locally within (this) Model complexType
Annotation 1 [src]:
An 'import' element indicates a dependency on an external, predefined VO-DML data model. Types from that model may be used for referencing, extension and assignment to attributes. Types from the external model MUST NOT be used for composition relationships. 'identification' relations to elements from that model may be used to indicate some kind of equivalence between elements in the current model and the external elements.
Annotation 2 [src]:
TBD We might require that every data model MUST include a version of the IVOA data model to gain access to the standard primitive types and some other types. We may require that that standard model should be included *completely*, i.e. including all its type definitions explicitly. This would be similar to treating it as a UML Profile, rather than an import. This would mean that the most common type assignments for attributes can be checked within the model and not require importing the remote model during validation.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="import" type="ModelImport">
<xsd:annotation>
<xsd:documentation>
An 'import' element indicates a dependency on an external, predefined VO-DML data model.
Types from that model may be used for referencing, extension and assignment to
attributes.
Types from the external model MUST NOT be used for
composition relationships.
'identification' relations to elements from that model may be used to indicate some kind of
equivalence between
elements in the current model and the external elements.
</xsd:documentation>
<xsd:documentation>
TBD We might require that every data model MUST include a version of the IVOA data model
to gain access to the standard
primitive types and some other types.
We may require that that standard model should be included *completely*,
i.e. including all its type definitions explicitly.
This would be similar to treating it as a UML Profile, rather than an import.
This would mean that the most common type assignments for attributes
can be checked within the model and not require
importing the remote model during validation.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

lastModified
Type:
xsd:dateTime, simple content
Defined:
locally within (this) Model complexType
Timestamp when the last change to the current model was made.
XML Source (see within schema source)
<xsd:element name="lastModified" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
Timestamp when the last change to the current model was made.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

name
Type:
ModelName, simple content
Defined:
locally within (this) Model complexType
Short name of the model. NOTE this name MUST be used as prefix in any utype reference to elements in this model.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="ModelName">
<xsd:annotation>
<xsd:documentation>
Short name of the model.
NOTE this name MUST be used as prefix in any utype reference to elements in this model.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

objectType
Type:
ObjectType, complex content
Defined:
locally within (this) Model complexType
Collection of ObjectType definitions directly under the model, i.e. not contained in a Package.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="objectType" type="ObjectType">
<xsd:annotation>
<xsd:documentation>
Collection of ObjectType definitions directly under the model, i.e. not contained in a Package.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

package
Type:
Package, complex content
Defined:
locally within (this) Model complexType
The collection of packages which can contain further detailed name spacing to the type definitions in the model.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="package" type="Package">
<xsd:annotation>
<xsd:documentation>
The collection of packages which can contain further detailed name spacing to
the type definitions in the model.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

previousVersion
Type:
xsd:anyURI, simple content
Defined:
locally within (this) Model complexType
URI identifying a VO-DML model that is the version from which the current version of model is derived. TBD could be an IVO Identifier once models get properly registered?
XML Source (see within schema source)
<xsd:element minOccurs="0" name="previousVersion" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
URI identifying a VO-DML model that is the version from which the current version of model is derived.
TBD could be an IVO Identifier once models get properly registered?
</xsd:documentation>
</xsd:annotation>
</xsd:element>

primitiveType
Type:
PrimitiveType, complex content
Defined:
locally within (this) Model complexType
Collection of PrimitiveType definitions directly under the model, i.e. not contained in a Package.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="primitiveType" type="PrimitiveType">
<xsd:annotation>
<xsd:documentation>
Collection of PrimitiveType definitions directly under the model, i.e. not contained in a
Package.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

title
Type:
xsd:string, simple content
Defined:
locally within (this) Model complexType
The title of the model by which it is officially known.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="1" name="title" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
The title of the model by which it is officially known.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

uri
Type:
xsd:anyURI, simple content
Defined:
locally within (this) Model complexType
Each model has an associated model URI that MUST be used to reference it, for example in ModelImports or in VOTable annotations. Dereferencing the model URI and following redirects yields the latest VO-DML for the data model
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="1" name="uri" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
Each model has an associated model URI that MUST be used to reference it, for example in ModelImports
or in VOTable annotations.
Dereferencing the model URI and following redirects yields the latest VO-DML for the data model
</xsd:documentation>
</xsd:annotation>
</xsd:element>

version
Type:
xsd:string, simple content
Defined:
locally within (this) Model complexType
Label giving the version of the model.
XML Source (see within schema source)
<xsd:element minOccurs="1" name="version" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Label giving the version of the model.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

This XML schema documentation has been generated with DocFlex/XML RE 1.8.0 using DocFlex/XML XSDDoc 2.2.0 template set.
DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
  • To document local element components both globally and locally (similar to attributes).
  • To enable/disable reproducing of namespace prefixes.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
  • To use the same template to generate the incredible quality RTF documentation.
  • To document only selected XML schema components specified by name.
  • To remove this very advertisement text
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To buy a license, please follow this link: http://www.filigris.com/shop/