Changes between Version 15 and Version 16 of JoinedResourceController

Timestamp:

11/19/09 10:18:27 (15 years ago)

Author:

Dominic König

Comment:

--

JoinedResourceController

@@ -3 +3 @@
 = Joined Resource Controller =
 
-  * Code: [https://code.launchpad.net/~flavour/sahana/sahanapy-trunk Main Trunk] Revision 280+
+  * Code: [https://code.launchpad.net/~flavour/sahana/sahanapy-trunk Main Trunk] Revision 358+
 
-This extends the single-table [wiki:BluePrintRESTImplementation REST Implementation] for requests for joined resources.
+== Architecture ==
 
-A joined resource request is a request for a resource ("joined resource") in dependency of a join to another table ("primary resource").
+''General:''
 
-In this implementation, these joins can be 1:1 or 1:N, and they can be natural joins (same key field in both tables) or primary/foreign key matches, where the primary key is always the 'id' field in the primary table.
+  * '''General:''' REST Interface <-> Front-End <-> Resource Controller <-> web2py backend
+  * '''JSON:''' REST Interface <-> JSON converter <-> XML Resource Controller <-> web2py DAL backend
+  * '''XML:''' REST Interface <-> XSLT Transformer <-> XML Resource Controller <-> web2py DAL backend
+  * '''HTML:''' REST Interface <-> web2py HTML frontend <-> CRUD Controller <-> web2py DAL backend
 
-The controller function for this is:
+The main controller function of the REST Interface is:
 
     * '''shn_rest_controller''' (defined in models/01_RESTlike_controller.py)
+
+The XML Interface supports in-line XSLT transformation in order to support various XML formats.
+
+== Joined Resources ==
+
+This extends the single-table [wiki:BluePrintRESTImplementation REST Implementation].
+
+A joined resource request is a request to a table ("joined resource" or "component") in dependency of a join to another table ("primary resource" or simply "resource"), e.g.:
+
+  * the list of addresses (=component) of a person (=resource).
+
+There are different ways how "Joined Resources" can be seen:
+
+a) as subtables of database tables
+b) as structured properties of object classes
+c) as component classes within data compounds
+
+In this implementation, component resources can be joined 1:1 or N:1 to their primary resources, either by natural joins (same key field in both tables) or primary/foreign key matches, where the primary key is always the 'id' field in the primary table.
 
 == Model ==
@@ -32 +53 @@
 
 # Joined Resource
-jrlayer.add_jresource(module, resource,
+s3xrc.model.add_component(module, resource,
     multiple=True,
     joinby='pr_pe_id',
@@ -55 +76 @@
 
 No definitions are required at the primary resource, just define the table as usual.
+
 == Controller ==