# HG changeset patch # User Felix Wolfsteller # Date 1338976974 0 # Node ID aba4104f41c936ca8ca007c3751c0a45cc46c88e # Parent 8a24c1a7ae404a225635a7257ddade2be66d6fec Added stub for datacage configuration documentation. flys-artifacts/trunk@4602 c6561f87-3c4e-4783-a992-168aeb5c3f6f diff -r 8a24c1a7ae40 -r aba4104f41c9 flys-artifacts/ChangeLog --- a/flys-artifacts/ChangeLog Wed Jun 06 09:21:24 2012 +0000 +++ b/flys-artifacts/ChangeLog Wed Jun 06 10:02:54 2012 +0000 @@ -1,3 +1,8 @@ +2012-06-06 Felix Wolfsteller + + * doc/datacage.txt: New file that will contain datacage configuration + documentation. + 2012-06-06 Raimund Renkert * doc/conf/artifacts/fixanalysis.xml: diff -r 8a24c1a7ae40 -r aba4104f41c9 flys-artifacts/doc/datacage.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/flys-artifacts/doc/datacage.txt Wed Jun 06 10:02:54 2012 +0000 @@ -0,0 +1,24 @@ +The datacages behaviour is defined in the file conf/meta-data.xml . + +The datacage serves two purposes. +It handles automatic 'recommendations', which are instructions +sent by the client to add newly created artifacts to the collection. +From a user perspective, these artifacts mainly represent curves or data +points in the resulting diagrams. +The second task is to let the user add already existing artifacts (i.e. +previous calculations) or new artifacts with access to related data. + +Irrelevant of the type of elements (recommendations or user picked data) the +datacage can iterate over possible artifacts by accessing its own database. +Thus, to create a list of matching entries, database queries are used. + +In meta-data.xml, database queries are defined as elements, +for example + + SELECT id AS prot_id, + description AS prot_description + FROM wsts WHERE kind = 1 AND river_id = ${river_id} + + +As can be seen from the example, the datacage configuration file can maintain +its own stack of variables (${river_id} in above example).