[Dive4elements-commits] [PATCH 4 of 5] MetaDataService: Added comment from ChangeLog

[Wald Commits]

# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1352985808 -3600
# Node ID b70dedac4c7e12cc1c355e37afeddbd81efa1c32
# Parent  cbd0fafcb26b559bb55da9c6d52c65cbd2077ea2
MetaDataService: Added comment from ChangeLog.

diff -r cbd0fafcb26b -r b70dedac4c7e flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java	Thu Nov 15 14:23:03 2012 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java	Thu Nov 15 14:23:28 2012 +0100
@@ -22,6 +22,19 @@
 
 import de.intevation.flys.artifacts.FLYSArtifact;
 
+
+/**
+ * Following XPaths are evaluated on the incoming document.
+ *
+ *  "/art:meta/art:artifact-id/@value" The UUID of the artifact. Optional.
+ *                                     Used to fill the template enviroment.
+ *  "/art:meta/art:user-id/@value"     The UUID of the user. Optional.
+ *                                     If given the user specific template is filled.
+ *  "/art:meta/art:outs/@value"        The list of outs used to recommend for the
+ *                                     various outputs.
+ *  "/art:meta/art:parameters/@value"  A list of key/value pairs to inject more
+ *                                     filters to the templating.
+ */
 public class MetaDataService
 extends      FLYSService
 {