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 @ 445:a7947972fdeb

Added a new class that supports formatters for different types of data. flys-artifacts/trunk@1937 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Tue, 17 May 2011 14:22:27 +0000
parents	e0fec407a280
children	45cd58a2a2bb

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
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	16 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	17 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	18
416 340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	19 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	20
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	21
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	22 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	23 * 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	24 * artifacts.
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 * @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	27 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	28 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	29
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	30 /** 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	31 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	32
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	33
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	34 /** The name of the CSV facet which triggers the CSV creation.*/
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	35 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	36
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	37 /** The default charset for the CSV export.*/
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 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	39
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	40 /** The default separator for the CSV export.*/
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 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	42
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	43 /** XPath that points to the desired export facet.*/
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	44 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	45
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	46
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	47 /** The document of the incoming out() request.*/
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	48 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	49
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	50 /** The output stream where the data should be written to.*/
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	51 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	52
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	53 /** The CallContext object.*/
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	54 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	55
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	56 /** The selected facet.*/
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	57 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	58
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	59 /** The master artifact.*/
046bd86ae41d Improved the OutGenerator interface to set a master artifact for the out generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 391 diff changeset	60 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	61
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	62
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	63 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	64 * 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	65 * 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	66 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	67 * @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	68 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	69 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	70
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 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	73 * 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	74 * data.
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 * @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	77 * exported.
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 protected abstract void addData(Artifact artifact);
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	80
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	81
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	82 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	83 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	84
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	85 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	86 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	87 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	88 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	89
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	90
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	91 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	92 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	93 }
046bd86ae41d Improved the OutGenerator interface to set a master artifact for the out generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 391 diff changeset	94
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
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	96 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	97 * 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	98 * 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	99 * 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	100 * 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	101 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	102 * @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	103 * @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	104 * 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	105 * skipped.
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	106 * @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	107 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	108 public void doOut(Artifact artifact, String facet, Document attr) {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	109 logger.debug("AbstractExporter.doOut: " + facet);
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	110
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	111 if (!isFacetValid(facet)) {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	112 logger.warn("Facet '" + facet + "' not valid. No output created!");
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	113 return;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	114 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	115
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	116 addData(artifact);
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	117 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	118
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	119
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	120 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	121 * 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	122 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	123 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	124 throws IOException
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 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	127
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	128 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	129 generateCSV();
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 else {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	132 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	133 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	134 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	135
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	136
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 * 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	139 * 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	140 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	141 * @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	142 *
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	143 * @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	144 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	145 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	146 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	147
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	148 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	149
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	150 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	151 return false;
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	152 }
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	153 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	154 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	155 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	156 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	157 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	158 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	159 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	160
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	161
445 a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	162 /**
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	163 * 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	164 *
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	165 * @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	166 */
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	167 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	168 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	169 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	170 }
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	171
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	172 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	173 }
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
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 * 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	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 * @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	180 */
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	181 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	182 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	183 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	184 }
a7947972fdeb Added a new class that supports formatters for different types of data. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 418 diff changeset	185
416 340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	186
340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	187 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	188 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	189 }
340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	190
340dc41a7ea3 The CSV exports will now have headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 412 diff changeset	191
391 5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	192 /**
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	193 * 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	194 * 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	195 */
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	196 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	197 throws IOException
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	198 {
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	199 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	200
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	201 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	202 new OutputStreamWriter(
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	203 out,
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	204 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	205 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	206
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	207 writeCSVData(writer);
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	208
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	209 writer.close();
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 }
5d6988836f01 Added an exporter to export the computed data of a duration curve. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	212 // 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 @ 445:a7947972fdeb