Mercurial > dive4elements > river
comparison flys-artifacts/doc/datacage.txt @ 3033:aba4104f41c9
Added stub for datacage configuration documentation.
flys-artifacts/trunk@4602 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Felix Wolfsteller <felix.wolfsteller@intevation.de> |
|---|---|
| date | Wed, 06 Jun 2012 10:02:54 +0000 |
| parents | |
| children | 6a37a0134409 |
comparison
equal
deleted
inserted
replaced
| 3032:8a24c1a7ae40 | 3033:aba4104f41c9 |
|---|---|
| 1 The datacages behaviour is defined in the file conf/meta-data.xml . | |
| 2 | |
| 3 The datacage serves two purposes. | |
| 4 It handles automatic 'recommendations', which are instructions | |
| 5 sent by the client to add newly created artifacts to the collection. | |
| 6 From a user perspective, these artifacts mainly represent curves or data | |
| 7 points in the resulting diagrams. | |
| 8 The second task is to let the user add already existing artifacts (i.e. | |
| 9 previous calculations) or new artifacts with access to related data. | |
| 10 | |
| 11 Irrelevant of the type of elements (recommendations or user picked data) the | |
| 12 datacage can iterate over possible artifacts by accessing its own database. | |
| 13 Thus, to create a list of matching entries, database queries are used. | |
| 14 | |
| 15 In meta-data.xml, database queries are defined as <dc:statement> elements, | |
| 16 for example | |
| 17 <dc:statement> | |
| 18 SELECT id AS prot_id, | |
| 19 description AS prot_description | |
| 20 FROM wsts WHERE kind = 1 AND river_id = ${river_id} | |
| 21 </dc:statement> | |
| 22 | |
| 23 As can be seen from the example, the datacage configuration file can maintain | |
| 24 its own stack of variables (${river_id} in above example). |