# HG changeset patch # User Felix Wolfsteller # Date 1381480177 -7200 # Node ID 8c315b6bbc8a619cb05f7d676475007c05ede708 # Parent be0e3b93144c84bb8b85037fca0b0e6416ae4801 issue1512: Initial commit of FlowVelocityModelArtifact. diff -r be0e3b93144c -r 8c315b6bbc8a artifacts/src/main/java/org/dive4elements/river/artifacts/FlowVelocityModelArtifact.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/artifacts/src/main/java/org/dive4elements/river/artifacts/FlowVelocityModelArtifact.java Fri Oct 11 10:29:37 2013 +0200 @@ -0,0 +1,248 @@ +/* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde + * Software engineering by Intevation GmbH + * + * This file is Free Software under the GNU AGPL (>=v3) + * and comes with ABSOLUTELY NO WARRANTY! Check out the + * documentation coming with Dive4Elements River for details. + */ + +package org.dive4elements.river.artifacts; + +import java.util.ArrayList; +import java.util.List; + +import org.apache.log4j.Logger; +import org.w3c.dom.Document; + +import org.dive4elements.artifactdatabase.state.DefaultOutput; +import org.dive4elements.artifactdatabase.state.Facet; +import org.dive4elements.artifactdatabase.state.FacetActivity; +import org.dive4elements.artifactdatabase.state.State; +import org.dive4elements.artifacts.Artifact; +import org.dive4elements.artifacts.ArtifactFactory; +import org.dive4elements.artifacts.CallMeta; +import org.dive4elements.artifacts.common.utils.XMLUtils; +import org.dive4elements.river.artifacts.model.Calculation; +import org.dive4elements.river.artifacts.model.CalculationResult; +import org.dive4elements.river.artifacts.states.DefaultState.ComputeType; +import org.dive4elements.river.model.FlowVelocityModel; +import org.dive4elements.river.artifacts.model.FlowVelocityCalculation; +import org.dive4elements.river.artifacts.model.FlowVelocityData; +import org.dive4elements.river.artifacts.model.FlowVelocityFacet; +import org.dive4elements.river.artifacts.states.StaticState; + +import org.dive4elements.river.artifacts.model.FacetTypes; + + +/** Artifact to access flow velocity models. */ +public class FlowVelocityModelArtifact +extends StaticD4EArtifact +implements FacetTypes +{ + /** The logger for this class. */ + private static Logger logger = + Logger.getLogger(FlowVelocityModelArtifact.class); + + /** Artifact key name. */ + private static final String NAME = "flowvelocitymodel"; + + /** Spawn only inactive facets. */ + static { + // TODO: Move to configuration. + FacetActivity.Registry.getInstance() + .register(NAME, FacetActivity.INACTIVE); + } + + /** Need to give the state an id. */ + public static final String STATIC_STATE_NAME = + "state.flowvelocitymodel.static"; + + /** One and only state to be in. */ + protected transient State state = null; + + protected String DATA_ID = "ID"; + + /** + * Trivial Constructor. + */ + public FlowVelocityModelArtifact() { + logger.debug("FlowVelocityModelArtifact.FlowVelocityModelArtifact"); + } + + + /** Get artifact key name. */ + @Override + public String getName() { + return NAME; + } + + + private Object getFlowVelocity() { + logger.debug("FlowVelocityModelArtifact.getFlowVelocity"); + Integer id = getDataAsInteger(DATA_ID); + + FlowVelocityModel model = FlowVelocityModel.getModel(id); + FlowVelocityData data = new FlowVelocityData(); + + // TODO rangeaccess + FlowVelocityCalculation.prepareData(data, model, 0d, 1000d); + + return new CalculationResult( + new FlowVelocityData[] {data} , new Calculation()); + } + + + /** Create a static state. */ + private State newState() { + return new StaticState(STATIC_STATE_NAME) { + public Object staticCompute(List facets) { + return getFlowVelocity(); + } + }; + } + + + /** Create a new state with bogus output. */ + protected State spawnState() { + state = newState(); + List fs = getFacets(STATIC_STATE_NAME); + DefaultOutput output = new DefaultOutput( + "general", + "general", + "image/png", + fs, + "chart"); + + state.getOutputs().add(output); + + return state; + } + + + /** + * Gets called from factory, to set things up. + */ + @Override + public void setup( + String identifier, + ArtifactFactory factory, + Object context, + CallMeta callMeta, + Document data) + { + logger.debug("FlowVelocityModelArtifact.setup"); + + state = newState(); + if (logger.isDebugEnabled()) { + logger.debug(XMLUtils.toString(data)); + } + + List fs = new ArrayList(); + + String code = getDatacageIDValue(data); + + if (code != null) { + //String name = FlowVelocityModel.getFlowVelocityModelDescription(Integer.valueOf(code)); + String name = "facet"; + Facet facet = new FlowVelocityFacet( + 0, + FLOW_VELOCITY_MAINCHANNEL, + name + "main", + ComputeType.ADVANCE, state.getID(), "hash" + ); + fs.add(facet); + Facet tauFacet = new FlowVelocityFacet( + 0, + FLOW_VELOCITY_TAU, + name+"tau", + ComputeType.ADVANCE, state.getID(), "hash" + ); + fs.add(tauFacet); + Facet qFacet = new FlowVelocityFacet( + 0, + FLOW_VELOCITY_DISCHARGE, + name+"q", + ComputeType.ADVANCE, state.getID(), "hash" + ); + fs.add(qFacet); + Facet tFacet = new FlowVelocityFacet( + 0, + FLOW_VELOCITY_TOTALCHANNEL, + name+"t", + ComputeType.ADVANCE, state.getID(), "hash" + ); + fs.add(tFacet); + addFacets(state.getID(), fs); + addStringData(DATA_ID, code); + } + else { + logger.error("No id given."); + } + + spawnState(); + super.setup(identifier, factory, context, callMeta, data); + } + + + /** + * Get a list containing the one and only State. + * @param context ignored. + * @return list with one and only state. + */ + @Override + protected List getStates(Object context) { + ArrayList states = new ArrayList(); + states.add(getState()); + return states; + } + + + /** + * Get the "current" state (there is but one). + * @param cc ignored. + * @return the "current" (only possible) state. + */ + @Override + public State getCurrentState(Object cc) { + return getState(); + } + + + /** + * Get the only possible state. + * @return the state. + */ + protected State getState() { + return getState(null, null); + } + + + /** + * Get the state. + * @param context ignored. + * @param stateID ignored. + * @return the state. + */ + @Override + protected State getState(Object context, String stateID) { + return (state != null) + ? state + : spawnState(); + } + + + /** + * Called via setup. Overridden to avoid cloning all data. + * + * @param artifact The master-artifact. + */ + @Override + protected void initialize( + Artifact artifact, + Object context, + CallMeta meta) + { + logger.debug("FlowVelocityModelArtifact.initialize"); + } +} +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :