diff gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/GNVArtifactContext.java @ 791:23877dd69444

Added javadoc in Context package. gnv-artifacts/trunk@873 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Wed, 31 Mar 2010 09:30:34 +0000
parents c4156275c1e1
children 22c18083225e
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/GNVArtifactContext.java	Wed Mar 31 09:13:33 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/GNVArtifactContext.java	Wed Mar 31 09:30:34 2010 +0000
@@ -13,6 +13,12 @@
 import org.w3c.dom.Document;
 
 /**
+ * This class defines some final fields used to store some meta information
+ * required during the  work with an artifact into a context object which is
+ * available in each request specified in
+ * {@link de.intevation.gnv.artifacts.Artifacts} and further methods called by
+ * those.
+ *
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
@@ -24,79 +30,150 @@
      */
     private static Logger log = Logger.getLogger(GNVArtifactContext.class);
 
+    /**
+     *
+     */
     public static final String CHART_TEMPLATE_KEY =
         "gnv.chart.template";
 
+    /**
+     *
+     */
     public static final String HORIZONTAL_CROSS_SECTION_PROFILE_SAMPLES_KEY =
         "gnv.horizontal.cross.section.profile.samples";
 
+    /**
+     *
+     */
     public static final String HORIZONTAL_CROSS_SECTION_SAMPLES_KEY =
         "gnv.horizontal.cross.section.samples";
 
+    /**
+     *
+     */
     public static final String HORIZONTAL_CROSS_SECTION_EXTRAPOLATION_ROUNDS_KEY =
         "gnv.horizontal.cross.section.extrapolation.rounds";
 
+    /**
+     *
+     */
     public static final String
         HORIZONTAL_CROSS_SECTION_RESULT_SHAPEFILE_PATH_KEY =
         "gnv.horizontal.cross.section.result.shapefile";
 
+    /**
+     *
+     */
     public static final File
         DEFAULT_HORIZONTAL_CROSS_SECTION_PROFILE_SHAPEFILE_PATH =
         new File(System.getProperty("java.io.tmpdir"));
 
+    /**
+     *
+     */
     public static final Integer
         DEFAULT_HORIZONTAL_CROSS_SECTION_PROFILE_SAMPLES = Integer.valueOf(250);
 
+    /**
+     *
+     */
     public static final Integer
         DEFAULT_HORIZONTAL_CROSS_SECTION_SAMPLES = Integer.valueOf(1024);
 
+    /**
+     *
+     */
     public static final Integer
         DEFAULT_HORIZONTAL_CROSS_SECTION_EXTRAPOLATION_ROUNDS = Integer.valueOf(0);
 
+    /**
+     *
+     */
     public static final String HORIZONTAL_CROSS_SECTION_GROUND_INTERPOLATION_KEY =
         "gnv.horizontal.cross.section.ground.interpolation";
 
+    /**
+     *
+     */
     public static final String DEFAULT_HORIZONTAL_CROSS_SECTION_GROUND_INTERPOLATION =
         "bilinear";
 
+    /**
+     *
+     */
     public static final String PALETTES_KEY =
         "gnv.color.palettes";
 
+    /**
+     *
+     */
     public static final String VERTICAL_CROSS_SECTION_SAMPLES_KEY =
         "gnv.vertical.cross.section.samples";
 
+    /**
+     *
+     */
     public static final Dimension DEFAULT_VERTICAL_CROSS_SECTION_SAMPLES =
         new Dimension(1024, 768);
 
+    /**
+     *
+     */
     public static final String VERTICAL_CROSS_SECTION_FILTER_FACTORIES_KEY =
         "gnv.vertical.cross.section.filter.factories";
 
+    /**
+     *
+     */
     public static final String VERTICAL_CROSS_SECTION_GROUND_INTERPOLATION_KEY =
         "gnv.vertical.cross.section.ground.interpolation";
 
+    /**
+     *
+     */
     public static final String DEFAULT_VERTICAL_CROSS_SECTION_GROUND_INTERPOLATION =
         "bilinear";
 
+    /**
+     *
+     */
     public static final String VERTICAL_CROSS_SECTION_GROUND_FILL_KEY =
         "gnv.vertical.cross.section.ground.fill";
 
+    /**
+     *
+     */
     public static final String MAPSERVER_SERVER_PATH_KEY =
         "mapserver.server.path";
 
+    /**
+     *
+     */
     public static final String MAPSERVER_MAP_PATH_KEY =
         "mapserver.map.path";
 
+    /**
+     *
+     */
     public static final Paint DEFAULT_VERTICAL_CROSS_SECTION_GROUND_FILL =
         new Color(0x7c8683);
 
+    /**
+     *
+     */
     public GNVArtifactContext() {
         super();
         log.debug("GNVArtifactContext.Constructor");
     }
 
+    /**
+     *
+     * @param config
+     */
     public GNVArtifactContext(Document config) {
         super(config);
         log.debug("GNVArtifactContext.Constructor(config)");
     }
 
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org