changeset 1628:16c74ca3586e

Cosmetics, docs. flys-artifacts/trunk@2803 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Wed, 21 Sep 2011 14:01:14 +0000
parents d1b20d0e9eb4
children 4aec853a2f85
files flys-artifacts/ChangeLog flys-artifacts/src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java flys-artifacts/src/main/java/de/intevation/flys/collections/AttributeWriter.java flys-artifacts/src/main/java/de/intevation/flys/collections/FLYSArtifactCollection.java
diffstat 4 files changed, 39 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/flys-artifacts/ChangeLog	Wed Sep 21 13:53:09 2011 +0000
+++ b/flys-artifacts/ChangeLog	Wed Sep 21 14:01:14 2011 +0000
@@ -1,3 +1,12 @@
+2011-09-21  Felix Wolfsteller <felix.wolfsteller@intevation.de>
+
+ Cosmetics, docs.
+
+	* src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java,
+	  src/main/java/de/intevation/flys/collections/AttributeWriter.java,
+	  src/main/java/de/intevation/flys/collections/FLYSArtifactCollection.java:
+	  Cosmetics, documentation.
+
 2011-09-21  Felix Wolfsteller <felix.wolfsteller@intevation.de>
 
  Added WaterlevelOut-processing ability to WDifferencesCurveGenerator.
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java	Wed Sep 21 13:53:09 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/FLYSArtifact.java	Wed Sep 21 14:01:14 2011 +0000
@@ -646,6 +646,10 @@
         return getCurrentStateId() + hash;
     }
 
+
+    /**
+     * Return List.
+     */
     protected List<Output> filterOutputs(List<Output> outs) {
 
         if (filterFacets == null || filterFacets.isEmpty()) {
--- a/flys-artifacts/src/main/java/de/intevation/flys/collections/AttributeWriter.java	Wed Sep 21 13:53:09 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/collections/AttributeWriter.java	Wed Sep 21 14:01:14 2011 +0000
@@ -37,6 +37,9 @@
     }
 
 
+    /**
+     * Create document
+     */
     protected Document write() {
         Document doc = XMLUtils.newDocument();
 
@@ -62,7 +65,12 @@
         return doc;
     }
 
-
+    /**
+     * @param doc  Document to add output nodes to
+     * @param outs Node in Document to add output nodes to
+     * @param a    the new output
+     * @param b    the old output
+     */
     protected void writeOutput(
         Document       doc,
         Node           outs,
@@ -86,6 +94,12 @@
     }
 
 
+    /**
+     * @param doc    Document to add facet nodes to
+     * @param output Node in Document to add facet nodes to
+     * @param a      the new facets
+     * @param b      the old facets
+     */
     protected void writeFacets(
         Document       doc,
         ElementCreator cr,
@@ -109,6 +123,10 @@
     }
 
 
+    /**
+     * @param a    new facets
+     * @param list old facets
+     */
     protected boolean mergeFacets(
         Document       doc,
         ElementCreator cr,
--- a/flys-artifacts/src/main/java/de/intevation/flys/collections/FLYSArtifactCollection.java	Wed Sep 21 13:53:09 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/collections/FLYSArtifactCollection.java	Wed Sep 21 14:01:14 2011 +0000
@@ -63,6 +63,9 @@
 
 
 
+    /**
+     * Return description Document for this collection.
+     */
     @Override
     public Document describe(CallContext context) {
         log.debug("FLYSArtifactCollection.describe: " + identifier);
@@ -299,6 +302,10 @@
     }
 
 
+    /**
+     * Return merged output document.
+     * @param items List of artifact uuids.
+     */
     protected Document buildOutAttributes(
         ArtifactDatabase db,
         CallContext      context,

http://dive4elements.wald.intevation.org