Added todo element (child of documentation) to DTD. Upversioned to 1.4.2
This commit is contained in:
parent
5868215e6b
commit
b4b20d1d7a
628
resources/schemas/adl-1.4.2.dtd
Normal file
628
resources/schemas/adl-1.4.2.dtd
Normal file
|
|
@ -0,0 +1,628 @@
|
||||||
|
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
|
||||||
|
<!-- -->
|
||||||
|
<!-- adl-1.4.2.dtd -->
|
||||||
|
<!-- -->
|
||||||
|
<!-- Purpose: -->
|
||||||
|
<!-- Document Type Description for Application Description -->
|
||||||
|
<!-- Language. Normative for now; will be replaced by a schema. ` -->
|
||||||
|
<!-- -->
|
||||||
|
<!-- Author: Simon Brooke <simon@journeyman.cc> -->
|
||||||
|
<!-- Created: 3rd June 2018 -->
|
||||||
|
<!-- Copyright: (c) 2018 Simon Brooke -->
|
||||||
|
<!-- -->
|
||||||
|
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
|
||||||
|
|
||||||
|
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
|
||||||
|
<!-- Before we start: import XHTML for use in documentation sections -->
|
||||||
|
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
|
||||||
|
|
||||||
|
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
|
||||||
|
<!-- Before we start: some useful definitions -->
|
||||||
|
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
|
||||||
|
|
||||||
|
<!-- some basic character entities inherited from HTML. Actually we probably ought to
|
||||||
|
import all the HTML4 character entity files, and possibly the HTML4 Strict DTD (so
|
||||||
|
that we can allow HTML block level entities within content elements -->
|
||||||
|
<!ENTITY nbsp " ">
|
||||||
|
<!ENTITY pound "£">
|
||||||
|
<!ENTITY copy "©">
|
||||||
|
|
||||||
|
|
||||||
|
<!-- boolean means true or false -->
|
||||||
|
<!ENTITY % Boolean "(true|false)" >
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Locale is a string comprising an ISO 639 language code followed by a space
|
||||||
|
followed by an ISO 3166 country code, or else the string 'default'. See:
|
||||||
|
<URL:http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt>
|
||||||
|
<URL:http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html>
|
||||||
|
-->
|
||||||
|
<!ENTITY % Locale "CDATA" >
|
||||||
|
|
||||||
|
<!--
|
||||||
|
permissions a group may have on an entity, list, page, form or field
|
||||||
|
permissions are deemed to increase as you go right. A group cannot
|
||||||
|
have greater permission on a field than on the form it is in, or
|
||||||
|
greater permission on form than the entity it belongs to
|
||||||
|
|
||||||
|
none: none
|
||||||
|
read: select
|
||||||
|
insert: insert
|
||||||
|
noedit: select, insert
|
||||||
|
edit: select, insert, update
|
||||||
|
all: select, insert, update, delete
|
||||||
|
-->
|
||||||
|
<!ENTITY % Permissions "none|read|insert|noedit|edit|all" >
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
actions which should be cascaded to dependent objects. All these values except
|
||||||
|
'manual' are taken from Hibernate and should be passed through the adl2hibernate
|
||||||
|
mapping transparently. Relevent only for properties with type='entity', type='link'
|
||||||
|
and type='list'
|
||||||
|
|
||||||
|
all : cascade delete, save and update
|
||||||
|
all-delete-orphan : see hibernate documentation; relates to transient objects only
|
||||||
|
delete : cascade delete actions, but not save and update
|
||||||
|
manual : cascading will be handled in manually managed code, code to
|
||||||
|
handle cascading should not be generated
|
||||||
|
save-update : cascade save and update actions, but not delete.
|
||||||
|
-->
|
||||||
|
<!ENTITY % CascadeActions "all|all-delete-orphan|delete|manual|save-update">
|
||||||
|
|
||||||
|
<!--
|
||||||
|
data types which can be used in a typedef to provide validation -
|
||||||
|
e.g. a string can be used with a regexp or a scalar can be used with
|
||||||
|
min and max values
|
||||||
|
string: varchar java.sql.Types.VARCHAR
|
||||||
|
integer: int java.sql.Types.INTEGER
|
||||||
|
real: double java.sql.Types.DOUBLE
|
||||||
|
money: money java.sql.Types.INTEGER
|
||||||
|
date: date java.sql.Types.DATE
|
||||||
|
time: time java.sql.Types.TIME
|
||||||
|
timestamp: timestamp java.sql.Types.TIMESTAMP
|
||||||
|
uploadable: varchar java.sql.Types.VARCHAR
|
||||||
|
image: varchar java.sql.Types.VARCHAR
|
||||||
|
|
||||||
|
uploadable is as string but points to an uploaded file; image is as
|
||||||
|
uploadable but points to an uploadable graphical image file
|
||||||
|
-->
|
||||||
|
<!ENTITY % DefinableDataTypes "string|integer|real|money|date|time|timestamp|uploadable" >
|
||||||
|
|
||||||
|
<!--
|
||||||
|
data types which are fairly straightforward translations of JDBC data types
|
||||||
|
boolean: boolean or java.sql.Types.BIT
|
||||||
|
char(1) java.sql.Types.CHAR
|
||||||
|
text: text or java.sql.Types.LONGVARCHAR
|
||||||
|
memo java.sql.Types.CLOB
|
||||||
|
-->
|
||||||
|
<!ENTITY % SimpleDataTypes "%DefinableDataTypes;|boolean|text" >
|
||||||
|
|
||||||
|
<!--
|
||||||
|
data types which are more complex than SimpleDataTypes...
|
||||||
|
entity : a foreign key link to another entity (i.e. the 'many' end of a
|
||||||
|
one-to-many link);
|
||||||
|
list : a list of some other entity that links to me (i.e. the 'one' end of
|
||||||
|
a one-to-many link);
|
||||||
|
link : a many to many link (via a link table);
|
||||||
|
defined : a type defined by a typedef.
|
||||||
|
-->
|
||||||
|
<!ENTITY % ComplexDataTypes "entity|link|list|defined" >
|
||||||
|
|
||||||
|
<!--
|
||||||
|
data types which require special handling - which don't simply map onto
|
||||||
|
common SQL data types
|
||||||
|
geopos : a latitude/longitude pair (experimental and not yet implemented)
|
||||||
|
image : a raster image file, in jpeg|gif|png format (experimental, not yet implemented)
|
||||||
|
message : an internationalised message, having different translations for different locales
|
||||||
|
-->
|
||||||
|
<!ENTITY % SpecialDataTypes "geopos|image|message" >
|
||||||
|
|
||||||
|
<!-- all data types -->
|
||||||
|
<!ENTITY % AllDataTypes "%ComplexDataTypes;|%SimpleDataTypes;|%SpecialDataTypes;" >
|
||||||
|
|
||||||
|
<!-- content, for things like pages (i.e. forms, lists, pages) -->
|
||||||
|
<!ENTITY % Content "head|top|foot" >
|
||||||
|
|
||||||
|
<!ENTITY % FieldStuff "field|fieldgroup|auxlist|verb">
|
||||||
|
|
||||||
|
<!ENTITY % PageContent "%Content;|%FieldStuff;" >
|
||||||
|
|
||||||
|
<!ENTITY % PageStuff "%PageContent;|permission|pragma" >
|
||||||
|
|
||||||
|
<!-- Properties for pages:
|
||||||
|
name: obviously, the name (URL stub) of the page
|
||||||
|
properties: the properties of the entity the page describes to be shown
|
||||||
|
as fields on the page
|
||||||
|
all: obviously, all properties (except the abstract primary key, if
|
||||||
|
present)
|
||||||
|
user-distinct: all properties which are user-distinct (NOTE: Not yet implemented)
|
||||||
|
listed: only those properties for which fields are explicitly listed
|
||||||
|
-->
|
||||||
|
<!ENTITY % PageAttrs
|
||||||
|
"name CDATA #REQUIRED
|
||||||
|
properties (all|user-distinct|listed) #REQUIRED" >
|
||||||
|
|
||||||
|
<!-- Actions for generators (mainly for keyfields - see entity 'generator', below
|
||||||
|
assigned: In manually-maintained code, you contract to assign a value
|
||||||
|
to this property before it is persisted.
|
||||||
|
guid: The system will supply a unique GUid value to this field
|
||||||
|
before it is persisted.
|
||||||
|
mannual: You contract to supply a generator class in manually maintained
|
||||||
|
code.
|
||||||
|
native: The database will supply a unique value to this field when it
|
||||||
|
is persisted; the value will be an integer. RECOMMENDED!
|
||||||
|
-->
|
||||||
|
<!ENTITY % GeneratorActions "assigned|guid|manual|native">
|
||||||
|
|
||||||
|
<!-- sequences for orderings of lists - see entity 'order'
|
||||||
|
canonical: Whatever the normal canonical ordering for this datatype is -
|
||||||
|
typically alpha-numeric, except for dates, etc.
|
||||||
|
reverse-canonical: The reverse of the above
|
||||||
|
|
||||||
|
possibly there should be some further values but I have no idea what these are
|
||||||
|
-->
|
||||||
|
<!ENTITY % Sequences "canonical|reverse-canonical">
|
||||||
|
|
||||||
|
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
|
||||||
|
<!-- Elements -->
|
||||||
|
<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
|
||||||
|
|
||||||
|
<!--
|
||||||
|
the application that the document describes: required top level element
|
||||||
|
|
||||||
|
name: the name of this application
|
||||||
|
version: the version number of this application
|
||||||
|
revision: the revision of the ADL document
|
||||||
|
currency: the base monetary currency, in the form of an ISO 4217 three-letter code
|
||||||
|
xmlns: XML namespace, in case required
|
||||||
|
-->
|
||||||
|
<!ELEMENT application ( specification*, documentation?, content?, typedef*, group*, entity*)>
|
||||||
|
<!ATTLIST application
|
||||||
|
name CDATA #REQUIRED
|
||||||
|
version CDATA #IMPLIED
|
||||||
|
revision CDATA #IMPLIED
|
||||||
|
currency CDATA #IMPLIED
|
||||||
|
xmlns CDATA #IMPLIED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
the definition of a defined type. At this stage a defined type is either
|
||||||
|
a string in which case it must have size and pattern, or
|
||||||
|
a scalar in which case it must have minimum and/or maximum
|
||||||
|
pattern must be a regular expression as interpreted by org.apache.regexp.RE
|
||||||
|
minimum and maximum must be of appropriate format for the datatype specified.
|
||||||
|
Validation may be done client-side and/or server-side at application layer
|
||||||
|
and/or server side at database layer.
|
||||||
|
|
||||||
|
name: the name of this typedef
|
||||||
|
type: the simple type on which this defined type is based; must be
|
||||||
|
present unless in-implementation children are supplied
|
||||||
|
size: the data size of this defined type
|
||||||
|
pattern: a regular expression which values for this type must match
|
||||||
|
minimum: the minimum value for this type (if base type is scalar)
|
||||||
|
maximum: the maximum value for this type (if base type is scalar)
|
||||||
|
-->
|
||||||
|
<!ELEMENT typedef (documentation?, in-implementation*, help*) >
|
||||||
|
|
||||||
|
<!ATTLIST typedef
|
||||||
|
name CDATA #REQUIRED
|
||||||
|
type (%DefinableDataTypes;) #IMPLIED
|
||||||
|
size CDATA #IMPLIED
|
||||||
|
pattern CDATA #IMPLIED
|
||||||
|
minimum CDATA #IMPLIED
|
||||||
|
maximum CDATA #IMPLIED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
information about how to translate a type into types known to different target
|
||||||
|
languages. TODO: Once again I'm not wholly comfortable with the name; I'm not
|
||||||
|
really comfortable that this belongs in ADL at all.
|
||||||
|
|
||||||
|
target: the target language
|
||||||
|
value: the type to use in that target language
|
||||||
|
kind: OK, I confess I don't understand this, but Andrew needs it...
|
||||||
|
-->
|
||||||
|
<!ELEMENT in-implementation (documentation?)>
|
||||||
|
|
||||||
|
<!ATTLIST in-implementation
|
||||||
|
target CDATA #REQUIRED
|
||||||
|
value CDATA #REQUIRED
|
||||||
|
kind CDATA #IMPLIED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
a group of people with similar permissions to one another
|
||||||
|
|
||||||
|
name: the name of this group
|
||||||
|
parent: the name of a group of which this group is subset
|
||||||
|
-->
|
||||||
|
<!ELEMENT group (documentation?)>
|
||||||
|
|
||||||
|
<!ATTLIST group
|
||||||
|
name CDATA #REQUIRED
|
||||||
|
parent CDATA #IMPLIED>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
an entity which has properties and relationships; maps onto a database
|
||||||
|
table or a Java serialisable class - or, of course, various other things
|
||||||
|
|
||||||
|
name: obviously, the name of this entity.
|
||||||
|
natural-key: if present, the name of a property of this entity which forms
|
||||||
|
a natural primary key [NOTE: Only partly implemented. NOTE: much of
|
||||||
|
the present implementation assumes all primary keys will be
|
||||||
|
integers. This needs to be fixed!] DEPRECATED: remove; replace with the
|
||||||
|
'key' element, below.
|
||||||
|
table: the name of the table in which this entity is stored. Defaults to same
|
||||||
|
as name of entity. Strongly recommend this is not used unless it needs
|
||||||
|
to be different from the name of the entity.
|
||||||
|
foreign: this entity is part of some other system; no code will be generated
|
||||||
|
for it, although code which links to it will be generated.
|
||||||
|
magnitude: The power of ten which approximates the expected number of records; thus
|
||||||
|
if ten records are expected, the magnitude is 1; if a million, the
|
||||||
|
magnitude is 6.
|
||||||
|
volatility: Number representing the anticipated rate of change of records in this
|
||||||
|
entity; if 0, results should never be cached; otherwise, a power of
|
||||||
|
10 representing the number of seconds the data may safely be cached.
|
||||||
|
thus 5 represents a cach time to live of 100,000 seconds, or slightly
|
||||||
|
more than one day.
|
||||||
|
-->
|
||||||
|
<!ELEMENT entity ( documentation?, prompt*, content?, key?,
|
||||||
|
property*, permission*, (form | page | list)*)>
|
||||||
|
<!ATTLIST entity
|
||||||
|
name CDATA #REQUIRED
|
||||||
|
natural-key CDATA #IMPLIED
|
||||||
|
table CDATA #IMPLIED
|
||||||
|
foreign %Boolean; #IMPLIED
|
||||||
|
magnitude CDATA #IMPLIED
|
||||||
|
volatility CDATA #IMPLIED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
contains documentation on the element which immediately contains it. TODO:
|
||||||
|
should HTML markup within a documentation element be allowed? If so, are
|
||||||
|
there restrictions? For now, no: instead I shall aim to support MarkDown
|
||||||
|
within documentation.
|
||||||
|
-->
|
||||||
|
<!ELEMENT documentation ( #PCDATA|reference|todo)*>
|
||||||
|
<!ATTLIST documentation
|
||||||
|
xmlns CDATA #IMPLIED>
|
||||||
|
|
||||||
|
<!-- a child of documentation, q.v., which allows TODO items to be identified.
|
||||||
|
-->
|
||||||
|
<!ELEMENT todo ( #PCDATA|reference)*>
|
||||||
|
<!ATTLIST todo
|
||||||
|
xmlns CDATA #IMPLIED>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- an explicit primary key, possibly compound -->
|
||||||
|
<!ELEMENT key (property*)>
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
a property (field) of an entity (table)
|
||||||
|
|
||||||
|
name: the name of this property.
|
||||||
|
type: the type of this property.
|
||||||
|
default: the default value of this property. There will probably be
|
||||||
|
magic values of this!
|
||||||
|
typedef: name of the typedef to use, it type = 'defined'.
|
||||||
|
distinct: distinct='system' required that every value in the system
|
||||||
|
will be distinct (i.e. natural primary key);
|
||||||
|
distinct='user' implies that the value may be used by users
|
||||||
|
in distinguishing entities even if values are not formally
|
||||||
|
unique;
|
||||||
|
distinct='all' implies that the values are formally unique
|
||||||
|
/and/ are user friendly (NOTE: not implemented).
|
||||||
|
entity: if type='entity', the name of the entity this property is
|
||||||
|
a foreign key link to.
|
||||||
|
if type='list', the name of the entity that has a foreign
|
||||||
|
key link to this entity
|
||||||
|
farkey: if type='list', the name of farside key in the listed
|
||||||
|
entity; if type='entity' and the farside field to join to
|
||||||
|
is not the farside primary key, then the name of that
|
||||||
|
farside field
|
||||||
|
required: whether this propery is required (i.e. 'not null').
|
||||||
|
immutable: if true, once a value has been set it cannot be changed.
|
||||||
|
size: fieldwidth of the property if specified.
|
||||||
|
concrete: if set to 'false', this property is not stored in the
|
||||||
|
database but must be computed (manually written code must
|
||||||
|
be provided to support this)
|
||||||
|
cascade: what action(s) on the parent entity should be cascaded to
|
||||||
|
entitie(s) linked on this property. Valid only if type='entity',
|
||||||
|
type='link' or type='list'.
|
||||||
|
column: name of the column in a SQL database table in which this property
|
||||||
|
is stored. TODO: Think about this.
|
||||||
|
unsaved-value:
|
||||||
|
of a property whose persistent value is set on first being
|
||||||
|
committed to persistent store, the value which it holds before
|
||||||
|
it has been committed
|
||||||
|
-->
|
||||||
|
<!ELEMENT property ( documentation?, generator?, (permission|option|prompt|help|ifmissing)*)>
|
||||||
|
|
||||||
|
<!ATTLIST property
|
||||||
|
name CDATA #REQUIRED
|
||||||
|
type (%AllDataTypes;) #REQUIRED
|
||||||
|
default CDATA #IMPLIED
|
||||||
|
typedef CDATA #IMPLIED
|
||||||
|
distinct (none|all|user|system) #IMPLIED
|
||||||
|
entity CDATA #IMPLIED
|
||||||
|
farkey CDATA #IMPLIED
|
||||||
|
required %Boolean; #IMPLIED
|
||||||
|
immutable %Boolean; #IMPLIED
|
||||||
|
size CDATA #IMPLIED
|
||||||
|
column CDATA #IMPLIED
|
||||||
|
concrete %Boolean; #IMPLIED
|
||||||
|
cascade (%CascadeActions;) #IMPLIED>
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
marks a property which is auto-generated by some part of the system.
|
||||||
|
This is based on the Hibernate construct, except that the Hibernate
|
||||||
|
implementation folds both its internal generators and custom generators
|
||||||
|
onto the same attribute. This separates them onto two attributes so we
|
||||||
|
can police values for Hibernate's 'builtin' generators.
|
||||||
|
|
||||||
|
action: one of the supported Hibernate builtin generators, or
|
||||||
|
'manual'. 'native' is strongly recommended in most instances
|
||||||
|
class: if action is 'manual', the name of a manually maintained
|
||||||
|
class conforming to the Hibernate IdentifierGenerator
|
||||||
|
interface, or its equivalent in other languages
|
||||||
|
-->
|
||||||
|
<!ELEMENT generator (documentation?, param*)>
|
||||||
|
<!ATTLIST generator
|
||||||
|
action (%GeneratorActions;) #REQUIRED
|
||||||
|
class CDATA #IMPLIED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
A parameter passed to the generator. Again, based on the Hibernate
|
||||||
|
implementation. TODO: #PCDATA is wrong as the content model, as embedded
|
||||||
|
markup is definitely not allowed!
|
||||||
|
|
||||||
|
name: the name of this parameter
|
||||||
|
|
||||||
|
TODO: This needs to be renamed or removed because it conflicts with the
|
||||||
|
XHTML element of the same name. In fact it could be simply removed since
|
||||||
|
our usage is compatible with the XHTML usage, but it might be less
|
||||||
|
ambiguous to rename it.
|
||||||
|
-->
|
||||||
|
<!ELEMENT param (#PCDATA)>
|
||||||
|
<!ATTLIST param
|
||||||
|
name CDATA #REQUIRED>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
one of an explicit list of optional values a property may have
|
||||||
|
NOTE: whether options get encoded at application layer or at database layer
|
||||||
|
is UNDEFINED; either behaviour is correct. If at database layer it's also
|
||||||
|
UNDEFINED whether they're encoded as a single reference data table or as
|
||||||
|
separate reference data tables for each property.
|
||||||
|
|
||||||
|
value: the value of this option
|
||||||
|
|
||||||
|
TODO: This needs to be renamed or removed because it conflicts with the
|
||||||
|
XHTML element of the same name. In fact it could be simply removed since
|
||||||
|
our usage is compatible with the XHTML usage, but it might be less
|
||||||
|
ambiguous to rename it.
|
||||||
|
-->
|
||||||
|
<!ELEMENT option (documentation?, prompt*)>
|
||||||
|
<!-- if the value is different from the prompt the user sees, specify it -->
|
||||||
|
<!ATTLIST option
|
||||||
|
value CDATA #IMPLIED>
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
permissions policy on an entity, a page, form, list or field
|
||||||
|
|
||||||
|
group: the group to which permission is granted
|
||||||
|
permission: the permission which is granted to that group
|
||||||
|
-->
|
||||||
|
<!ELEMENT permission (documentation?)>
|
||||||
|
<!ATTLIST permission
|
||||||
|
group CDATA #REQUIRED
|
||||||
|
permission (%Permissions;) #REQUIRED>
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
pragmatic advice to generators of lists and forms, in the form of
|
||||||
|
name/value pairs which may contain anything. Over time some pragmas
|
||||||
|
will become 'well known', but the whole point of having a pragma
|
||||||
|
architecture is that it is extensible.
|
||||||
|
-->
|
||||||
|
<!ELEMENT pragma (documentation?)>
|
||||||
|
<!ATTLIST pragma
|
||||||
|
name CDATA #REQUIRED
|
||||||
|
value CDATA #REQUIRED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
a prompt for a property or field; used as the prompt text for a widget
|
||||||
|
which edits it. Typically there will be only one of these per property
|
||||||
|
per locale; if there are more than one all those matching the locale may
|
||||||
|
be concatenated, or just one may be used.
|
||||||
|
|
||||||
|
prompt: the prompt to use
|
||||||
|
locale: the locale in which to prefer this prompt
|
||||||
|
-->
|
||||||
|
<!ELEMENT prompt (documentation?)>
|
||||||
|
<!ATTLIST prompt
|
||||||
|
prompt CDATA #REQUIRED
|
||||||
|
locale %Locale; #REQUIRED >
|
||||||
|
|
||||||
|
<!--
|
||||||
|
helptext about a property of an entity, or a field of a page, form or
|
||||||
|
list, or a typedef. Typically there will be only one of these per property
|
||||||
|
per locale; if there are more than one all those matching the locale may
|
||||||
|
be concatenated, or just one may be used.
|
||||||
|
|
||||||
|
locale: the locale in which to prefer this prompt
|
||||||
|
-->
|
||||||
|
<!ELEMENT help (#PCDATA)>
|
||||||
|
<!ATTLIST help
|
||||||
|
locale %Locale; #REQUIRED
|
||||||
|
xmlns CDATA #IMPLIED >
|
||||||
|
|
||||||
|
<!--
|
||||||
|
helpful text to be shown if a property value is missing, typically when
|
||||||
|
a form is submitted. Typically there will be only one of these per property
|
||||||
|
per locale; if there are more than one all those matching the locale may
|
||||||
|
be concatenated, or just one may be used. Later there may be more sophisticated
|
||||||
|
behaviour here.
|
||||||
|
-->
|
||||||
|
<!ELEMENT ifmissing (#PCDATA)>
|
||||||
|
<!ATTLIST ifmissing
|
||||||
|
locale %Locale; #REQUIRED
|
||||||
|
xmlns CDATA #IMPLIED>
|
||||||
|
|
||||||
|
<!-- a form through which an entity may be added or edited
|
||||||
|
|
||||||
|
TODO: This needs to be renamed because it conflicts with the
|
||||||
|
XHTML element of the same name.
|
||||||
|
-->
|
||||||
|
<!ELEMENT form (documentation?, ( %PageStuff;)*)>
|
||||||
|
<!ATTLIST form %PageAttrs;>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- a page on which an entity may be displayed -->
|
||||||
|
<!ELEMENT page (documentation?, ( %PageStuff;)*)>
|
||||||
|
<!ATTLIST page %PageAttrs;>
|
||||||
|
|
||||||
|
<!-- an ordering or records in a list
|
||||||
|
property: the property on which to order
|
||||||
|
sequence: the sequence in which to order
|
||||||
|
-->
|
||||||
|
<!ELEMENT order (documentation?)>
|
||||||
|
<!ATTLIST order
|
||||||
|
property CDATA #REQUIRED
|
||||||
|
sequence (%Sequences;) #IMPLIED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
a list on which entities of a given type are listed
|
||||||
|
|
||||||
|
onselect: name of form/page/list to go to when
|
||||||
|
a selection is made from the list
|
||||||
|
-->
|
||||||
|
<!ELEMENT list (documentation?, ( %PageStuff;|order)*)>
|
||||||
|
<!ATTLIST list %PageAttrs;
|
||||||
|
onselect CDATA #IMPLIED >
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
a subsidiary list, on which entities related to primary
|
||||||
|
entities in the enclosing page or list are listed
|
||||||
|
|
||||||
|
property: the property of the enclosing entity that this
|
||||||
|
list displays (obviously, must be of type='list')
|
||||||
|
onselect: the form or page of the listed entity to call
|
||||||
|
when an item from the list is selected
|
||||||
|
canadd: true if the user should be able to add records
|
||||||
|
to this list
|
||||||
|
-->
|
||||||
|
<!ELEMENT auxlist (documentation?, (prompt|%FieldStuff;)*)>
|
||||||
|
<!ATTLIST auxlist %PageAttrs;
|
||||||
|
property CDATA #REQUIRED
|
||||||
|
onselect CDATA #IMPLIED
|
||||||
|
canadd %Boolean; #IMPLIED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
a group of fields and other controls within a form or list, which the
|
||||||
|
renderer might render as a single pane in a tabbed display, for example.
|
||||||
|
-->
|
||||||
|
<!ELEMENT fieldgroup (documentation?, (prompt|permission|%FieldStuff;)*)>
|
||||||
|
<!ATTLIST fieldgroup
|
||||||
|
name CDATA #REQUIRED>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- a field in a form or page
|
||||||
|
|
||||||
|
property: the property which this field displays/edits
|
||||||
|
-->
|
||||||
|
<!ELEMENT field (documentation?, (prompt|help|permission)*) >
|
||||||
|
<!ATTLIST field
|
||||||
|
property CDATA #REQUIRED >
|
||||||
|
|
||||||
|
<!-- a verb is something that may be done through a form. Probably the verbs 'store'
|
||||||
|
and 'delete' are implied, but maybe they need to be explicitly declared. The 'verb'
|
||||||
|
attribute of the verb is what gets returned to the controller -->
|
||||||
|
<!ELEMENT verb (documentation?, (prompt|help|permission)*) >
|
||||||
|
<!ATTLIST verb
|
||||||
|
verb CDATA #REQUIRED
|
||||||
|
dangerous %Boolean; #REQUIRED>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- a container for global content -->
|
||||||
|
<!ELEMENT content (%Content;)*>
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
content to place in the head of the generated document; this is #PCDATA
|
||||||
|
because it will almost certainly belong to a different namespace
|
||||||
|
(usually HTML)
|
||||||
|
|
||||||
|
TODO: This needs to be renamed or removed because it conflicts with the
|
||||||
|
XHTML element of the same name. In fact it could be simply removed since
|
||||||
|
our usage is compatible with the XHTML usage, but it might be less
|
||||||
|
ambiguous to rename it.
|
||||||
|
-->
|
||||||
|
<!ELEMENT head (#PCDATA) >
|
||||||
|
<!ATTLIST head
|
||||||
|
xmlns CDATA #IMPLIED>
|
||||||
|
|
||||||
|
|
||||||
|
<!--
|
||||||
|
content to place in the top of the body of the generated document;
|
||||||
|
this is %Flow; which is any HTML block or inline level element.
|
||||||
|
-->
|
||||||
|
<!ELEMENT top (#PCDATA) >
|
||||||
|
<!ATTLIST top
|
||||||
|
xmlns CDATA #IMPLIED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
content to place at the foot of the body of the generated document;
|
||||||
|
this is %Flow; which is any HTML block or inline level element.
|
||||||
|
-->
|
||||||
|
<!ELEMENT foot (#PCDATA) >
|
||||||
|
<!ATTLIST foot
|
||||||
|
xmlns CDATA #IMPLIED>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
The 'specification' and 'reference' elements are for documentation only,
|
||||||
|
and do not contribute to the engineering of the application described.
|
||||||
|
|
||||||
|
A specification element is intended chiefly to declare the reference
|
||||||
|
documents which may be used in documentation elements later in the
|
||||||
|
document.
|
||||||
|
|
||||||
|
url: The URL from which the document referenced can be retrieved
|
||||||
|
name: The full name (title) given to this document
|
||||||
|
abbr: A convenient abbreviated name
|
||||||
|
-->
|
||||||
|
<!ELEMENT specification (documentation?, reference*)>
|
||||||
|
<!ATTLIST specification
|
||||||
|
url CDATA #IMPLIED
|
||||||
|
name CDATA #REQUIRED
|
||||||
|
abbr CDATA #REQUIRED
|
||||||
|
>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
The 'specification' and 'reference' elements are for documentation only,
|
||||||
|
and do not contribute to the engineering of the application described.
|
||||||
|
|
||||||
|
A reference element is a reference to a specifying document.
|
||||||
|
|
||||||
|
abbr: The abbreviated name of the specification to which this
|
||||||
|
reference refers
|
||||||
|
section: The 'anchor part' (part following a hash character) which,
|
||||||
|
when appended to the URL, will locate the exact section
|
||||||
|
referenced.
|
||||||
|
entity: A reference to another entity within this ADL document
|
||||||
|
property: A reference to another property within this ADL document;
|
||||||
|
if entity is also specified then of that entity, else of
|
||||||
|
the ancestor entity if any
|
||||||
|
-->
|
||||||
|
<!ELEMENT reference (documentation?)>
|
||||||
|
<!ATTLIST reference
|
||||||
|
abbr CDATA #IMPLIED
|
||||||
|
section CDATA #IMPLIED
|
||||||
|
entity CDATA #IMPLIED
|
||||||
|
property CDATA #IMPLIED
|
||||||
|
>
|
||||||
|
|
||||||
559
resources/schemas/adl-1.4.2.xsd
Normal file
559
resources/schemas/adl-1.4.2.xsd
Normal file
|
|
@ -0,0 +1,559 @@
|
||||||
|
<schema
|
||||||
|
xmlns='http://www.w3.org/2001/XMLSchema'
|
||||||
|
targetNamespace='http://www.w3.org/namespace/'
|
||||||
|
xmlns:t='http://www.w3.org/namespace/'>
|
||||||
|
|
||||||
|
<element name='application'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:specification' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:content' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:typedef' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
<element ref='t:group' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
<element ref='t:entity' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='version' type='string' use='optional'/>
|
||||||
|
<attribute name='revision' type='string' use='optional'/>
|
||||||
|
<attribute name='currency' type='string' use='optional'/>
|
||||||
|
<attribute name='xmlns' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='typedef'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:in-implementation' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
<element ref='t:help' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='type' use='optional'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='string'/>
|
||||||
|
<enumeration value='integer'/>
|
||||||
|
<enumeration value='real'/>
|
||||||
|
<enumeration value='money'/>
|
||||||
|
<enumeration value='date'/>
|
||||||
|
<enumeration value='time'/>
|
||||||
|
<enumeration value='timestamp'/>
|
||||||
|
<enumeration value='uploadable'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='size' type='string' use='optional'/>
|
||||||
|
<attribute name='pattern' type='string' use='optional'/>
|
||||||
|
<attribute name='minimum' type='string' use='optional'/>
|
||||||
|
<attribute name='maximum' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='in-implementation'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='target' type='string' use='required'/>
|
||||||
|
<attribute name='value' type='string' use='required'/>
|
||||||
|
<attribute name='kind' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='group'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='parent' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='entity'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:prompt' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
<element ref='t:content' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:key' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:property' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
<element ref='t:permission' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:form'/>
|
||||||
|
<element ref='t:page'/>
|
||||||
|
<element ref='t:list'/>
|
||||||
|
</choice>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='natural-key' type='string' use='optional'/>
|
||||||
|
<attribute name='table' type='string' use='optional'/>
|
||||||
|
<attribute name='foreign' use='optional'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='true'/>
|
||||||
|
<enumeration value='false'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='magnitude' type='string' use='optional'/>
|
||||||
|
<attribute name='volatility' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='documentation'>
|
||||||
|
<complexType mixed='true'>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:reference'/>
|
||||||
|
<element ref='t:todo'/>
|
||||||
|
</choice>
|
||||||
|
<attribute name='xmlns' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='todo'>
|
||||||
|
<complexType mixed='true'>
|
||||||
|
<sequence minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:reference'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='xmlns' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='key'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:property' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
</sequence>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='property'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:generator' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:permission'/>
|
||||||
|
<element ref='t:option'/>
|
||||||
|
<element ref='t:prompt'/>
|
||||||
|
<element ref='t:help'/>
|
||||||
|
<element ref='t:ifmissing'/>
|
||||||
|
</choice>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='type' use='required'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='entity'/>
|
||||||
|
<enumeration value='link'/>
|
||||||
|
<enumeration value='list'/>
|
||||||
|
<enumeration value='defined'/>
|
||||||
|
<enumeration value='string'/>
|
||||||
|
<enumeration value='integer'/>
|
||||||
|
<enumeration value='real'/>
|
||||||
|
<enumeration value='money'/>
|
||||||
|
<enumeration value='date'/>
|
||||||
|
<enumeration value='time'/>
|
||||||
|
<enumeration value='timestamp'/>
|
||||||
|
<enumeration value='uploadable'/>
|
||||||
|
<enumeration value='boolean'/>
|
||||||
|
<enumeration value='text'/>
|
||||||
|
<enumeration value='geopos'/>
|
||||||
|
<enumeration value='image'/>
|
||||||
|
<enumeration value='message'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='default' type='string' use='optional'/>
|
||||||
|
<attribute name='typedef' type='string' use='optional'/>
|
||||||
|
<attribute name='distinct' use='optional'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='none'/>
|
||||||
|
<enumeration value='all'/>
|
||||||
|
<enumeration value='user'/>
|
||||||
|
<enumeration value='system'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='entity' type='string' use='optional'/>
|
||||||
|
<attribute name='farkey' type='string' use='optional'/>
|
||||||
|
<attribute name='required' use='optional'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='true'/>
|
||||||
|
<enumeration value='false'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='immutable' use='optional'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='true'/>
|
||||||
|
<enumeration value='false'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='size' type='string' use='optional'/>
|
||||||
|
<attribute name='column' type='string' use='optional'/>
|
||||||
|
<attribute name='concrete' use='optional'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='true'/>
|
||||||
|
<enumeration value='false'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='cascade' use='optional'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='all'/>
|
||||||
|
<enumeration value='all-delete-orphan'/>
|
||||||
|
<enumeration value='delete'/>
|
||||||
|
<enumeration value='manual'/>
|
||||||
|
<enumeration value='save-update'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='generator'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:param' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='action' use='required'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='assigned'/>
|
||||||
|
<enumeration value='guid'/>
|
||||||
|
<enumeration value='manual'/>
|
||||||
|
<enumeration value='native'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='class' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='param'>
|
||||||
|
<complexType mixed='true'>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='option'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:prompt' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='value' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='permission'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='group' type='string' use='required'/>
|
||||||
|
<attribute name='permission' use='required'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='none'/>
|
||||||
|
<enumeration value='read'/>
|
||||||
|
<enumeration value='insert'/>
|
||||||
|
<enumeration value='noedit'/>
|
||||||
|
<enumeration value='edit'/>
|
||||||
|
<enumeration value='all'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='pragma'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='value' type='string' use='required'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='prompt'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='prompt' type='string' use='required'/>
|
||||||
|
<attribute name='locale' type='string' use='required'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='help'>
|
||||||
|
<complexType mixed='true'>
|
||||||
|
<attribute name='locale' type='string' use='required'/>
|
||||||
|
<attribute name='xmlns' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='ifmissing'>
|
||||||
|
<complexType mixed='true'>
|
||||||
|
<attribute name='locale' type='string' use='required'/>
|
||||||
|
<attribute name='xmlns' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='form'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:head'/>
|
||||||
|
<element ref='t:top'/>
|
||||||
|
<element ref='t:foot'/>
|
||||||
|
<element ref='t:field'/>
|
||||||
|
<element ref='t:fieldgroup'/>
|
||||||
|
<element ref='t:auxlist'/>
|
||||||
|
<element ref='t:verb'/>
|
||||||
|
<element ref='t:permission'/>
|
||||||
|
<element ref='t:pragma'/>
|
||||||
|
</choice>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='properties' use='required'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='all'/>
|
||||||
|
<enumeration value='user-distinct'/>
|
||||||
|
<enumeration value='listed'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='page'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:head'/>
|
||||||
|
<element ref='t:top'/>
|
||||||
|
<element ref='t:foot'/>
|
||||||
|
<element ref='t:field'/>
|
||||||
|
<element ref='t:fieldgroup'/>
|
||||||
|
<element ref='t:auxlist'/>
|
||||||
|
<element ref='t:verb'/>
|
||||||
|
<element ref='t:permission'/>
|
||||||
|
<element ref='t:pragma'/>
|
||||||
|
</choice>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='properties' use='required'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='all'/>
|
||||||
|
<enumeration value='user-distinct'/>
|
||||||
|
<enumeration value='listed'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='order'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='property' type='string' use='required'/>
|
||||||
|
<attribute name='sequence' use='optional'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='canonical'/>
|
||||||
|
<enumeration value='reverse-canonical'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='list'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:head'/>
|
||||||
|
<element ref='t:top'/>
|
||||||
|
<element ref='t:foot'/>
|
||||||
|
<element ref='t:field'/>
|
||||||
|
<element ref='t:fieldgroup'/>
|
||||||
|
<element ref='t:auxlist'/>
|
||||||
|
<element ref='t:verb'/>
|
||||||
|
<element ref='t:permission'/>
|
||||||
|
<element ref='t:pragma'/>
|
||||||
|
<element ref='t:order'/>
|
||||||
|
</choice>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='properties' use='required'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='all'/>
|
||||||
|
<enumeration value='user-distinct'/>
|
||||||
|
<enumeration value='listed'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='onselect' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='auxlist'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:prompt'/>
|
||||||
|
<element ref='t:field'/>
|
||||||
|
<element ref='t:fieldgroup'/>
|
||||||
|
<element ref='t:auxlist'/>
|
||||||
|
<element ref='t:verb'/>
|
||||||
|
</choice>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='properties' use='required'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='all'/>
|
||||||
|
<enumeration value='user-distinct'/>
|
||||||
|
<enumeration value='listed'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
<attribute name='property' type='string' use='required'/>
|
||||||
|
<attribute name='onselect' type='string' use='optional'/>
|
||||||
|
<attribute name='canadd' use='optional'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='true'/>
|
||||||
|
<enumeration value='false'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='fieldgroup'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:prompt'/>
|
||||||
|
<element ref='t:permission'/>
|
||||||
|
<element ref='t:field'/>
|
||||||
|
<element ref='t:fieldgroup'/>
|
||||||
|
<element ref='t:auxlist'/>
|
||||||
|
<element ref='t:verb'/>
|
||||||
|
</choice>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='field'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:prompt'/>
|
||||||
|
<element ref='t:help'/>
|
||||||
|
<element ref='t:permission'/>
|
||||||
|
</choice>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='property' type='string' use='required'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='verb'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:prompt'/>
|
||||||
|
<element ref='t:help'/>
|
||||||
|
<element ref='t:permission'/>
|
||||||
|
</choice>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='verb' type='string' use='required'/>
|
||||||
|
<attribute name='dangerous' use='required'>
|
||||||
|
<simpleType>
|
||||||
|
<restriction base='string'>
|
||||||
|
<enumeration value='true'/>
|
||||||
|
<enumeration value='false'/>
|
||||||
|
</restriction>
|
||||||
|
</simpleType>
|
||||||
|
</attribute>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='content'>
|
||||||
|
<complexType>
|
||||||
|
<choice minOccurs='0' maxOccurs='unbounded'>
|
||||||
|
<element ref='t:head'/>
|
||||||
|
<element ref='t:top'/>
|
||||||
|
<element ref='t:foot'/>
|
||||||
|
</choice>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='head'>
|
||||||
|
<complexType mixed='true'>
|
||||||
|
<attribute name='xmlns' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='top'>
|
||||||
|
<complexType mixed='true'>
|
||||||
|
<attribute name='xmlns' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='foot'>
|
||||||
|
<complexType mixed='true'>
|
||||||
|
<attribute name='xmlns' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='specification'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
<element ref='t:reference' minOccurs='0' maxOccurs='unbounded'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='url' type='string' use='optional'/>
|
||||||
|
<attribute name='name' type='string' use='required'/>
|
||||||
|
<attribute name='abbr' type='string' use='required'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
|
||||||
|
<element name='reference'>
|
||||||
|
<complexType>
|
||||||
|
<sequence>
|
||||||
|
<element ref='t:documentation' minOccurs='0' maxOccurs='1'/>
|
||||||
|
</sequence>
|
||||||
|
<attribute name='abbr' type='string' use='optional'/>
|
||||||
|
<attribute name='section' type='string' use='optional'/>
|
||||||
|
<attribute name='entity' type='string' use='optional'/>
|
||||||
|
<attribute name='property' type='string' use='optional'/>
|
||||||
|
</complexType>
|
||||||
|
</element>
|
||||||
|
</schema>
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
:author "Simon Brooke"}
|
:author "Simon Brooke"}
|
||||||
adl.to-swagger
|
adl.to-swagger
|
||||||
(:require [adl-support.utils :refer :all]
|
(:require [adl-support.utils :refer :all]
|
||||||
[adl.to-hugsql-queries :refer [queries]]
|
[adl.to-hugsql-queries :refer [generate-documentation queries]]
|
||||||
[clj-time.core :as t]
|
[clj-time.core :as t]
|
||||||
[clj-time.format :as f]
|
[clj-time.format :as f]
|
||||||
[clojure.java.io :refer [file make-parents writer]]
|
[clojure.java.io :refer [file make-parents writer]]
|
||||||
|
|
@ -43,21 +43,98 @@
|
||||||
(list
|
(list
|
||||||
'ns
|
'ns
|
||||||
(symbol (str (safe-name (:name (:attrs application))) ".routes.auto-api"))
|
(symbol (str (safe-name (:name (:attrs application))) ".routes.auto-api"))
|
||||||
(str "API routes for " (:name (:attrs application))
|
(str "Swagger routes for " (:name (:attrs application))
|
||||||
" auto-generated by [Application Description Language framework](https://github.com/simon-brooke/adl) at "
|
" auto-generated by [Application Description Language framework](https://github.com/simon-brooke/adl) at "
|
||||||
(f/unparse (f/formatters :basic-date-time) (t/now)))
|
(f/unparse (f/formatters :basic-date-time) (t/now)))
|
||||||
(list
|
(list
|
||||||
:require
|
:require
|
||||||
'[adl-support.core :as support]
|
'[reitit.swagger :as swagger]
|
||||||
'[clj-http.client :as client]
|
'[reitit.swagger-ui :as swagger-ui]
|
||||||
'[clojure.tools.logging :as log]
|
'[reitit.ring.coercion :as coercion]
|
||||||
'[compojure.api.sweet :refer :all]
|
'[reitit.coercion.spec :as spec-coercion]
|
||||||
'[hugsql.core :as hugsql]
|
'[reitit.ring.middleware.muuntaja :as muuntaja]
|
||||||
|
'[reitit.ring.middleware.multipart :as multipart]
|
||||||
|
'[reitit.ring.middleware.parameters :as parameters]
|
||||||
|
'[placenames.middleware.formats :as formats]
|
||||||
|
'[placenames.middleware.exception :as exception]
|
||||||
|
'[placenames.routes.auto-jason :as aj]
|
||||||
'[ring.util.http-response :refer :all]
|
'[ring.util.http-response :refer :all]
|
||||||
'[noir.response :as nresponse]
|
'[clojure.java.io :as io])))
|
||||||
'[noir.util.route :as route]
|
|
||||||
'[ring.util.http-response :as response]
|
|
||||||
'[schema.core :as s]
|
|
||||||
(vector (symbol (str (safe-name (:name (:attrs application))) ".db.core")) :as 'db))))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
(defn def-routes
|
||||||
|
"Generate Swagger routes for all queries implied by this ADL `application` spec."
|
||||||
|
;; THIS ISN'T NEARLY FINISHED!
|
||||||
|
([application]
|
||||||
|
(list 'defn 'auto-api-routes []
|
||||||
|
["/api"
|
||||||
|
{:coercion spec-coercion/coercion
|
||||||
|
:muuntaja formats/instance
|
||||||
|
:swagger {:id ::api}
|
||||||
|
:middleware [;; query-params & form-params
|
||||||
|
parameters/parameters-middleware
|
||||||
|
;; content-negotiation
|
||||||
|
muuntaja/format-negotiate-middleware
|
||||||
|
;; encoding response body
|
||||||
|
muuntaja/format-response-middleware
|
||||||
|
;; exception handling
|
||||||
|
exception/exception-middleware
|
||||||
|
;; decoding request body
|
||||||
|
muuntaja/format-request-middleware
|
||||||
|
;; coercing response bodys
|
||||||
|
coercion/coerce-response-middleware
|
||||||
|
;; coercing request parameters
|
||||||
|
coercion/coerce-request-middleware
|
||||||
|
;; multipart
|
||||||
|
multipart/multipart-middleware]}]
|
||||||
|
(map #(def-routes application %)
|
||||||
|
(children-with-tag application :entity)))
|
||||||
|
([application entity]
|
||||||
|
[(str "/" (safe-name entity))
|
||||||
|
{:get (make-get-route entity)
|
||||||
|
(cons
|
||||||
|
'defroutes
|
||||||
|
(cons
|
||||||
|
'auto-rest-routes
|
||||||
|
(map
|
||||||
|
#(let [handler (handlers-map %)]
|
||||||
|
(list
|
||||||
|
(symbol (s/upper-case (name (:method handler))))
|
||||||
|
(str "/json/auto/" (safe-name (:name handler)))
|
||||||
|
'request
|
||||||
|
(list
|
||||||
|
'route/restricted
|
||||||
|
(list (:name handler) 'request))))
|
||||||
|
(sort
|
||||||
|
(keys handlers-map)))))}])))
|
||||||
|
|
||||||
|
|
||||||
|
(defn to-swagger
|
||||||
|
"Generate a Swagger API for all queries implied by this ADL `application` spec."
|
||||||
|
[application]
|
||||||
|
(let [filepath (str
|
||||||
|
*output-path*
|
||||||
|
"src/"
|
||||||
|
(safe-name (:name (:attrs application)))
|
||||||
|
"/routes/auto_api.clj")]
|
||||||
|
(make-parents filepath)
|
||||||
|
(do-or-warn
|
||||||
|
(do
|
||||||
|
(spit
|
||||||
|
filepath
|
||||||
|
(s/join
|
||||||
|
"\n\n"
|
||||||
|
(cons
|
||||||
|
(file-header application)
|
||||||
|
(map
|
||||||
|
(fn [q]
|
||||||
|
(str
|
||||||
|
;; THIS ISN'T NEARLY FINISHED!
|
||||||
|
))
|
||||||
|
(sort
|
||||||
|
#(compare (:name %1) (:name %2))
|
||||||
|
(vals
|
||||||
|
(queries application)))))))
|
||||||
|
(if (pos? *verbosity*)
|
||||||
|
(*warn* (str "\tGenerated " filepath)))))))
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue