dive4elements/river: flys-artifacts/src/main/java/de/intevation/flys/exports/AbstractExporter.java annotate

annotate flys-artifacts/src/main/java/de/intevation/flys/exports/AbstractExporter.java @ 1979:a7c437c9547e

Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. flys-artifacts/trunk@3409 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Wed, 14 Dec 2011 10:20:56 +0000
parents	65f9d707caff
children	3ebbe497d7f7

rev	line source
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	1 package de.intevation.flys.exports;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	2
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	3 import java.io.IOException;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	4 import java.io.OutputStream;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	5 import java.io.OutputStreamWriter;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	6
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	7 import org.w3c.dom.Document;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	8
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	9 import org.apache.log4j.Logger;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	10
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	11 import au.com.bytecode.opencsv.CSVWriter;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	12
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	13 import de.intevation.artifacts.Artifact;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	14 import de.intevation.artifacts.CallContext;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	15
1944 21a4d2c677a1 Changed doOut signature, side effect from blackboard feature (to come). Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1684 diff changeset	16 import de.intevation.artifactdatabase.state.ArtifactAndFacet;
1979 a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	17 import de.intevation.artifactdatabase.state.Settings;
695 45cd58a2a2bb OutGenerators doOut() takes a facet object now instead of just its name. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 445 diff changeset	18
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	19 import de.intevation.artifacts.common.ArtifactNamespaceContext;
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	20 import de.intevation.artifacts.common.utils.XMLUtils;
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	21
416 340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	22 import de.intevation.flys.artifacts.resources.Resources;
340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	23
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	24
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	25 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	26 * An abstract exporter that implements some basic methods for exporting data of
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	27 * artifacts.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	28 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	29 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	30 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	31 public abstract class AbstractExporter implements OutGenerator {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	32
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	33 /** The logger used in this exporter.*/
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	34 private static Logger logger = Logger.getLogger(AbstractExporter.class);
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	35
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	36
1160 efe1b8545f5c Cosmetics Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 710 diff changeset	37 /** The name of the CSV facet which triggers the CSV creation. */
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	38 public static final String FACET_CSV = "csv";
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	39
1160 efe1b8545f5c Cosmetics Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 710 diff changeset	40 /** The default charset for the CSV export. */
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	41 public static final String DEFAULT_CSV_CHARSET = "UTF-8";
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	42
1160 efe1b8545f5c Cosmetics Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 710 diff changeset	43 /** The default separator for the CSV export. */
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	44 public static final char DEFAULT_CSV_SEPARATOR = ',';
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	45
1160 efe1b8545f5c Cosmetics Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 710 diff changeset	46 /** XPath that points to the desired export facet. */
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	47 public static final String XPATH_FACET = "/art:action/@art:type";
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	48
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	49
1160 efe1b8545f5c Cosmetics Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 710 diff changeset	50 /** The document of the incoming out() request. */
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	51 protected Document request;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	52
1160 efe1b8545f5c Cosmetics Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 710 diff changeset	53 /** The output stream where the data should be written to. */
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	54 protected OutputStream out;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	55
1160 efe1b8545f5c Cosmetics Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 710 diff changeset	56 /** The CallContext object. */
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	57 protected CallContext context;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	58
1160 efe1b8545f5c Cosmetics Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 710 diff changeset	59 /** The selected facet. */
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	60 protected String facet;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	61
1160 efe1b8545f5c Cosmetics Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 710 diff changeset	62 /** The master artifact. */
412 046bd86ae41d Improved the OutGenerator interface to set a master artifact for the out generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 391 diff changeset	63 protected Artifact master;
046bd86ae41d Improved the OutGenerator interface to set a master artifact for the out generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 391 diff changeset	64
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	65
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	66 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	67 * Concrete subclasses need to use this method to write their special data
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	68 * objects into the CSV document.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	69 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	70 * @param writer The CSVWriter.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	71 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	72 protected abstract void writeCSVData(CSVWriter writer);
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	73
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	74
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	75 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	76 * This method enables concrete subclasses to collected its own special
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	77 * data.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	78 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	79 * @param artifacts The artifact that stores the data that has to be
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	80 * exported.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	81 */
701 dad1a2c88f9f Base WST/CSV exports on facets. TODO: generate the facets. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 695 diff changeset	82 protected abstract void addData(Object data);
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	83
710 cded0924193d Added generator and facet for error reports. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 701 diff changeset	84 @Override
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	85 public void init(Document request, OutputStream out, CallContext context) {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	86 logger.debug("AbstractExporter.init");
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	87
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	88 this.request = request;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	89 this.out = out;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	90 this.context = context;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	91 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	92
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	93
710 cded0924193d Added generator and facet for error reports. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 701 diff changeset	94 @Override
412 046bd86ae41d Improved the OutGenerator interface to set a master artifact for the out generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 391 diff changeset	95 public void setMasterArtifact(Artifact master) {
046bd86ae41d Improved the OutGenerator interface to set a master artifact for the out generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 391 diff changeset	96 this.master = master;
046bd86ae41d Improved the OutGenerator interface to set a master artifact for the out generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 391 diff changeset	97 }
046bd86ae41d Improved the OutGenerator interface to set a master artifact for the out generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 391 diff changeset	98
046bd86ae41d Improved the OutGenerator interface to set a master artifact for the out generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 391 diff changeset	99
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	100 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	101 * This doOut() just collects the data of multiple artifacts. Therefore, it
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	102 * makes use of the addData() method which enables concrete subclasses to
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	103 * store its data on its own. The real output creation takes place in the
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	104 * concrete generate() methods.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	105 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	106 * @param artifact The artifact.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	107 * @param facet The facet to add - NOTE: the facet needs to fit to the first
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	108 * facet inserted into this exporter. Otherwise this artifact/facet is
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	109 * skipped.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	110 * @param attr The attr document.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	111 */
710 cded0924193d Added generator and facet for error reports. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 701 diff changeset	112 @Override
1684 bdb05dc9b763 Bugfix: #353 Enabled chart's to be drawn with proper axes set even if no data is contained. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1160 diff changeset	113 public void doOut(
1944 21a4d2c677a1 Changed doOut signature, side effect from blackboard feature (to come). Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1684 diff changeset	114 ArtifactAndFacet artifactFacet,
21a4d2c677a1 Changed doOut signature, side effect from blackboard feature (to come). Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1684 diff changeset	115 Document attr,
21a4d2c677a1 Changed doOut signature, side effect from blackboard feature (to come). Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1684 diff changeset	116 boolean visible
1684 bdb05dc9b763 Bugfix: #353 Enabled chart's to be drawn with proper axes set even if no data is contained. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1160 diff changeset	117 ) {
1944 21a4d2c677a1 Changed doOut signature, side effect from blackboard feature (to come). Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1684 diff changeset	118 String name = artifactFacet.getFacetName();
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	119
695 45cd58a2a2bb OutGenerators doOut() takes a facet object now instead of just its name. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 445 diff changeset	120 logger.debug("AbstractExporter.doOut: " + name);
45cd58a2a2bb OutGenerators doOut() takes a facet object now instead of just its name. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 445 diff changeset	121
45cd58a2a2bb OutGenerators doOut() takes a facet object now instead of just its name. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 445 diff changeset	122 if (!isFacetValid(name)) {
45cd58a2a2bb OutGenerators doOut() takes a facet object now instead of just its name. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 445 diff changeset	123 logger.warn("Facet '" + name + "' not valid. No output created!");
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	124 return;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	125 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	126
1944 21a4d2c677a1 Changed doOut signature, side effect from blackboard feature (to come). Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1684 diff changeset	127 addData(artifactFacet.getData(context));
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	128 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	129
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	130
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	131 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	132 * Generates an export based on a specified facet.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	133 */
710 cded0924193d Added generator and facet for error reports. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 701 diff changeset	134 @Override
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	135 public void generate()
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	136 throws IOException
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	137 {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	138 logger.debug("AbstractExporter.generate");
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	139
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	140 if (facet != null && facet.equals(FACET_CSV)) {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	141 generateCSV();
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	142 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	143 else {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	144 throw new IOException("invalid facet for exporter.");
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	145 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	146 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	147
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	148
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	149 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	150 * Determines if the desired facet is valid for this exporter. If no facet
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	151 * is currently set, <i>facet</i> is set.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	152 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	153 * @param facet The desired facet.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	154 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	155 * @return true, if <i>facet</i> is valid, otherwise false.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	156 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	157 protected boolean isFacetValid(String facet) {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	158 logger.debug("AbstractExporter.isFacetValid");
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	159
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	160 String thisFacet = getFacet();
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	161
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	162 if (thisFacet == null \|\| thisFacet.length() == 0) {
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	163 return false;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	164 }
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	165 else if (facet == null \|\| facet.length() == 0) {
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	166 return false;
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	167 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	168 else {
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	169 return thisFacet.equals(facet);
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	170 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	171 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	172
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	173
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	174 /**
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	175 * Returns the name of the desired facet.
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	176 *
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	177 * @return the name of the desired facet.
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	178 */
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	179 protected String getFacet() {
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	180 if (facet == null) {
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	181 facet = getFacetFromRequest();
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	182 }
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	183
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	184 return facet;
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	185 }
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	186
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	187
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	188 /**
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	189 * Extracts the name of the requested facet from request document.
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	190 *
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	191 * @return the name of the requested facet.
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	192 */
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	193 protected String getFacetFromRequest() {
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	194 return XMLUtils.xpathString(
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	195 request, XPATH_FACET, ArtifactNamespaceContext.INSTANCE);
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	196 }
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	197
416 340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	198
340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	199 protected String msg(String key, String def) {
340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	200 return Resources.getMsg(context.getMeta(), key, def);
340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	201 }
340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	202
340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	203
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	204 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	205 * This method starts CSV creation. It makes use of writeCSVData() which has
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	206 * to be implemented by concrete subclasses.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	207 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	208 protected void generateCSV()
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	209 throws IOException
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	210 {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	211 logger.info("AbstractExporter.generateCSV");
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	212
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	213 CSVWriter writer = new CSVWriter(
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	214 new OutputStreamWriter(
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	215 out,
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	216 DEFAULT_CSV_CHARSET),
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	217 DEFAULT_CSV_SEPARATOR);
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	218
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	219 writeCSVData(writer);
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	220
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	221 writer.close();
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	222 }
1979 a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	223
a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	224
a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	225 /**
a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	226 * Returns an instance of <i>EmptySettings</i> currently!
a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	227 *
a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	228 * @return an instance of <i>EmptySettings</i>.
a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	229 */
a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	230 public Settings getSettings() {
a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	231 return new EmptySettings();
a7c437c9547e Added a getSettings() operation to OutGenerator - FLYSArtifactCollection will now evaluate all available Outputs and create initial Settings using OutGenerators if the Settings for an Output is missing. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1948 diff changeset	232 }
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	233 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	234 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > river

annotate flys-artifacts/src/main/java/de/intevation/flys/exports/AbstractExporter.java @ 1979:a7c437c9547e