source: trunk/src/core/net/sf/basedb/core/xsd/extensions.xsd @ 5607

<?xml version="1.0" encoding="UTF-8" ?>
<!--
  $Id: extensions.xsd 5607 2011-04-15 07:52:28Z nicklas $

  Copyright (C) Nicklas Nordborg

  This file is part of BASE - BioArray Software Environment.
  Available at http://base.thep.lu.se/

  BASE is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 3
  of the License, or (at your option) any later version.

  BASE is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with BASE. If not, see <http://www.gnu.org/licenses/>.
-->
<xsd:schema 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://base.thep.lu.se/extensions.xsd"
  xmlns="http://base.thep.lu.se/extensions.xsd"
  elementFormDefault="qualified"
  >
  <xsd:element name="extensions">
    <xsd:complexType>
      <xsd:sequence>
        <!-- global 'about' element -->
        <xsd:element name="about" type="aboutType" minOccurs="0" />
        
        <!-- 'extension-point' element -->
        <xsd:element name="extension-point" minOccurs="0" maxOccurs="unbounded">
          <xsd:complexType>
            <xsd:all>
              <xsd:element name="action-class" type="classNameType" />
              <xsd:element name="renderer-factory" minOccurs="0">
                <xsd:complexType>
                  <xsd:complexContent>
                    <xsd:extension base="factoryType">
                      <xsd:attribute name="override" type="xsd:boolean" default="true" />
                    </xsd:extension>
                  </xsd:complexContent>
                </xsd:complexType>
              </xsd:element>
              <xsd:element name="error-handler-factory" type="factoryType" minOccurs="0" />
              <xsd:element name="name" type="xsd:string" minOccurs="0" />
              <xsd:element name="description" type="xsd:string" minOccurs="0" />
            </xsd:all>
            <xsd:attribute name="id" type="xsd:ID" use="required" />
          </xsd:complexType>
        </xsd:element>
        
        <!-- 'extension' element -->
        <xsd:element name="extension" minOccurs="0" maxOccurs="unbounded">
          <xsd:complexType>
            <xsd:all>
              <xsd:element name="extends" minOccurs="0">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="ref" minOccurs="1" maxOccurs="unbounded">
                      <xsd:complexType>
                        <xsd:simpleContent>
                          <xsd:extension base="xsd:string">
                            <xsd:attribute name="index" type="xsd:float" />
                          </xsd:extension>
                        </xsd:simpleContent>
                      </xsd:complexType>
                    </xsd:element>
                  </xsd:sequence>
                </xsd:complexType>
              </xsd:element>
              <xsd:element name="action-factory" type="factoryType" />
              <xsd:element name="renderer-factory" type="factoryType" minOccurs="0" />
              <xsd:element name="about" type="aboutType" minOccurs="0" />
              <xsd:element name="index" type="xsd:float" minOccurs="0" />
            </xsd:all>
            <xsd:attribute name="id" type="xsd:ID" use="required" />
            <xsd:attribute name="extends" type="xsd:string" use="optional" />
          </xsd:complexType>
        </xsd:element>
      </xsd:sequence>
      <xsd:attribute name="id-base" type="xsd:ID" use="optional" />
    </xsd:complexType>
  </xsd:element>
  
  <!-- Type declarations -->
  <!-- A Java class name -->
  <xsd:simpleType name="classNameType">
    <xsd:restriction base="xsd:string">
    </xsd:restriction>
  </xsd:simpleType>
  
  <!-- Information about the authors of an extension -->
  <xsd:complexType name="aboutType">
    <xsd:all>
      <xsd:element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="description" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="version" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="min-base-version" type="baseVersionType" minOccurs="0" maxOccurs="1" />
      <xsd:element name="max-base-version" type="baseVersionType" minOccurs="0" maxOccurs="1" />
      <xsd:element name="copyright" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="contact" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="email" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="url" type="xsd:string" minOccurs="0" maxOccurs="1" />
    </xsd:all>
  </xsd:complexType>
  
  <!-- A string matching BASE version number with or without patch number -->
  <xsd:simpleType name="baseVersionType" >
    <xsd:restriction base="xsd:string">
      <xsd:pattern value="\d\.\d+\.?\d*"></xsd:pattern>
    </xsd:restriction>
  </xsd:simpleType>
  
  <!-- 
    A factory is the name of a factory class + optional initialisation 
    parameters that are set by reflection. Method name is 'set'+uppercase tagname.
    for example: <image>foo.png</image> results in a call to setImage("foo.png")
   -->
  <xsd:complexType name="factoryType">
    <xsd:sequence>
      <xsd:element name="factory-class" type="classNameType" minOccurs="1" maxOccurs="1" />
      <xsd:element name="parameters" minOccurs="0" maxOccurs="1">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:any minOccurs="0" maxOccurs="unbounded" processContents="skip" />
          </xsd:sequence>       
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>

</xsd:schema>