dive4elements/gnv-client: gnv-artifacts/src/main/java/de/intevation/gnv/exports/DefaultExport.java annotate

annotate gnv-artifacts/src/main/java/de/intevation/gnv/exports/DefaultExport.java @ 815:22c18083225e

Removed compiler warnings while JavaDoc generation. gnv-artifacts/trunk@900 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Mon, 12 Apr 2010 06:59:33 +0000
parents	b1f5f2a8840f
children	f953c9a559d8

rev	line source
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	1 package de.intevation.gnv.exports;
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	2
779 b1f5f2a8840f Ordered imports. Removed needless imports. Removed empty headers. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 778 diff changeset	3 import au.com.bytecode.opencsv.CSVWriter;
b1f5f2a8840f Ordered imports. Removed needless imports. Removed empty headers. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 778 diff changeset	4
b1f5f2a8840f Ordered imports. Removed needless imports. Removed empty headers. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 778 diff changeset	5 import de.intevation.gnv.geobackend.base.Result;
b1f5f2a8840f Ordered imports. Removed needless imports. Removed empty headers. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 778 diff changeset	6
b1f5f2a8840f Ordered imports. Removed needless imports. Removed empty headers. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 778 diff changeset	7 import de.intevation.gnv.state.exception.StateException;
b1f5f2a8840f Ordered imports. Removed needless imports. Removed empty headers. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 778 diff changeset	8
765 f28a7eac542a Integrated valid ODV-Export to the GNV-Artifacts Tim Englich <tim.englich@intevation.de> parents: 335 diff changeset	9 import java.io.IOException;
f28a7eac542a Integrated valid ODV-Export to the GNV-Artifacts Tim Englich <tim.englich@intevation.de> parents: 335 diff changeset	10 import java.io.OutputStream;
f28a7eac542a Integrated valid ODV-Export to the GNV-Artifacts Tim Englich <tim.englich@intevation.de> parents: 335 diff changeset	11 import java.io.OutputStreamWriter;
f28a7eac542a Integrated valid ODV-Export to the GNV-Artifacts Tim Englich <tim.englich@intevation.de> parents: 335 diff changeset	12 import java.io.UnsupportedEncodingException;
779 b1f5f2a8840f Ordered imports. Removed needless imports. Removed empty headers. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 778 diff changeset	13
765 f28a7eac542a Integrated valid ODV-Export to the GNV-Artifacts Tim Englich <tim.englich@intevation.de> parents: 335 diff changeset	14 import java.util.Collection;
f28a7eac542a Integrated valid ODV-Export to the GNV-Artifacts Tim Englich <tim.englich@intevation.de> parents: 335 diff changeset	15 import java.util.Iterator;
f28a7eac542a Integrated valid ODV-Export to the GNV-Artifacts Tim Englich <tim.englich@intevation.de> parents: 335 diff changeset	16
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	17 import org.apache.log4j.Logger;
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	18
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	19 /**
771 a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	20 * This class is the default implementation of {@link Export}.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	21 *
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	22 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	23 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	24 */
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	25 public class DefaultExport
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	26 implements Export
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	27 {
771 a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	28 /**
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	29 * Logger used for logging via log4j.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	30 */
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	31 private static Logger log = Logger.getLogger(DefaultExport.class);
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	32
771 a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	33 /**
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	34 * DataCollector used to extract data from <code>Result</code> objects.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	35 */
765 f28a7eac542a Integrated valid ODV-Export to the GNV-Artifacts Tim Englich <tim.englich@intevation.de> parents: 335 diff changeset	36 protected Export.DataCollector collector;
233 2ceb4bf51cba Added DataCollector which collects data used for exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 230 diff changeset	37
771 a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	38 /**
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	39 * Constructor
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	40 *
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	41 * @param collector See {@link #collector}
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	42 */
233 2ceb4bf51cba Added DataCollector which collects data used for exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 230 diff changeset	43 public DefaultExport(Export.DataCollector collector) {
2ceb4bf51cba Added DataCollector which collects data used for exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 230 diff changeset	44 this.collector = collector;
2ceb4bf51cba Added DataCollector which collects data used for exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 230 diff changeset	45 }
2ceb4bf51cba Added DataCollector which collects data used for exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 230 diff changeset	46
771 a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	47 /**
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	48 * This method writes data stored in <code>result</code> into a CSV document
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	49 * using <code>writer</code>.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	50 *
815 22c18083225e Removed compiler warnings while JavaDoc generation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 779 diff changeset	51 * @param profile <code>Profile</code> used to specify the format and columns.
771 a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	52 * @param result Collection storing the required data.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	53 * @param writer CSVWriter to write the csv document.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	54 *
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	55 * @throws StateException
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	56 */
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	57 protected void writeData(
778 9a828e5a2390 Removed trailing whitespace Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 771 diff changeset	58 Profile profile,
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	59 Collection result,
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	60 CSVWriter writer
233 2ceb4bf51cba Added DataCollector which collects data used for exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 230 diff changeset	61 )
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: 301 diff changeset	62 throws StateException {
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	63 log.debug("create content for export.");
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	64 Iterator<Result> it = result.iterator();
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	65
239 75da91eca29f Added possibility to print column labels in the first line of an export. Added labels for odv export as well. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 233 diff changeset	66 String[] header = profile.getHeader();
75da91eca29f Added possibility to print column labels in the first line of an export. Added labels for odv export as well. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 233 diff changeset	67 if (header != null)
75da91eca29f Added possibility to print column labels in the first line of an export. Added labels for odv export as well. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 233 diff changeset	68 writer.writeNext(header);
75da91eca29f Added possibility to print column labels in the first line of an export. Added labels for odv export as well. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 233 diff changeset	69
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	70 while (it.hasNext()) {
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	71 Result res = it.next();
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	72
233 2ceb4bf51cba Added DataCollector which collects data used for exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 230 diff changeset	73 writer.writeNext(collector.getData(res));
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	74 }
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	75 }
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	76
771 a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	77 /**
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	78 * This method takes a data Collection and writes it to
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	79 * <code>outputStream</code> using the the format specified by
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	80 * <code>profile</code>.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	81 *
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	82 * @param profile used to specify the format and columns.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	83 * @param outputStream OutputStream which is used for writing the export
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	84 * document to.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	85 * @param result Collection storing the data.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	86 *
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	87 * @throws IOException if writing to OutputStream failed.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	88 * @throws UnsupportedEncodingException if the encoding was not accepted.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	89 * @throws StateException if result is null.
a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	90 */
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	91 public void create(
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	92 Profile profile,
778 9a828e5a2390 Removed trailing whitespace Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 771 diff changeset	93 OutputStream outputStream,
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	94 Collection result
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	95 )
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	96 throws
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	97 IOException,
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	98 UnsupportedEncodingException,
778 9a828e5a2390 Removed trailing whitespace Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 771 diff changeset	99 StateException
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	100 {
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	101 if (result == null) {
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	102 String msg = "No data given for generation of " +
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	103 profile.getType() + " file.";
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	104 log.error(msg);
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: 301 diff changeset	105 throw new StateException(msg);
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	106 }
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	107
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	108 CSVWriter writer = new CSVWriter(
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	109 new OutputStreamWriter(
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	110 outputStream,
778 9a828e5a2390 Removed trailing whitespace Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 771 diff changeset	111 profile.getEncoding()),
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	112 profile.getSeparator(),
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	113 profile.getQuoteCharacter(),
778 9a828e5a2390 Removed trailing whitespace Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 771 diff changeset	114 profile.getEscapeCharacter());
230 f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	115
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	116 writeData(profile, result, writer);
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	117
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	118 writer.close();
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	119 }
f68ffbe974a0 Implemented an exporter for odv and csv exports. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	120 }
771 a0e63136954e Added and repaired javadoc in de.intevation.gnv.exports package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 765 diff changeset	121 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :

Mercurial > dive4elements > gnv-client

annotate gnv-artifacts/src/main/java/de/intevation/gnv/exports/DefaultExport.java @ 815:22c18083225e