mschaefer@9112: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
mschaefer@9112:  * Software engineering by
mschaefer@9112:  *  Björnsen Beratende Ingenieure GmbH
mschaefer@9112:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
mschaefer@9112:  *
mschaefer@9112:  * This file is Free Software under the GNU AGPL (>=v3)
mschaefer@9112:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
mschaefer@9112:  * documentation coming with Dive4Elements River for details.
mschaefer@9112:  */
mschaefer@9112: 
mschaefer@9112: package org.dive4elements.river.artifacts.sinfo.common;
mschaefer@9112: 
mschaefer@9112: import java.util.HashSet;
mschaefer@9112: import java.util.Map;
mschaefer@9112: import java.util.Set;
mschaefer@9112: 
mschaefer@9112: import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
mschaefer@9112: import org.dive4elements.artifactdatabase.state.Facet;
mschaefer@9112: import org.dive4elements.artifacts.Artifact;
mschaefer@9112: import org.dive4elements.artifacts.CallContext;
mschaefer@9112: import org.dive4elements.artifacts.CallMeta;
gernotbelger@9195: import org.dive4elements.river.artifacts.common.AbstractCalculationResult;
mschaefer@9112: import org.dive4elements.river.artifacts.resources.Resources;
mschaefer@9112: import org.dive4elements.river.artifacts.sinfo.predefinedchannel.PredefinedChannelFacet;
mschaefer@9112: import org.dive4elements.river.exports.DiagramGenerator;
mschaefer@9112: import org.dive4elements.river.exports.StyledSeriesBuilder;
mschaefer@9112: import org.dive4elements.river.jfree.StyledXYSeries;
mschaefer@9112: import org.dive4elements.river.themes.ThemeDocument;
mschaefer@9112: 
mschaefer@9112: /**
mschaefer@9112:  * Processor to generate a data series for river channel width data loaded from the database
mschaefer@9112:  *
mschaefer@9112:  * @author Matthias Schäfer
mschaefer@9112:  *
mschaefer@9112:  */
mschaefer@9112: public class PredefinedChannelWidthProcessor extends AbstractSInfoProcessor {
mschaefer@9112: 
mschaefer@9112:     // private final static Logger log = Logger.getLogger(PredefinedChannelWidthProcessor.class);
mschaefer@9112: 
mschaefer@9112:     public static final String FACET_PREDEFINED_CHANNEL_WIDTH = "sinfo_facet_predefined_channel_width";
mschaefer@9112: 
mschaefer@9112:     private static final String I18N_AXIS_LABEL = "sinfo.chart.channel_width.section.yaxis.label";
mschaefer@9112: 
mschaefer@9112:     private static final String I18N_SERIES_NAME_PATTERN = "predefinedchannel.width.title";
mschaefer@9112: 
mschaefer@9112:     private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();
mschaefer@9112: 
mschaefer@9112:     static {
mschaefer@9112:         HANDLED_FACET_TYPES.add(FACET_PREDEFINED_CHANNEL_WIDTH);
mschaefer@9112:     }
mschaefer@9112: 
mschaefer@9112:     public PredefinedChannelWidthProcessor() {
mschaefer@9112:         super(I18N_AXIS_LABEL, HANDLED_FACET_TYPES);
mschaefer@9112:     }
mschaefer@9112: 
mschaefer@9112:     @Override
mschaefer@9112:     protected String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
mschaefer@9112: 
gernotbelger@9123:         final CallContext context = generator.getContext();
mschaefer@9112:         final Map<String, String> metaData = bundle.getFacet().getMetaData();
mschaefer@9112: 
mschaefer@9112:         final Artifact artifact = bundle.getArtifact();
mschaefer@9112: 
mschaefer@9112:         final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
mschaefer@9112:         series.putMetaData(metaData, artifact, context);
mschaefer@9112: 
mschaefer@9112:         final String facetName = bundle.getFacetName();
gernotbelger@9195:         final AbstractCalculationResult data = (AbstractCalculationResult) bundle.getData(context);
mschaefer@9112:         if (data == null) {
mschaefer@9112:             // Check has been here before so we keep it for security reasons
mschaefer@9112:             // this should never happen though.
mschaefer@9112:             throw new IllegalStateException("Data is null for facet: " + facetName);
mschaefer@9112:         }
mschaefer@9112: 
mschaefer@9112:         final double[][] points = data.getStationPoints(SInfoResultType.channelWidth);
mschaefer@9112: 
mschaefer@9112:         StyledSeriesBuilder.addPoints(series, points, true);
mschaefer@9112:         generator.addAxisSeries(series, getAxisName(), visible);
mschaefer@9112: 
mschaefer@9112:         return metaData.get("Y");
mschaefer@9112:     }
mschaefer@9112: 
mschaefer@9112:     public static Facet createFacet(final CallMeta callMeta, final String seriesName) {
mschaefer@9112:         return new PredefinedChannelFacet(FACET_PREDEFINED_CHANNEL_WIDTH,
mschaefer@9112:                 Resources.getMsg(callMeta, I18N_SERIES_NAME_PATTERN, I18N_SERIES_NAME_PATTERN, seriesName), I18N_AXIS_LABEL);
mschaefer@9112:     }
mschaefer@9112: }