Application Description Language is an XML vocabulary, - defined in a Document Type Definition, which declaratively + defined in a Document Type Definition, which declaratively describes the entities in an application domain, their relationships, and their properties. Because ADL is defined in a formal definition which can be parsed by XML editors, any @@ -344,94 +225,50 @@ Schema, since it is desirable to be able to mix HTML in with ADL in the same document.
-ADL is thus a 'Fourth Generation Language' as understood in +
ADL is thus a 'Fourth Generation Language' as understood in the 1980s - an ultra-high level language for a specific problem - domain; but it is a purely declarative 4GL.
+ domain; but it is a purely declarative 4GL. -The Application Description Language Framework is principally a set of XSL transforms which transform a single ADL file into all the various source files required to build an - application.
+ application. -The average data driven web application comprises pages @@ -465,43 +302,27 @@ of application development so that we can devote more time to the fun, interesting and novel bits. It is not intended to be an academic, perfect, 100% solution - although for many - applications it may in practice be a 100% solution.
+ applications it may in practice be a 100% solution. -Thus to create a new application, all that should be necessary is to create a new ADL file, and to compile it using - a single, standardised [NAnt] (or [Ant]) build file using scripts already created + a single, standardised [NAnt] (or [Ant]) build file using scripts already created as part of the framework. All these scripts (with the exception of the PSQL one, which was pre-existing) have been created as - part of the C1873 - SRU - Hospitality + part of the C1873 - SRU - Hospitality contract, but they contain almost no SRU specific material (and what does exist has been designed to be factored out). Prototype 1 of the SRU Hospitality Application contains no hand-written code whatever - all the application code is automatically generated from the single ADL file. The one exception to this rule is the CSS stylesheet which provides - look-and-feel and branding.
+ look-and-feel and branding. -This means that it should be trivial to decide at some point in development of a project to manually modify and maintain - auto-generated code.
+ auto-generated code. -Currently the framework includes:
+Currently the framework includes:
-Transforms the ADL file into C# source files for classes - which describe the entities in a manner acceptable to NHibernate, a - widely used Object/Relational mapping layer.
+ which describe the entities in a manner acceptable to NHibernate, a + widely used Object/Relational mapping layer. -Transforms the ADL file into an SQL script in Microsoft SQL Server 2000 syntax which initialises the database required by the application, with all relationships, permissions, - referential integrity constraints and so on.
+ referential integrity constraints and so on. -Transforms the ADL file into Velocity - template files as used by the Monorail framework, one template each for all +
Transforms the ADL file into Velocity + template files as used by the Monorail framework, one template each for all the lists, forms and inspectors described in the - ADL.
+ ADL. -Transforms the ADL file into a series of C# source files for classes which are controllers as used by the Monorail - framework.
+ framework. -Transforms the ADL file into a Hibernate mapping file, used - by the Hibernate (Java) and NHibernate (C#) Object/Relational mapping + by the Hibernate (Java) and NHibernate (C#) Object/Relational mapping layers. This transform is relatively trivial, since ADL is not greatly different from being a superset of the Hibernate vocabulary - it describes the same sorts of things but in more - detail.
+ detail. -Transforms the ADL file into an SQL script in Postgres 7 +
Transforms the ADL file into an SQL script in Postgres 7 syntax which initialises the database required by the application, with all relationships, permissions, referential - integrity constraints and so on.
+ integrity constraints and so on. -However ADL wasn't originally conceived with Monorail in - mind. It was originally intended to generated LISP for CLHTTPD, and I have a half-finished set of + mind. It was originally intended to generated LISP for CLHTTPD, and I have a half-finished set of scripts to generate Java as part of the Jacquard2 project which I never finished. Because ADL is at a level of abstraction - considerably above any 3GL, it is inherently agnostic to what 3GL + considerably above any 3GL, it is inherently agnostic to what 3GL it is compiled down to - so that it would be as easy to write - transforms that compiled ADL to Struts or - Ruby on + transforms that compiled ADL to Struts or + Ruby on Rails as to C#/Monorail. More importantly, ADL isn't inherently limited to Web applications - it doesn't actually know anything about the Web. It should be possible to write transforms which compile ADL down to Windows native applications or to native applications for mobile phones (and, indeed, if we did have those transforms then we could make all - our applications platform agnostic).
+ our applications platform agnostic). -Although I've built experimental systems before using ADL, the SRU project is the first time I've really used it in anger. There are some features I need which it can't yet - represent.
+ represent. -For SRU, I have implemented an authentication model which @@ -784,21 +536,16 @@ layer.
ADL defines field-level permissions, but the current - controller generator does not implement this.
+ controller generator does not implement this. -Generically, with an entity form, one needs to be able to save the record being edited, and one (often) needs to be able to delete it. But sometimes one needs to be able to do other things. With SRU, for example, there is a need to be able to - export event data to Perfect Table Plan, and to reimport data + export event data to Perfect Table Plan, and to reimport data from Perfect Table Plan. This will need custom buttons on the event entity form, and will also need hand-written code at the controller layer to respond to those buttons.
@@ -807,12 +554,9 @@ interaction with the SRU, potentially many invitations. In order to access those invitations it will be necessary to associate lists of dependent records with forms. Currently ADL - cannot represent these. + cannot represent these. -At this stage I doubt whether there is much point in @@ -822,21 +566,15 @@ higher level of abstraction than current 3GLs. If using ADL does not save work, it isn't worth doing it in ADL; remember this is conceived as an 80/20 solution, and you need to be - prepared to write the 20 in something else.
+ prepared to write the 20 in something else. -This section of this document presents and comments on the - existing ADL document type definition (DTD).
+ existing ADL document type definition (DTD). -The DTD starts with some basic definitions
@@ -855,12 +593,9 @@ <URL:http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html> --> <!ENTITY % Locale "CDATA" > - + -Key to any data driven application is who has authority to do what to what: 'permissions'.
@@ -879,12 +614,9 @@ all: select, insert, update, delete --> <!ENTITY % Permissions "none|read|insert|noedit|edit|all" > - + -ADL needs to know what type of data can be stored on different properties of different entities. The data types were @@ -902,11 +634,9 @@ time: time java.sql.Types.TIME timestamp: timestamp java.sql.Types.TIMESTAMP --> - + -
However, in order to be able to do data validation, it's @@ -938,11 +668,9 @@ <!-- all data types --> <!ENTITY % AllDataTypes "%ComplexDataTypes;|%SimpleDataTypes;" > - + -
Pages in applications typically have common, often largely @@ -964,18 +692,12 @@ <!ENTITY % PageAttrs "name CDATA #REQUIRED properties (all|listed) #REQUIRED" > - + -
The top level element of an Application Description Language file is the application element:
@@ -985,12 +707,9 @@ <!ATTLIST application name CDATA #REQUIRED version CDATA #IMPLIED> - + -In order to be able to use defined types, you need to be able to provide definitions of these types:
@@ -1012,12 +731,9 @@ pattern CDATA #IMPLIED minimum CDATA #IMPLIED maximum CDATA #IMPLIED> - + -In order to be able to user permissions, we need to define who has those permissions. Groups in ADL map directly onto @@ -1030,12 +746,9 @@ <!ATTLIST group name CDATA #REQUIRED> <!-- the name of a group of which this group is subset --> <!ATTLIST group parent CDATA #IMPLIED> - + -
A thing-in-the-domain has properties. Things in the domain @@ -1087,12 +800,9 @@ required %Boolean; #IMPLIED size CDATA #IMPLIED> - + -
Sometimes a property has a constrained list of specific values; this is represented for example in the enumerated types @@ -1109,12 +819,9 @@ <!ELEMENT option (prompt*)> <!-- if the value is different from the prompt the user sees, specify it --> <!ATTLIST option value CDATA #IMPLIED> - + -
Permissions define policies to allow groups of users to access forms, pages, fields (not yet implemented) or entities. @@ -1135,12 +842,9 @@ group CDATA #REQUIRED permission (%Permissions;) #REQUIRED> - + -
Pragmas are currently not used at all. They are there as a possible means to provide additional controls on forms, but may @@ -1157,13 +861,9 @@ name CDATA #REQUIRED value CDATA #REQUIRED> - + -
The basic pages of the user interface. Pages and Forms by @@ -1287,20 +984,13 @@ --> <!ELEMENT foot (#PCDATA) > - + -
Current versions of ADL are given at the top of this @@ -1329,10 +1019,7 @@
To use ADL, it is currently most convenient to use NAnt. It is probably possible to do this with MSBuild, but as of yet I - don't know how.
+ don't know how. -For the examples given here to work, you will need to set up at least the following properties in your NAnt @@ -1448,12 +1120,9 @@ and your ADL file, respectively. Note that if it is to be used as an assembly name, the project name should include neither spaces, hyphens nor periods. If it must do so, you should give - an assembly name which does not, explicitly.
+ an assembly name which does not, explicitly. -The first thing you need to do with your ADL file is @@ -1469,13 +1138,9 @@ </parameters> </style> </target> - + -
<target name="sql" description="Generates cadlink database initialisation script"
@@ -1511,22 +1174,16 @@
</parameters>
</style>
</target>
-
+
- Note that for this to work you must have the following:
c:\Program
+ - 'Artistic Style' installed as
c:\Program
Files\astyle\bin\astyle.exe
@@ -1556,22 +1213,16 @@
destdir="${src.dir}/Entities"
pattern="cut here: next file '([a-zA-Z0-9_.]*)'"/>
</target>
-
+
- Note that for this to work you must have
c:\Program
+ - 'Artistic Style' installed as
c:\Program
Files\astyle\bin\astyle.exe
- The 'fetchtasks' target from the 'entity classes' stanza,
@@ -1600,13 +1251,9 @@
<split-regex in="${tmpdir}/controllers.auto.cs"
destdir="${controllers}/Auto" pattern="cut here: next file '([a-zA-Z0-9_.]*)'"/>
</target>
-
+
-
[edit]
+
Generate Velocity views for use with
Monorail
@@ -1617,7 +1264,7 @@
above.
<target name="views" description="creates Velocity templates"
depends="fetchtasks canonicalise">
diff --git a/documentation.css b/documentation.css
index a77f069..2f96cbf 100755
--- a/documentation.css
+++ b/documentation.css
@@ -1,43 +1,169 @@
- /******************************************************
- * Application Description Language framework
- * adl2documentation.xslt
- *
- * (c) 2007 Cygnet Solutions Ltd
- *
- * Produce basic documentation of an ADL file
- *
- * $Author: sb $
- * $Revision: 1.2 $
- *
- ******************************************************/
-
-BODY
+/************************************************************************\
+ * *
+ * weft.css *
+ * *
+ * Purpose: rational reconstruction of the lost Weft stylesheet. *
+ * *
+ * Author: Simon Brooke *
+ * Created: 2nd November 2013 *
+ * *
+\************************************************************************/
+
+body
{
- color: Black;
- background-color: White;
- font-family: Sans-Serif;
-}
-
-TD, TH
-{
- text-align: left;
- vertical-align: top;
- padding: 0.1em 0.5em;
+ background: white;
+ color: black;
+ font-family: helvetica, gill, ariel, sans-serif;
+ margin: 3em 20% 5em 20%;
+ width: 60%;
}
-.documentation
+
+a:link
{
- font-style: italic;
+ color: rgb( 64, 64, 64);
}
-.odd
+a:hover, a:active
{
- color: Black;
- background-color: rgb( 240, 240, 256);
+ background: silver;
}
-.even
+a:visited
{
- color: Black;
- background-color: rgb( 240, 256, 240);
-}
\ No newline at end of file
+ color: rgb( 128,128,192);
+}
+
+blockquote
+{
+ font-family: 'URW Chancery L', 'Monotype Corsiva', 'Apple Chancery', 'ITC Zapf Chancery', cursive;
+ font-weight: lighter;
+ font-style: italic;
+ color: rgb( 128,128,192);
+ margin-left: 0.5em;
+ margin-right: 1em;
+}
+
+footer {
+ font-size: smaller;
+ text-align: center;
+ bottom: 0;
+}
+
+header {
+ top: 0;
+}
+
+header, footer {
+ width: 100%;
+ position: fixed;
+ z-index: 149;
+ background-color: rgba( 255, 255, 255, 0.8);
+}
+
+h1 {
+ text-indent: -3em;
+ padding-left: 3em;
+ line-height: 130%;
+}
+
+h1, h2, h3, h4, h5, dt
+{
+ font-family: "Arial Black", Impact, sans-serif;
+ color: rgb( 128, 128, 128);
+ text-align: left;
+ margin-left: 0.5em;
+ margin-right: 1em;
+ font-weight: 900;
+}
+
+h1 em {
+ font-size: 200%;
+ vertical-align: top;
+}
+
+h1 strong {
+ font-size: 250%;
+}
+
+h1 em, h2 em, h3 em, h4 em, h5 em {
+ font-family: 'URW Chancery L', 'Monotype Corsiva', 'Apple Chancery', 'ITC Zapf Chancery', cursive;
+ font-weight: lighter;
+ font-style: italic;
+ color: rgb( 128,128,192);
+}
+
+h1, h2, h3, h4, h5 {
+}
+
+hr
+{
+ margin-left: 1em;
+ margin-right: 1em;
+ height: 1px;
+}
+
+p
+{
+ margin-left: 1em;
+ margin-right: 2em;
+ text-align: justify;
+ font-family: helvetica, gill, ariel, sans-serif;
+}
+
+ul.navbox {
+ margin: 0;
+ padding: 0;
+ list-style: none;
+}
+
+.copyright
+{
+ color: rgb( 128,128,192);
+ font-size: x-small;
+ text-align: center;
+}
+
+.logo
+{
+ color: rgb( 128,128,192);
+ font-style: normal;
+ float: left;
+}
+
+.help
+{
+ font-style: italic;
+ background: silver;
+}
+
+.daynum
+{
+ color: white;
+ background: rgb( 128,128,192);
+ font-weight: bold;
+}
+
+#nav {
+ margin: 0;
+ padding: 0;
+ width: 100%;
+ background:rgba(255,255,255,0.8);
+}
+
+#nav ul li {
+ padding: 0;
+ margin: 0;
+ display: inline;
+}
+
+#nav ul li a {
+ text-decoration: none;
+ font-weight: bold;
+ padding: 0.1em 0.75em;
+ margin: 0;
+}
+
+#nav ul li.active a { background: silver;}
+#nav ul li a:hover { background: silver; }
+#nav ul li a:active { background: gray; color: white; }
diff --git a/remove-edit-sections.xslt b/remove-edit-sections.xslt
new file mode 100644
index 0000000..adff59a
--- /dev/null
+++ b/remove-edit-sections.xslt
@@ -0,0 +1,16 @@
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/schemas/adl-1.4.dtd b/schemas/adl-1.4.dtd
index d8286e3..a5f9ae5 100755
--- a/schemas/adl-1.4.dtd
+++ b/schemas/adl-1.4.dtd
@@ -11,7 +11,7 @@
-
+
@@ -24,8 +24,8 @@
-
@@ -35,7 +35,7 @@ that we can allow HTML block level entities within content elements -->
-
-->
-
-->
-
-
-
present)
user-distinct: all properties which are user-distinct (NOTE: Not yet implemented)
listed: only those properties for which fields are explicitly listed
--->
-
+
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
-->
@@ -172,9 +172,9 @@ that we can allow HTML block level entities within content elements -->
-
xmlns: XML namespace, in case required
-->
-
-
-->
-
+ size CDATA #IMPLIED
+ pattern CDATA #IMPLIED
+ minimum CDATA #IMPLIED
+ maximum CDATA #IMPLIED>
@@ -232,28 +232,28 @@ that we can allow HTML block level entities within content elements -->
value CDATA #REQUIRED
kind CDATA #IMPLIED>
-
-
-
-->
-
-
-
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
+ 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
-->
-
entity CDATA #IMPLIED
farkey CDATA #IMPLIED
required %Boolean; #IMPLIED
- immutable %Boolean; #IMPLIED
+ immutable %Boolean; #IMPLIED
size CDATA #IMPLIED
column CDATA #IMPLIED
concrete %Boolean; #IMPLIED
cascade (%CascadeActions;) #IMPLIED>
-
@@ -360,15 +360,15 @@ that we can allow HTML block level entities within content elements -->
class CDATA #IMPLIED>
@@ -377,40 +377,40 @@ that we can allow HTML block level entities within content elements -->
-
-
-
-
name CDATA #REQUIRED
value CDATA #REQUIRED>
-
-
xmlns CDATA #IMPLIED >
@@ -472,7 +472,7 @@ that we can allow HTML block level entities within content elements -->
-
@@ -481,11 +481,11 @@ that we can allow HTML block level entities within content elements -->
property CDATA #REQUIRED
sequence (%Sequences;) #IMPLIED>
-
canadd %Boolean; #IMPLIED>
@@ -523,10 +523,10 @@ that we can allow HTML block level entities within content elements -->
property: the property which this field displays/edits
-->
-
-
@@ -539,14 +539,14 @@ that we can allow HTML block level entities within content elements -->
-
@@ -554,30 +554,30 @@ that we can allow HTML block level entities within content elements -->
xmlns CDATA #IMPLIED>
-
-
-
abbr CDATA #REQUIRED
>
-