teichmann@5863: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5863:  * Software engineering by Intevation GmbH
teichmann@5863:  *
teichmann@5863:  * This file is Free Software under the GNU AGPL (>=v3) 
teichmann@5863:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5863:  * documentation coming with Dive4Elements River for details. 
teichmann@5863:  */
teichmann@5863: 
teichmann@5831: package org.dive4elements.river.exports;
ingo@2715: 
teichmann@5831: import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
teichmann@5831: import org.dive4elements.artifactdatabase.state.Facet;
teichmann@5867: import org.dive4elements.river.artifacts.D4EArtifact;
teichmann@5831: import org.dive4elements.river.artifacts.model.FacetTypes;
teichmann@5831: import org.dive4elements.river.artifacts.model.MiddleBedHeightData;
teichmann@5831: import org.dive4elements.river.exports.process.BedheightProcessor;
teichmann@5831: import org.dive4elements.river.exports.process.Processor;
teichmann@5831: import org.dive4elements.river.exports.process.WOutProcessor;
teichmann@5864: import org.dive4elements.river.jfree.RiverAnnotation;
teichmann@5831: import org.dive4elements.river.jfree.StyledXYSeries;
teichmann@5865: import org.dive4elements.river.utils.RiverUtils;
ingo@2715: 
christian@4142: import org.apache.log4j.Logger;
christian@4142: import org.jfree.data.xy.XYSeries;
christian@4142: import org.w3c.dom.Document;
ingo@2715: 
teichmann@5831: // TODO Move class to org.dive4elements.river.exports.minfo
ingo@2715: /**
ingo@2715:  * An OutGenerator that generates middle bed height charts.
ingo@2715:  *
ingo@2715:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@2715:  */
ingo@2715: public class MiddleBedHeightGenerator
bjoern@4449: extends        XYChartGenerator
ingo@2715: implements   FacetTypes
ingo@2715: {
ingo@2715:     public enum YAXIS {
bjoern@4537:         H(0), W(1), P(2);
ingo@2715:         protected int idx;
ingo@2715:         private YAXIS(int c) {
ingo@2715:            idx = c;
ingo@2715:         }
ingo@2715:     }
ingo@2715: 
ingo@2715:     /** The logger that is used in this generator. */
ingo@2715:     private static Logger logger = Logger.getLogger(MiddleBedHeightGenerator.class);
ingo@2715: 
ingo@2715:     /** Key to look up internationalized String for annotations label. */
ingo@2715:     public static final String I18N_ANNOTATIONS_LABEL =
ingo@2715:         "chart.bedheight_middle.annotations.label";
ingo@2715: 
ingo@2715:     public static final String I18N_CHART_TITLE =
ingo@2715:         "chart.bedheight_middle.section.title";
ingo@2715: 
ingo@2715:     public static final String I18N_CHART_SUBTITLE =
ingo@2715:         "chart.bedheight_middle.section.subtitle";
ingo@2715: 
ingo@2715:     public static final String I18N_CHART_SHORT_SUBTITLE =
ingo@2715:         "chart.bedheight_middle.section.shortsubtitle";
ingo@2715: 
ingo@2715:     public static final String I18N_XAXIS_LABEL =
ingo@2715:         "chart.bedheight_middle.section.xaxis.label";
ingo@2715: 
ingo@2715:     public static final String I18N_YAXIS_LABEL =
ingo@2715:         "chart.bedheight_middle.section.yaxis.label";
ingo@2715: 
christian@4142:     public static final String I18N_CHART_TITLE_DEFAULT  = "Mittlere Sohlhöhe";
ingo@2715:     public static final String I18N_XAXIS_LABEL_DEFAULT  = "km";
ingo@2715:     public static final String I18N_YAXIS_LABEL_DEFAULT  = "mittlere Sohlhöhen [müNN]";
bjoern@4449:     public static final String I18N_W_YAXIS_LABEL =
bjoern@4449:         "chart.longitudinal.section.yaxis.label";
bjoern@4449:     public static final String I18N_W_YAXIS_LABEL_DEFAULT  = "W [NN + m]";
bjoern@4537:     public static final String I18N_P_YAXIS_LABEL_DEFAULT  = "Gepeilte Breite [m]";
bjoern@4537:     public static final String I18N_P_YAXIS_LABEL =
bjoern@4537:         "chart.bedheight_middle.sounding.yaxis.label";
ingo@2715: 
ingo@2715:     @Override
ingo@2715:     protected YAxisWalker getYAxisWalker() {
ingo@2715:         return new YAxisWalker() {
ingo@2715:             @Override
ingo@2715:             public int length() {
ingo@2715:                 return YAXIS.values().length;
ingo@2715:             }
ingo@2715: 
ingo@2715:             @Override
ingo@2715:             public String getId(int idx) {
ingo@2715:                 YAXIS[] yaxes = YAXIS.values();
ingo@2715:                 return yaxes[idx].toString();
ingo@2715:             }
ingo@2715:         };
ingo@2715:     }
ingo@2715: 
ingo@2715: 
ingo@2715:     /**
ingo@2715:      * Returns the default title for this chart.
ingo@2715:      *
ingo@2715:      * @return the default title for this chart.
ingo@2715:      */
ingo@2715:     @Override
ingo@2715:     public String getDefaultChartTitle() {
ingo@2715:         Object[] args = new Object[] {
ingo@2715:             getRiverName()
ingo@2715:         };
ingo@2715: 
ingo@2715:         return msg(I18N_CHART_TITLE, I18N_CHART_TITLE_DEFAULT, args);
ingo@2715:     }
ingo@2715: 
ingo@2715: 
ingo@2715:     /**
ingo@2715:      * Get internationalized label for the x axis.
ingo@2715:      */
ingo@2715:     @Override
ingo@2715:     protected String getDefaultXAxisLabel() {
teichmann@5867:         D4EArtifact flys = (D4EArtifact) master;
ingo@2715: 
ingo@2715:         return msg(
ingo@2715:             I18N_XAXIS_LABEL,
ingo@2715:             I18N_XAXIS_LABEL_DEFAULT,
teichmann@5865:             new Object[] { RiverUtils.getRiver(flys).getName() });
ingo@2715:     }
ingo@2715: 
ingo@2715: 
ingo@2715:     @Override
ingo@2715:     protected String getDefaultYAxisLabel(int index) {
ingo@2715:         String label = "default";
ingo@2715: 
ingo@2715:         if (index == YAXIS.H.idx) {
ingo@2715:             label = getHAxisLabel();
ingo@2715:         }
bjoern@4449:         else if (index == YAXIS.W.idx) {
teichmann@5867:            D4EArtifact flys = (D4EArtifact) master;
teichmann@5865:            String unit = RiverUtils.getRiver(flys).getWstUnit().getName();
rrenkert@5683: 
rrenkert@5683:            label = msg(
rrenkert@5699:                 I18N_W_YAXIS_LABEL,
rrenkert@5699:                 I18N_W_YAXIS_LABEL_DEFAULT,
rrenkert@5683:                 new Object[] { unit });
bjoern@4449:         }
bjoern@4537:         else if (index == YAXIS.P.idx) {
bjoern@4537:             label = msg(I18N_P_YAXIS_LABEL, I18N_P_YAXIS_LABEL_DEFAULT);
bjoern@4537:         }
ingo@2715: 
ingo@2715:         return label;
ingo@2715:     }
ingo@2715: 
ingo@2715: 
ingo@2715:     /**
ingo@2715:      * Get internationalized label for the y axis.
ingo@2715:      */
ingo@2715:     protected String getHAxisLabel() {
ingo@2715:         return msg(I18N_YAXIS_LABEL, I18N_YAXIS_LABEL_DEFAULT);
ingo@2715:     }
ingo@2715: 
ingo@2715: 
ingo@2715:     /**
ingo@2715:      * Produce output.
felix@3269:      * @param artifactAndFacet current facet.
ingo@2715:      * @param attr  theme for facet
ingo@2715:      */
christian@4142:     @Override
ingo@2715:     public void doOut(
ingo@2715:         ArtifactAndFacet artifactAndFacet,
ingo@2715:         Document         attr,
ingo@2715:         boolean          visible
ingo@2715:     ) {
ingo@2715:         String name = artifactAndFacet.getFacetName();
ingo@2715: 
ingo@2715:         logger.debug("MiddleBedHeightGenerator.doOut: " + name);
ingo@2715: 
ingo@2715:         if (name == null) {
ingo@2715:             logger.error("No facet name for doOut(). No output generated!");
ingo@2715:             return;
ingo@2715:         }
ingo@2715: 
ingo@2715:         Facet facet = artifactAndFacet.getFacet();
ingo@2715: 
ingo@2715:         if (facet == null) {
ingo@2715:             return;
ingo@2715:         }
ingo@2715: 
bjoern@4537:         Processor woutp = new WOutProcessor();
bjoern@4537:         Processor bedp = new BedheightProcessor();
rrenkert@5668:         WOutProcessor processor = new WOutProcessor();
rrenkert@5668:         if (processor.canHandle(name)) {
rrenkert@5668:             processor.doOut(this, artifactAndFacet, attr, visible, YAXIS.W.idx);
rrenkert@5668:         }
ingo@2715:         if (name.equals(MIDDLE_BED_HEIGHT_SINGLE) || name.equals(MIDDLE_BED_HEIGHT_EPOCH)) {
ingo@2715:             doHeightOut(
ingo@2715:                 (MiddleBedHeightData) artifactAndFacet.getData(context),
ingo@2715:                 artifactAndFacet,
ingo@2715:                 attr,
ingo@2715:                 visible);
ingo@2715:         }
ingo@2715:         else if (name.equals(MIDDLE_BED_HEIGHT_ANNOTATION)) {
ingo@2715:             doAnnotations(
teichmann@5864:                 (RiverAnnotation) artifactAndFacet.getData(context),
ingo@2715:                  artifactAndFacet,
ingo@2715:                  attr,
ingo@2715:                  visible);
ingo@2715:         }
ingo@2715:         else if (FacetTypes.IS.AREA(name)) {
ingo@2715:             doArea(
ingo@2715:                 artifactAndFacet.getData(context),
ingo@2715:                 artifactAndFacet,
ingo@2715:                 attr,
ingo@2715:                 visible);
ingo@2715:         }
ingo@2715:         else if (FacetTypes.IS.MANUALPOINTS(name)) {
ingo@2715:             doPoints(
ingo@2715:                 artifactAndFacet.getData(context),
ingo@2715:                 artifactAndFacet,
ingo@2715:                 attr,
ingo@2715:                 visible,
ingo@2715:                 YAXIS.H.idx);
ingo@2715:         }
bjoern@4537:         else if (bedp.canHandle(name)) {
bjoern@4537:             bedp.doOut(this, artifactAndFacet, attr, visible, YAXIS.P.idx);
bjoern@4537:         }
bjoern@4537:         else if (woutp.canHandle(name)) {
bjoern@4537:             woutp.doOut(this, artifactAndFacet, attr, visible, YAXIS.W.idx);
bjoern@4537:         }
ingo@2715:         else {
bjoern@4537:             logger.warn("Unknown facet name: " + name);
ingo@2715:         }
ingo@2715:     }
ingo@2715: 
ingo@2715: 
ingo@2715:     /**
ingo@2715:      * @param data A data object
felix@3270:      * @param aandf The artifact and facet. This facet does NOT support any data objects. Use
teichmann@5867:      * D4EArtifact.getNativeFacet() instead to retrieve a Facet which supports
ingo@2715:      * data.
ingo@2715:      * @param theme The theme that contains styling information.
ingo@2715:      * @param visible The visibility of the curve.
ingo@2715:      */
ingo@2715:     protected void doHeightOut(
ingo@2715:         MiddleBedHeightData data,
ingo@2715:         ArtifactAndFacet    aandf,
ingo@2715:         Document            theme,
ingo@2715:         boolean             visible
ingo@2715:     ) {
ingo@2715:         logger.debug("MiddleBedHeightGenerator.doMainChannelOut");
ingo@2715: 
ingo@2715:         XYSeries series = new StyledXYSeries(aandf.getFacetDescription(), theme);
ingo@2715: 
felix@3924:         StyledSeriesBuilder.addPoints(series, data.getMiddleHeightsPoints(), false);
ingo@2715: 
ingo@2715:         addAxisSeries(series, YAXIS.H.idx, visible);
ingo@2715:     }
ingo@2715: 
ingo@2715: 
ingo@2715:     /** Look up the axis identifier for a given facet type. */
ingo@2715:     public int axisIdxForFacet(String facetName) {
ingo@2715:         if (FacetTypes.IS.H(facetName)) {
ingo@2715:             return YAXIS.H.idx;
ingo@2715:         }
bjoern@4449:         else if (FacetTypes.IS.W(facetName)) {
bjoern@4449:             return YAXIS.W.idx;
bjoern@4449:         }
ingo@2715:         else {
ingo@2715:             logger.warn("Could not find axis for facet " + facetName);
ingo@2715:             return YAXIS.H.idx;
ingo@2715:         }
ingo@2715:     }
ingo@2715: 
ingo@2715: 
ingo@2715:     /**
ingo@2715:      * Do Area out.
ingo@2715:      * @param theme styling information.
ingo@2715:      * @param visible whether or not visible.
ingo@2715:      */
ingo@2715:     protected void doArea(
ingo@2715:         Object     o,
ingo@2715:         ArtifactAndFacet aandf,
ingo@2715:         Document   theme,
ingo@2715:         boolean    visible
ingo@2715:     ) {
ingo@2715:         logger.debug("FlowVelocityGenerator.doArea");
ingo@2715:         logger.warn("TODO: Implement FlowVelocityGenerator.doArea");
ingo@2715:     }
ingo@2715: }
ingo@2715: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :