dive4elements/river: artifacts/src/main/java/org/dive4elements/river/exports/AbstractExporter.java comparison

comparison artifacts/src/main/java/org/dive4elements/river/exports/AbstractExporter.java @ 9150:23945061daec

gigantic refactoring: exporter, result, results to support multiple jaspers -> collisions

author	gernotbelger
date	Thu, 14 Jun 2018 16:56:31 +0200
parents	93ea282c33e8
children	13a0c4be17ea

comparison

equal deleted inserted replaced

-:5be112fba832
+:23945061daec
 package org.dive4elements.river.exports;
 import java.io.IOException;
 import java.io.OutputStream;
 import java.io.OutputStreamWriter;
 import java.text.NumberFormat;
-import org.w3c.dom.Document;
 import org.apache.log4j.Logger;
+import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
-import au.com.bytecode.opencsv.CSVWriter;
+import org.dive4elements.artifactdatabase.state.Settings;
 import org.dive4elements.artifacts.Artifact;
 import org.dive4elements.artifacts.CallContext;
-import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
-import org.dive4elements.artifactdatabase.state.Settings;
 import org.dive4elements.artifacts.common.ArtifactNamespaceContext;
 import org.dive4elements.artifacts.common.utils.XMLUtils;
 import org.dive4elements.river.artifacts.resources.Resources;
 import org.dive4elements.river.collections.D4EArtifactCollection;
 import org.dive4elements.river.themes.ThemeDocument;
 import org.dive4elements.river.utils.Formatter;
