Documentation for mydasserverconfig

Table of Contents

top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations have no namespace.
  • By default, local attribute declarations have no namespace.

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema>
...
</xs:schema>
top

Global Declarations

Element: mydasserver

Name mydasserver
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This is the root element of the mydasserverconfig.xml file, used to configure a Mydas server installation with one or more data sources defined.
Logical Diagram
XML Instance Representation
<mydasserver>
<global> [1]

'The global element holds details of configuration common to the entire server.'


<baseurl> [1]

'The URL of the DAS server up to an including /das (e.g. http://www.ebi.ac.uk/das-srv/uniprot/das)'


xs:anyURI
</baseurl>
<gzipped> [1]

'A boolean switch indicating if the output from the DAS server should be compressed or not.'


xs:boolean
</gzipped>
<slash-das-points-to-dsn> [1]

'If set to true, then if the browser points to /das or /das/ then the output of the dsn command should be displayed. This is useful for creating a home page based upon the data source details.'


xs:boolean
</slash-das-points-to-dsn>
<default-stylesheet> xs:string </default-stylesheet> [1]

'The name of the default DAS stylesheet to be used for all of the defined datasources. This can be overridden for individual datasources by including a stylesheet element for them.'

<dsn-xslt-url> xs:anyURI </dsn-xslt-url> [0..1]

'Gives the URI of an XSLT transformation that can be used by the browser to present the dsn command response in a human-readable format. Optional - the processing instruction will only be included if this element is present.'

<dna-xslt-url> xs:anyURI </dna-xslt-url> [0..1]

'Gives the URI of an XSLT transformation that can be used by the browser to present the dna command response in a human-readable format. Optional - the processing instruction will only be included if this element is present.'

<entry-points-xslt-url> xs:anyURI </entry-points-xslt-url> [0..1]

'Gives the URI of an XSLT transformation that can be used by the browser to present the entry-points command response in a human-readable format. Optional - the processing instruction will only be included if this element is present.'

<sequence-xslt-url> xs:anyURI </sequence-xslt-url> [0..1]

'Gives the URI of an XSLT transformation that can be used by the browser to present the sequence command response in a human-readable format. Optional - the processing instruction will only be included if this element is present.'

<features-xslt-url> xs:anyURI </features-xslt-url> [0..1]

'Gives the URI of an XSLT transformation that can be used by the browser to present the features command response in a human-readable format. Optional - the processing instruction will only be included if this element is present.'

<types-xslt-url> xs:anyURI </types-xslt-url> [0..1]

'Gives the URI of an XSLT transformation that can be used by the browser to present the types command response in a human-readable format. Optional - the processing instruction will only be included if this element is present.'

<property> propertyType </property> [0..*]

'Any number of additional properties can be annotated on the server as a whole. These name / value pairs will be available to all of the data sources defined for the server instance.'

</global>
<datasources> [1]

'The enclosing element for one or more datasource definitions.'


<datasource
id=" xs:string [1]

'This is the mandatory data source ID, as provided in the /DASDSN/DSN/SOURCE/@id attribute of the XML returned by the DAS dsn command.'

"

name=" xs:string [1]

'This is the mandatory data source name, as provided in the /DASDSN/DSN/SOURCE element of the XML returned by the DAS dsn command. It may or may not be same as the id.'

"

version=" xs:string [0..1]

'This is the optional data source version, as provided in the /DASDSN/DSN/SOURCE/@version attribute of the XML returned by the DAS dsn command.'

"

mapmaster=" xs:string [1]

'This is the mandatory data source version, as provided in the /DASDSN/DSN/MAPMASTER element of the XML returned by the DAS dsn command. For a reference server, this should echo its own URL.'

"

description=" xs:string [0..1]

'This is the optional data source description, as provided in the /DASDSN/DSN/DESCRIPTION element of the XML returned by the DAS dsn command. For a reference server, this should echo its own URL.'

"

description-href=" xs:string [0..1]

'This is the optional data source description href attribute, as provided in the /DASDSN/DSN/DESCRIPTION/@href attribute of the XML returned by the DAS dsn command. For a reference server, this should echo its own URL.'

"
> [1..*]

'Configuration for a single data source. All the information annotated in this element will be available to the DataSource class.'


<class> xs:string </class> [1]

'The fully qualified class name of the DataSource.'

<stylesheet> xs:string </stylesheet> [0..1]

'The optional name of the DAS stylesheet to be used for this datasource. This will override the default stylesheet defined in the global settings section.'

<dna-command-enabled> [1]

'This setting indicates if the dna command is enabled or not for this data source. Clearly this may be set to false for servers that serve only protein sequence and annotation. Note that the mydas DAS server makes no attempt to check that a valid DNA, RNA or protein sequence is being served by the sequence command - this is the responsibility of the data source itself.'


