mschaefer@9033: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
mschaefer@9033:  * Software engineering by
mschaefer@9033:  *  Björnsen Beratende Ingenieure GmbH
mschaefer@9033:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
mschaefer@9033:  *
mschaefer@9033:  * This file is Free Software under the GNU AGPL (>=v3)
mschaefer@9033:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
mschaefer@9033:  * documentation coming with Dive4Elements River for details.
mschaefer@9033:  */
mschaefer@9033: 
mschaefer@9033: package org.dive4elements.river.artifacts.sinfo.predefineddepthevol;
mschaefer@9033: 
mschaefer@9033: import java.util.ArrayList;
mschaefer@9033: import java.util.Collection;
mschaefer@9033: import java.util.List;
mschaefer@9033: 
mschaefer@9033: import org.dive4elements.artifacts.Artifact;
mschaefer@9033: import org.dive4elements.artifacts.CallContext;
mschaefer@9033: import org.dive4elements.river.artifacts.D4EArtifact;
gernotbelger@9195: import org.dive4elements.river.artifacts.common.DefaultCalculationResult;
mschaefer@9033: import org.dive4elements.river.artifacts.common.GeneralResultType;
mschaefer@9033: import org.dive4elements.river.artifacts.common.ResultRow;
mschaefer@9033: import org.dive4elements.river.artifacts.model.BlackboardDataFacet;
mschaefer@9033: import org.dive4elements.river.artifacts.model.FacetTypes;
mschaefer@9033: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
mschaefer@9033: import org.dive4elements.river.model.sinfo.DepthEvolution;
mschaefer@9033: import org.dive4elements.river.model.sinfo.DepthEvolutionValue;
mschaefer@9033: 
mschaefer@9033: /**
mschaefer@9033:  * Facet for a depth evolution value series loaded from the database
mschaefer@9033:  *
mschaefer@9033:  * @author Matthias Schäfer
mschaefer@9033:  */
mschaefer@9033: public class PredefinedDepthEvolFacet extends BlackboardDataFacet implements FacetTypes {
mschaefer@9033: 
mschaefer@9033:     private static final long serialVersionUID = -4298111901634067027L;
mschaefer@9033: 
mschaefer@9033:     public PredefinedDepthEvolFacet(final String name, final String description, final String yAxisLabel) {
mschaefer@9033:         super(0, name, description);
mschaefer@9033: 
mschaefer@9033:         this.metaData.put("X", "chart.longitudinal.section.xaxis.label");
mschaefer@9033:         this.metaData.put("Y", yAxisLabel);
mschaefer@9033:     }
mschaefer@9033: 
mschaefer@9033:     /**
mschaefer@9033:      * Returns the data this facet requires.
mschaefer@9033:      *
mschaefer@9033:      * @param artifact
mschaefer@9033:      *            the owner artifact.
mschaefer@9033:      * @param context
mschaefer@9033:      *            the CallContext (ignored).
mschaefer@9033:      *
mschaefer@9033:      * @return
mschaefer@9033:      *         the data as PredefinedDepthEvolQueryCalculationResult
mschaefer@9033:      */
mschaefer@9033:     @Override
mschaefer@9033:     public Object getData(final Artifact artifact, final CallContext context) {
mschaefer@9033: 
mschaefer@9033:         final PredefinedDepthEvolAccess access = new PredefinedDepthEvolAccess((D4EArtifact) artifact);
mschaefer@9033:         final DepthEvolution series = DepthEvolution.getSeries(access.getId());
mschaefer@9033:         final List<DepthEvolutionValue> values = DepthEvolutionValue.getValues(series, access.getFrom(true), access.getTo(true));
mschaefer@9033:         final Collection<ResultRow> rows = new ArrayList<>();
mschaefer@9033:         for (final DepthEvolutionValue value : values) {
mschaefer@9033:             rows.add(ResultRow.create().putValue(GeneralResultType.station, value.getStation()) //
mschaefer@9033:                     .putValue(SInfoResultType.flowdepthDevelopment, value.getTotalChangeCm()) //
mschaefer@9033:                     .putValue(SInfoResultType.flowdepthDevelopmentPerYear, value.getPerYearChangeCm()));
mschaefer@9033:         }
gernotbelger@9195:         return new DefaultCalculationResult(series.getFilename(), rows);
mschaefer@9033:     }
mschaefer@9033: 
mschaefer@9033:     /**
mschaefer@9033:      * Create a deep copy of this Facet.
mschaefer@9033:      *
mschaefer@9033:      * @return a deep copy.
mschaefer@9033:      */
mschaefer@9033:     @Override
mschaefer@9033:     public PredefinedDepthEvolFacet deepCopy() {
mschaefer@9033:         final PredefinedDepthEvolFacet copy = new PredefinedDepthEvolFacet(this.name, this.description, this.metaData.get("Y"));
mschaefer@9033:         copy.set(this);
mschaefer@9033:         return copy;
mschaefer@9033:     }
mschaefer@9033: }