r5160 - in trunk/gnue-appserver: . doc/api doc/whitepaper

[reinhard]

Author: reinhard
Date: 2004-02-25 13:53:25 -0600 (Wed, 25 Feb 2004)
New Revision: 5160

Modified:
   trunk/gnue-appserver/BUGS
   trunk/gnue-appserver/doc/api/api.texi
   trunk/gnue-appserver/doc/api/version.texi
   trunk/gnue-appserver/doc/whitepaper/version.texi
   trunk/gnue-appserver/doc/whitepaper/whitepaper.texi
Log:
Documentation updates.


Modified: trunk/gnue-appserver/BUGS
===================================================================
--- trunk/gnue-appserver/BUGS   2004-02-25 17:22:27 UTC (rev 5159)
+++ trunk/gnue-appserver/BUGS   2004-02-25 19:53:25 UTC (rev 5160)
@@ -14,3 +14,6 @@
 * Not all strings are translatable, i.e. _() has to put around all strings
 
 * Module-, Class- and Propertynames must not contain non-ASCII characters
+
+* The class repository doesn't get along with properties that have set the
+  gnue_lenght or gnue_scale to NULL

Modified: trunk/gnue-appserver/doc/api/api.texi
===================================================================
--- trunk/gnue-appserver/doc/api/api.texi       2004-02-25 17:22:27 UTC (rev 
5159)
+++ trunk/gnue-appserver/doc/api/api.texi       2004-02-25 19:53:25 UTC (rev 
5160)
@@ -175,9 +175,8 @@
 @var{sort_order}.
 The properties in @var{sort_order} may, but need not appear in
 @var{properties}.
-If @var{classname}, @var{conditions}, @var{sort_order}, or @var{properties}
-contain not fully referenced identifiers for classes or properties, they
-are expanded using @var{context} as the current module context.
address@hidden, @var{conditions}, @var{sort_order}, and @var{properties}
+must contain fully referenced identifiers for classes or properties.
 
 This function only returns a list identifier.  No actual data is passed
 over the network when calling this function.
@@ -341,8 +340,8 @@
 
 @defcv Property gnue_property gnue_type string(35)
 The type of the property. This can be one of the predefined types "string",
-"number", "boolean" or "datetime", or the name of a class, in which case the
-property is a reference property to that class.
+"number", "boolean", "date", "time", or "datetime", or the name of a class,
+in which case the property is a reference property to that class.
 @end defcv
 
 @defcv Property gnue_property gnue_length number(6)
@@ -362,6 +361,35 @@
 
 @c ----------------------------------------------------------------------------
 
address@hidden @code{gnue_procedure}
+
address@hidden Property gnue_procedure gnue_class gnue_class
+The class the property belongs to.
address@hidden defcv
+
address@hidden Property gnue_procedure gnue_module gnue_module
+The module that defines the property.
address@hidden defcv
+
address@hidden Property gnue_procedure gnue_name string(35)
+The name of the property without the module name. You can find out the module
+name by referencing the @code{gnue_module} property.
address@hidden defcv
+
address@hidden Property gnue_procedure gnue_language string(10)
+Language of the procedure. Currently only "python" is valid.
address@hidden defcv
+
address@hidden Property gnue_procedure gnue_code string
+The source code of the procedure.
address@hidden defcv
+
address@hidden Property gnue_property gnue_comment string(70)
+Arbitary text explaining the purpose of the procedure.
address@hidden defcv
+
address@hidden 
----------------------------------------------------------------------------
+
 @section @code{gnue_useraccess}
 
 Note: This class is only preliminary and will most probably disappear in

Modified: trunk/gnue-appserver/doc/api/version.texi
===================================================================
--- trunk/gnue-appserver/doc/api/version.texi   2004-02-25 17:22:27 UTC (rev 
5159)
+++ trunk/gnue-appserver/doc/api/version.texi   2004-02-25 19:53:25 UTC (rev 
5160)
@@ -1,2 +1,2 @@
address@hidden UPDATED 2003-10-21
address@hidden EDITION 0.0.10
address@hidden UPDATED 2004-02-24
address@hidden EDITION 0.0.11