+import org.w3c.dom.Document;
+import au.com.bytecode.opencsv.CSVWriter;
 /**
 * Abstract exporter that implements some basic methods for exporting data of
 * artifacts.
 *
 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
 */
 public abstract class AbstractExporter implements OutGenerator {
-/** The log used in this exporter.*/
+/** The log used in this exporter. */
 private static Logger log = Logger.getLogger(AbstractExporter.class);
 /* XXX: Why does AbstractExporter do not implement FacetTypes? */
 public static String FIX_PARAMETERS = "fix_parameters";
 protected CallContext context;
 /** The selected facet. */
 protected String facet;
-/** The collection.*/
+/** The collection. */
 protected D4EArtifactCollection collection;
 /** The master artifact. */
 protected Artifact master;
 /**
 * Concrete subclasses need to use this method to write their special data
 * objects into the CSV document.
 *
-* @param writer The CSVWriter.
+* @param writer
+*            The CSVWriter.
 */
 protected abstract void writeCSVData(CSVWriter writer) throws IOException;
 /**
 * Write lines of informative content to CSV file.
 * Usually this will be done above the column headers from within
 * the implementation of writeCSVData in concret subclasses.
 *
-* @param writer The CSVWriter
+* @param writer
-* @param infolines Array of Strings with informative content.
+*            The CSVWriter
-* Each will be written to a separate line prefixed with START_META_CHAR.
+* @param infolines
-*/
+*            Array of Strings with informative content.
-protected void  writeCSVInfo(CSVWriter writer, String[] infolines) {
+*            Each will be written to a separate line prefixed with START_META_CHAR.
-String[] metaline = new String[1];
+*/
+protected void writeCSVInfo(final CSVWriter writer, final String[] infolines) {
-for (String infoline: infolines) {
+final String[] metaline = new String[1];
+for (final String infoline : infolines) {
 metaline[0] = START_META_CHAR + " " + infoline;
 writer.writeNext(metaline);
 }
 }
 * Concrete subclasses need to use this method to write their special data
 * objects into the PDF document.
 */
 protected abstract void writePDF(OutputStream out);
 /**
 * This method enables concrete subclasses to collected its own special
 * data.
 *
-* @param data The artifact that stores the data that has to be
+* @param data
-* exported.
+*            The artifact that stores the data that has to be
+*            exported.
 */
 protected abstract void addData(Object data);
-public void setup(Object config) {
+@Override
+public void setup(final Object config) {
 log.debug("AbstractExporter.setup");
 }
+@Override
-@Override
+public void init(final String outName, final Document request, final OutputStream out, final CallContext context) {
-public void init(
-String       outName,
-Document     request,
-OutputStream out,
-CallContext  context
-) {
 log.debug("AbstractExporter.init");
 this.outName = outName;
 this.request = request;
-this.out     = out;
+this.out = out;
 this.context = context;
 }
+@Override
-@Override
+public void setMasterArtifact(final Artifact master) {
-public void setMasterArtifact(Artifact master) {
 this.master = master;
 }
-/** Get the callcontext that this exporter has been initialized
+/**
-* with. */
+* Get the callcontext that this exporter has been initialized
+* with.
+*/
 public CallContext getCallContext() {
 return this.context;
 }
+@Override
-@Override
+public void setCollection(final D4EArtifactCollection collection) {
-public void setCollection(D4EArtifactCollection collection) {
 this.collection = collection;
 }
 /**
 * This doOut() just collects the data of multiple artifacts. Therefore, it
 * makes use of the addData() method which enables concrete subclasses to
 * store its data on its own. The real output creation takes place in the
 * concrete generate() methods.
 *
-* @param artifactFacet The artifact and facet.
+* @param artifactFacet
-* The facet to add - NOTE: the facet needs to fit to the first
+*            The artifact and facet.
-* facet inserted into this exporter. Otherwise this artifact/facet is
+*            The facet to add - NOTE: the facet needs to fit to the first
-* skipped.
+*            facet inserted into this exporter. Otherwise this artifact/facet is
-* @param attr The attr document.
+*            skipped.
-*/
+* @param attr
-@Override
+*            The attr document.
-public void doOut(
+*/
-ArtifactAndFacet artifactFacet,
+@Override
-ThemeDocument    attr,
+public void doOut(final ArtifactAndFacet artifactFacet, final ThemeDocument attr, final boolean visible) {
-boolean          visible
+final String name = artifactFacet.getFacetName();
-) {
-String name = artifactFacet.getFacetName();
 log.debug("AbstractExporter.doOut: " + name);
 if (!isFacetValid(name)) {
 log.warn("Facet '" + name + "' not valid. No output created!");
 return;
 }
-addData(artifactFacet.getData(context));
+addData(artifactFacet.getData(this.context));
 }
 /**
 * Generates an export based on a specified facet.
 */
 @Override
-public void generate()
+public void generate() throws IOException {
-throws IOException
-{
 log.debug("AbstractExporter.generate");
-if (facet == null) {
+if (this.facet == null) {
 throw new IOException("invalid (null) facet for exporter");
 }
-if (facet.equals(FACET_CSV)) {
+if (this.facet.equals(FACET_CSV)) {
 generateCSV();
-}
+} else if (this.facet.equals(FACET_PDF)) {
-else if (facet.equals(FACET_PDF)) {
 generatePDF();
-}
+} else {
-else {
+throw new IOException("invalid facet for exporter: '" + this.facet + "'");
-throw new IOException(
+}
-"invalid facet for exporter: '" + facet + "'");
+}
-}
-}
 /**
 * Determines if the desired facet is valid for this exporter. If no facet
 * is currently set, <i>facet</i> is set.
 *
-* @param facet The desired facet.
+* @param facet
+*            The desired facet.
 *
 * @return true, if <i>facet</i> is valid, otherwise false.
 */
-protected boolean isFacetValid(String facet) {
+protected boolean isFacetValid(final String facet) {
-log.debug("AbstractExporter.isFacetValid : "
+log.debug("AbstractExporter.isFacetValid : " + facet + " (" + getFacet() + ")");
-+ facet + " (" + getFacet() + ")" );
+final String thisFacet = getFacet();
-String thisFacet = getFacet();
 if (thisFacet == null || thisFacet.length() == 0) {
 return false;
-}
+} else if (facet == null || facet.length() == 0) {
-else if (facet == null || facet.length() == 0) {
 return false;
-}
+} else {
-else {
 return thisFacet.equals(facet);
 }
 }
 /**
 * Returns the name of the desired facet.
 *
 * @return the name of the desired facet.
 */
 protected String getFacet() {
-if (facet == null) {
+if (this.facet == null) {
-facet = getFacetFromRequest();
+this.facet = getFacetFromRequest();
 }
-return facet;
+return this.facet;
 }
 /**
 * Extracts the name of the requested facet from request document.
 *
 * @return the name of the requested facet.
 */
 protected String getFacetFromRequest() {
-return XMLUtils.xpathString(
+return XMLUtils.xpathString(this.request, XPATH_FACET, ArtifactNamespaceContext.INSTANCE);
-request, XPATH_FACET, ArtifactNamespaceContext.INSTANCE);
 }
 protected String msg(final String key) {
-return Resources.getMsg(context.getMeta(), key, key);
+return Resources.getMsg(this.context.getMeta(), key, key);
 }
-protected String msg(String key, final String def) {
+protected String msg(final String key, final String def) {
-return Resources.getMsg(context.getMeta(), key, def);
+return Resources.getMsg(this.context.getMeta(), key, def);
 }
-protected String msg(String key, Object[] args) {
+protected String msg(final String key, final Object[] args) {
-return Resources.getMsg(context.getMeta(), key, key, args);
+return Resources.getMsg(this.context.getMeta(), key, key, args);
 }
-protected String msg(String key, String def, Object[] args) {
+protected String msg(final String key, final String def, final Object[] args) {
-return Resources.getMsg(context.getMeta(), key, def, args);
+return Resources.getMsg(this.context.getMeta(), key, def, args);
 }
 protected String msgVarg(final String key, final Object... args) {
-return Resources.getMsg(context.getMeta(), key, key, args);
+return Resources.getMsg(this.context.getMeta(), key, key, args);
 }
 /**
 * Formats header with unit: msg [unit]
 */
+// TODO: REMOVE, because it has moved to ExportContextCSV
 protected final String msgUnit(final String key, final String unit) {
 final String msg = msg(key);
 return String.format("%s [%s]", msg, unit);
 }
 /**
 * This method starts CSV creation. It makes use of writeCSVData() which has
 * to be implemented by concrete subclasses.
 */
-protected void generateCSV()
+protected void generateCSV() throws IOException {
-throws    IOException
-{
 log.info("AbstractExporter.generateCSV");
-char quote = '"';
+final char quote = '"';
-char escape = '\\';
+final char escape = '\\';
-CSVWriter writer = new CSVWriter(
+final CSVWriter writer = new CSVWriter(new OutputStreamWriter(this.out, DEFAULT_CSV_CHARSET), DEFAULT_CSV_SEPARATOR, quote, escape, "\r\n");
-new OutputStreamWriter(
-out,
-DEFAULT_CSV_CHARSET),
-DEFAULT_CSV_SEPARATOR, quote, escape, "\r\n");
 writeCSVData(writer);
 writer.close();
 }
 /**
 * This method starts PDF creation.
 */
-protected void generatePDF()
+protected void generatePDF() throws IOException {
-throws    IOException
-{
 log.info("AbstractExporter.generatePDF");
 writePDF(this.out);
 }
 /**
 * Returns an instance of <i>EmptySettings</i> currently!
 *
 * @return an instance of <i>EmptySettings</i>.
 */
+@Override
 public Settings getSettings() {
 return new EmptySettings();
 }
 /**
 * This method is not implemented. Override it in subclasses if those need a
 * <i>Settings</i> object.
 */
-public void setSettings(Settings settings) {
+@Override
+public void setSettings(final Settings settings) {
 // do nothing
 }
 /**
 * Returns the number formatter for kilometer values.
 *
 * @return the number formatter for kilometer values.
 */
 protected NumberFormat getKmFormatter() {
-if (kmFormat == null) {
+if (this.kmFormat == null) {
-kmFormat = Formatter.getWaterlevelKM(context);
+this.kmFormat = Formatter.getWaterlevelKM(this.context);
 }
-return kmFormat;
+return this.kmFormat;
 }
 /**
 * Returns the number formatter for W values.
 *
 * @return the number formatter for W values.
 */
 protected NumberFormat getWFormatter() {
-if (wFormat == null) {
+if (this.wFormat == null) {
-wFormat = Formatter.getWaterlevelW(context);
+this.wFormat = Formatter.getWaterlevelW(this.context);
 }
-return wFormat;
+return this.wFormat;
 }
 /**
 * Returns the number formatter for Q values.
 *
 * @return the number formatter for Q values.
 */
 protected NumberFormat getQFormatter() {
-if (qFormat == null) {
+if (this.qFormat == null) {
-qFormat = Formatter.getWaterlevelQ(context);
+this.qFormat = Formatter.getWaterlevelQ(this.context);
 }
-return qFormat;
+return this.qFormat;
 }
 protected final NumberFormat getMeanBedHeighFormatter() {
-if( meanBedHeightFormat == null )
+if (this.meanBedHeightFormat == null)
-meanBedHeightFormat = Formatter.getMeanBedHeight(context);
+this.meanBedHeightFormat = Formatter.getMeanBedHeight(this.context);
-return meanBedHeightFormat;
+return this.meanBedHeightFormat;
 }
 protected final NumberFormat getTkhFormatter() {
-if( tkhFormat == null )
+if (this.tkhFormat == null)
-tkhFormat = Formatter.getTkh(context);
+this.tkhFormat = Formatter.getTkh(this.context);
-return tkhFormat;
+return this.tkhFormat;
 }
 protected final NumberFormat getFlowDepthFormatter() {
-if( flowDepthFormat == null )
+if (this.flowDepthFormat == null)
-flowDepthFormat = Formatter.getFlowDepth(context);
+this.flowDepthFormat = Formatter.getFlowDepth(this.context);
-return flowDepthFormat;
+return this.flowDepthFormat;
 }
 protected final NumberFormat getW2Formatter() {
-if( w2Format == null )
+if (this.w2Format == null)
-w2Format = Formatter.getFlowDepth(context);
+this.w2Format = Formatter.getFlowDepth(this.context);
-return w2Format;
+return this.w2Format;
 }
 }
 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > river

comparison artifacts/src/main/java/org/dive4elements/river/exports/AbstractExporter.java @ 9150:23945061daec