xs:boolean
</dna-command-enabled>
<features-strictly-enclosed> [1]

'If \'true\' then when segment coordinates are included in the request, only features that are entirely enclosed within the coordinates are returned. If \'false\' then all features that overlap with the coordinates are returned. Handles an ambiguity in the DAS 1.53 specification - see section \"Retrieve the Annotations Across a Segment\".'


xs:boolean
</features-strictly-enclosed>
<use-feature-id-for-feature-label> [1]

'If \'true\' then if no feature label is provided by the data source, the feature id will automatically be reported as the feature label. (Of course, if a feature label is provided, this will override the feature id.)'


xs:boolean
</use-feature-id-for-feature-label>
<include-types-with-zero-count> [1]

'If \'true\' then all of the types present in the data source will be listed by the types command even if they do not appear for the requested segment. If \'false\', if the types command includes \'segment\' arguments, only the feature types actually annotated on the requested segments will be listed.'


xs:boolean
</include-types-with-zero-count>
<property> propertyType </property> [0..*]

'Any number of additional properties, consisting of a name and a value can be annotated for each individual data source. All such properties are available to the DataSource code of course.'

</datasource>
</datasources>
</mydasserver>
Diagram
h-427698284 h-427698284
Schema Component Representation
<xs:element name="mydasserver">
<xs:complexType>
<xs:sequence>
<xs:element name="global">
<xs:complexType>
<xs:sequence>
<xs:element name="baseurl" minOccurs="1">
<xs:complexType>
<xs:simpleContent>
<xs:extension base=" xs:anyURI "/>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="gzipped" nillable="false">
<xs:complexType>
<xs:simpleContent>
<xs:extension base=" xs:boolean "/>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="slash-das-points-to-dsn" nillable="false">
<xs:complexType>
<xs:simpleContent>
<xs:extension base=" xs:boolean "/>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="default-stylesheet" type=" xs:string " nillable="false"/>
<xs:element name="dsn-xslt-url" type=" xs:anyURI " nillable="false" minOccurs="0"/>
<xs:element name="dna-xslt-url" type=" xs:anyURI " nillable="false" minOccurs="0"/>
<xs:element name="entry-points-xslt-url" type=" xs:anyURI " nillable="false" minOccurs="0"/>
<xs:element name="sequence-xslt-url" type=" xs:anyURI " nillable="false" minOccurs="0"/>
<xs:element name="features-xslt-url" type=" xs:anyURI " nillable="false" minOccurs="0"/>
<xs:element name="types-xslt-url" type=" xs:anyURI " nillable="false" minOccurs="0"/>
<xs:element name="property" type=" propertyType " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="datasources">
<xs:complexType>
<xs:sequence>
<xs:element name="datasource" maxOccurs="unbounded" minOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="class" type=" xs:string " minOccurs="1" maxOccurs="1" nillable="false"/>
<xs:element name="stylesheet" type=" xs:string " minOccurs="0" maxOccurs="1" nillable="false"/>
<xs:element name="dna-command-enabled" minOccurs="1" maxOccurs="1" nillable="false">
<xs:complexType>
<xs:simpleContent>
<xs:extension base=" xs:boolean "/>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="features-strictly-enclosed" minOccurs="1" maxOccurs="1" nillable="false">
<xs:complexType>
<xs:simpleContent>
<xs:extension base=" xs:boolean "/>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="use-feature-id-for-feature-label" minOccurs="1" maxOccurs="1" nillable="false">
<xs:complexType>
<xs:simpleContent>
<xs:extension base=" xs:boolean "/>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="include-types-with-zero-count" minOccurs="1" maxOccurs="1" nillable="false">
<xs:complexType>
<xs:simpleContent>
<xs:extension base=" xs:boolean "/>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="property" type=" propertyType " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="id" type=" xs:string " use="required"/>
<xs:attribute name="name" type=" xs:string " use="required"/>
<xs:attribute name="version" type=" xs:string " use="optional"/>
<xs:attribute name="mapmaster" type=" xs:string " use="required"/>
<xs:attribute name="description" type=" xs:string " use="optional"/>
<xs:attribute name="description-href" type=" xs:string " use="optional"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Global Definitions

Complex Type: propertyType

Super-types: None
Sub-types: None
Name propertyType
Used by (from the same schema document) Element mydasserver , Element mydasserver
Abstract no
XML Instance Representation
<...
key=" xs:string [1]

'Properties will be made available to the DataSource developer as a java.util.Map of keys and values, with this attribute containing the key.'

"

value=" xs:string [1]

'Properties will be made available to the DataSource developer as a java.util.Map of keys and values, with this attribute containing the value.'

"
/>
Diagram
Schema Component Representation
<xs:complexType name="propertyType">
<xs:attribute name="key" type=" xs:string " use="required"/>
<xs:attribute name="value" type=" xs:string " use="required"/>
</xs: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