dive4elements/gnv-client: gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/GNVArtifactContextFactory.java comparison

comparison gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/GNVArtifactContextFactory.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	feae2f9d6c6f

comparison

equal deleted inserted replaced

-:f198e4620546
+:23877dd69444
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.NodeList;
 /**
+* This factory class is used to create new GNVArtfactContext objects,
+* initialize required components and put them into the created context object
+* for being available in the application.
+*
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 * @author <a href="mailto:iweinzierl@intevation.de">Ingo Weinzierl</a>
 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
 */
 public class GNVArtifactContextFactory implements ArtifactContextFactory {
 /**
 * the logger, used to log exceptions and additonaly information
 */
 private static Logger log = Logger.getLogger(GNVArtifactContext.class);
+/**
+*
+*/
 public static final String XPATH_GEOBACKEND_CONFIGURATION =
 "artifact-database/geo-backend/backend-configuration";
+/**
+*
+*/
 public static final String XPATH_GEOBACKEND_QUERYCONFIGURATION =
 "artifact-database/geo-backend/query-configuration";
 private final static String CACHECONFIGNODEPATH =
 "/artifact-database/ehcache/configuration";
 private final static String CHARTCONFIGNODEPATH =
 "/artifact-database/gnv/charttemplate/configuration";
+/**
+*
+*/
 public final static String PALETTES_PATH =
 "/artifact-database/gnv/palettes";
+/**
+*
+*/
 public final static String PALETTE_ITEMS =
 "palette";
+/**
+*
+*/
 public final static String HORIZONTAL_CROSS_SECTION_PROFILE_SAMPLES =
 "/artifact-database/gnv/horizontal-cross-section-profile/samples/@number";
+/**
+*
+*/
 public final static String HORIZONTAL_CROSS_SECTION_GROUND_INTERPOLATION =
 "/artifact-database/gnv/horizontal-cross-section/ground/@interpolation";
+/**
+*
+*/
 public final static String HORIZONTAL_CROSS_SECTION_SAMPLES =
 "/artifact-database/gnv/horizontal-cross-section/samples/@number";
+/**
+*
+*/
 public final static String HORIZONTAL_CROSS_SECTION_EXTRAPOLATION_ROUNDS =
 "/artifact-database/gnv/horizontal-cross-section/extrapolation/@rounds";
+/**
+*
+*/
 public final static String HORIZONTAL_CROSS_SECTION_RESULT_SHAPEFILE_PATH =
 "/artifact-database/gnv/shapefile-directory/@path";
+/**
+*
+*/
 public final static String VERTICAL_CROSS_SECTION_SAMPLES =
 "/artifact-database/gnv/vertical-cross-section/samples";
+/**
+*
+*/
 public final static String VERTICAL_CROSS_SECTION_FILTERS =
 "/artifact-database/gnv/vertical-cross-section/filters/filter";
+/**
+*
+*/
 public final static String VERTICAL_CROSS_SECTION_GROUND_INTERPOLATION =
 "/artifact-database/gnv/vertical-cross-section/ground/@interpolation";
+/**
+*
+*/
 public final static String VERTICAL_CROSS_SECTION_GROUND_FILL_COLOR =
 "/artifact-database/gnv/vertical-cross-section/ground/@fill-color";
+/**
+*
+*/
 public final static String XPATH_MAPSERVER_PATH =
 "/artifact-database/mapserver/server/@path";
+/**
+*
+*/
 public final static String XPATH_MAP_PATH =
 "/artifact-database/mapserver/map/@path";
 /**
 * Constructor
 super();
 log.debug("GNVArtifactContextFactory.Constructor");
 }
 /**
+* Create a new {@link GNVArtifactContext} object and initialize all
+* components required by the application.
+*
+* @param config
+* @return GNVArtifactContext
 * @see de.intevation.artifacts.ArtifactContextFactory#createArtifactContext(org.w3c.dom.Document)
 */
 public Object createArtifactContext(Document config) {
 GNVArtifactContext returnValue = null;
 try {
 log.error(e, e);
 }
 return returnValue;
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureVerticalCrossSection(
 Document           config,
 GNVArtifactContext context
 ) {
 log.info("configuration of vertical cross section");
 configureVerticalCrossSectionGroundInterpolation(config, context);
 configureVerticalCrossSectionGroundFillColor(config, context);
 }
+/**
+*
+* @param config
+*/
 protected void configureCache(Document config) {
 String cacheConfigurationFile = Config.getStringXPath(
 config, CACHECONFIGNODEPATH);
 if (cacheConfigurationFile != null
 CacheFactory cf = CacheFactory.getInstance();
 cf.initializeCache(cacheConfigurationFile);
 }
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureVerticalCrossSectionGroundFillColor(
 Document           config,
 GNVArtifactContext context
 ) {
 log.info("configuration of vertical cross section ground fill color");
 GNVArtifactContext
 .VERTICAL_CROSS_SECTION_GROUND_FILL_KEY,
 fill);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureVerticalCrossSectionGroundInterpolation(
 Document           config,
 GNVArtifactContext context
 ) {
 log.info("configuration of vertical cross section ground interpolation");
 GNVArtifactContext
 .VERTICAL_CROSS_SECTION_GROUND_INTERPOLATION_KEY,
 interpolation);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureVerticalCrossSectionFilters(
 Document           config,
 GNVArtifactContext context
 ) {
 log.info("configuration of vertical cross section filters");
 context.put(
 GNVArtifactContext.VERTICAL_CROSS_SECTION_FILTER_FACTORIES_KEY,
 Collections.unmodifiableList(filterFactories));
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureVerticalCrossSectionSamples(
 Document           config,
 GNVArtifactContext context
 ) {
 log.info("configuration of vertical cross section samples");
 GNVArtifactContext.VERTICAL_CROSS_SECTION_SAMPLES_KEY,
 sampleSize);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureHorizontalCrossSectionProfile(
 Document           config,
 GNVArtifactContext context
 )
 {
 context.put(
 GNVArtifactContext.HORIZONTAL_CROSS_SECTION_PROFILE_SAMPLES_KEY,
 samples);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureHorizontalCrossSection(
 Document           config,
 GNVArtifactContext context
 ) {
 log.info("configuration of horizontal cross section");
 configureHorizontalCrossSectionExtrapolation(config, context);
 configureHorizontalCrossSectionResultShapeFilePath(config, context);
 configureHorizontalCrossSectionGroundInterpolation(config, context);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureHorizontalCrossSectionExtrapolation(
 Document           config,
 GNVArtifactContext context
 )
 {
 GNVArtifactContext
 .HORIZONTAL_CROSS_SECTION_EXTRAPOLATION_ROUNDS_KEY,
 extrapolationRounds);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureHorizontalCrossSectionGroundInterpolation(
 Document           config,
 GNVArtifactContext context
 )
 {
 GNVArtifactContext
 .HORIZONTAL_CROSS_SECTION_GROUND_INTERPOLATION_KEY,
 interpolation);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureHorizontalCrossSectionResultShapeFilePath(
 Document           config,
 GNVArtifactContext context
 )
 {
 GNVArtifactContext
 .HORIZONTAL_CROSS_SECTION_RESULT_SHAPEFILE_PATH_KEY,
 dir);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureHorizontalCrossSectionSamples(
 Document           config,
 GNVArtifactContext context
 )
 {
 GNVArtifactContext.HORIZONTAL_CROSS_SECTION_SAMPLES_KEY,
 samples);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureChartTemplate(
 Document           config,
 GNVArtifactContext context
 ) {
 log.info("Initialisation of chart template");
 }
 context.put(GNVArtifactContext.CHART_TEMPLATE_KEY, theme);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configurePalettes(
 Document           config,
 GNVArtifactContext context
 ) {
 log.info("configure palettes");
 context.put(GNVArtifactContext.PALETTES_KEY, palettes);
 }
+/**
+*
+* @param config
+* @param context
+*/
 protected void configureMapserver(
 Document           config,
 GNVArtifactContext context
 ) {
 log.info("read configuration of mapserver.");
 context.put(GNVArtifactContext.MAPSERVER_MAP_PATH_KEY, mapPath);
 }
 }
 /**
-* @param filePath
+* Read some properties from config file specified by <code>filePath</code>.
-* @return
+*
-* @throws FileNotFoundException
+* @param filePath Path to a cofig file.
-* @throws IOException
+* @return Properties contained in <code>filePath</code>.
+* @throws FileNotFoundException if file specified by filePath is not
+* existing.
+* @throws IOException if an error occured while reading from file.
 */
 private Properties getProperties(String filePath)
 throws FileNotFoundException, IOException
 {
 InputStream inputStream = null;
 catch (IOException ioe) {}
 }
 }
 }
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > gnv-client

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