Modified: trunk/gnue-appserver/doc/whitepaper/version.texi
===================================================================
--- trunk/gnue-appserver/doc/whitepaper/version.texi    2004-02-25 17:22:27 UTC 
(rev 5159)
+++ trunk/gnue-appserver/doc/whitepaper/version.texi    2004-02-25 19:53:25 UTC 
(rev 5160)
@@ -1,2 +1,2 @@
address@hidden UPDATED 2003-10-18
address@hidden EDITION 0.0.10
address@hidden UPDATED 2004-02-24
address@hidden EDITION 0.0.11

Modified: trunk/gnue-appserver/doc/whitepaper/whitepaper.texi
===================================================================
--- trunk/gnue-appserver/doc/whitepaper/whitepaper.texi 2004-02-25 17:22:27 UTC 
(rev 5159)
+++ trunk/gnue-appserver/doc/whitepaper/whitepaper.texi 2004-02-25 19:53:25 UTC 
(rev 5160)
@@ -299,7 +299,8 @@
 @table @dfn
 
 @item Data Interface:
-abstracts database access from a specific database API and from SQL.
+abstracts database access from a specific database API and from SQL, and caches
+data to minimize database traffic.
 
 @item Code Interface:
 abstracts calls to methods from the language and the specific API.
@@ -360,27 +361,28 @@
 tables, reading of data and updating, adding and deleting of records in
 a table, all without SQL.
 
-Eventually, the Data Interface will support creating and extending tables
-"on the fly", which means that reading a recordset with attributes that
-don't exist in the database will automagically add the missing columns to
-the table.  This will, of course, be an optional feature that can be turned 
-off.
-
 The Data Interface operates strictly on a table/row interface and doesn't
 know anything about objects, properties and procedures.
 
-The Data Interface used in GNUe Appserver is part of GNUe Common.
+The Data Interface caches data read from the database backend as well as data
+modified through the RPC API. This does not only reduce the traffic between
+appserver and the database backend. Because the cache is shared between all
+cursors of a connection, updates done with cursor A become visible in cursor B
+immediately without re-issuing a query.
 
+The Data Interface used in GNUe Appserver uses GNUe Common's datasources system
+to communicate with the database.
+
 @c ----------------------------------------------------------------------------
 @node Code Interface,            Class Repository, Data Interface, Architecture
 @c ----------------------------------------------------------------------------
 
 @section Code Interface
 
-The Code Adapter will abstract the calls to business methods written in
-the different languages.
+The Code Adapter abstracts the calls to business methods written in the
+different languages.
 
-Python will be the only language supported for the near future. 
+Python is the only language supported for the near future. 
 
 The Code Adapter, or at least parts of it, will reside in GNUe Common.
 
@@ -390,13 +392,13 @@
 
 @section Class Repository
 
-The Class Repository will hold all the business object definitions:
+The Class Repository holds all the business object definitions:
 what properties the object consists of, what procedures exist, which
 bound procedures should be called on what event, and so on.
 
-The class definitions will be stored in the database and be accessible
-like normal business objects. Consequently, the Class Repository will
-access the definitions via the Python Language Interface.
+The class definitions are stored in the database and are accessible
+like normal business objects. Consequently, the Class Repository
+accesses the definitions via the Python Language Interface.
 
 @c ----------------------------------------------------------------------------
 @node Authentication Interface,   Object Server, Class Repository, Architecture
@@ -456,13 +458,13 @@
 
 @section Language Interface
 
-The Language Interface will make business objects easily accessible for code
-written in supported languages. Each language will have it's own Language
+The Language Interface makes business objects easily accessible for code
+written in supported languages. Each language has it's own Language
 Interface.
 
-For example, the Python Language Interface (which will be the first one
-implemented) lets you access business objects as if they are
-normal Python objects.  Procedures written in Python will use this
+For example, the Python Language Interface (which is the first and currently
+only one implemented) lets you access business objects as if they are
+normal Python objects.  Procedures written in Python use this
 interface to access business objects in a rather straightforward way.
 Other parts of the Application Server also use the Language Interface to
 access system objects like the ones defining classes or access rights.