[Dive4elements-commits] [PATCH 2 of 4] MetaDataService: Document parameters string

[Wald Commits]

# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1359330323 -3600
# Node ID 9bddb6f5baa0e91c43427961d4dc46310db208d8
# Parent  c4973fa2367449876892077a3f665710c6a5647e
MetaDataService: Document parameters string.

diff -r c4973fa23674 -r 9bddb6f5baa0 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	Fri Jan 25 16:32:21 2013 +0100
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java	Mon Jan 28 00:45:23 2013 +0100
@@ -33,7 +33,7 @@
  *  "/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.
+ *                                     filters to the templating, as "key:value;key2:value2"
  */
 public class MetaDataService
 extends      FLYSService
@@ -86,6 +86,14 @@
             artifactId, userId, outs, parameters, globalContext);
     }
 
+
+    /**
+     * Split parameterstring in the form of key1:value1;key2:value2
+     * into hash (key1->value1, key2->value2).
+     * @param parameters "key1:value1;key2:value2"
+     * @param data Map into wich to put parameter hash and return.
+     * @return parameter data
+     */
     protected static Map<String, Object> splitParameters(
         String              parameters,
         Map<String, Object> data