Mercurial > dive4elements > river
view flys-artifacts/src/main/java/de/intevation/flys/artifacts/WINFOArtifact.java @ 965:79251b1d47da
Modified the CollectionMonitor to recommend artifacts for the current state's outputs only.
flys-artifacts/trunk@2385 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
---|---|
date | Thu, 21 Jul 2011 14:00:09 +0000 |
parents | 5de90b0cff8e |
children | 3f3988bb6284 |
line wrap: on
line source
package de.intevation.flys.artifacts; import java.util.Arrays; import java.util.ArrayList; import java.util.List; import java.util.Map; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; import org.apache.log4j.Logger; import de.intevation.artifacts.ArtifactNamespaceContext; import de.intevation.artifacts.CallContext; import de.intevation.artifactdatabase.ProtocolUtils; import de.intevation.artifactdatabase.state.Facet; import de.intevation.artifactdatabase.state.Output; import de.intevation.artifactdatabase.state.State; import de.intevation.artifactdatabase.state.StateEngine; import de.intevation.artifactdatabase.transition.TransitionEngine; import de.intevation.artifacts.common.utils.XMLUtils; import de.intevation.flys.model.Gauge; import de.intevation.flys.model.River; import de.intevation.flys.artifacts.states.DefaultState; import de.intevation.flys.artifacts.context.FLYSContext; import de.intevation.flys.artifacts.model.DischargeTables; import de.intevation.flys.artifacts.model.MainValuesFactory; import de.intevation.flys.artifacts.model.WQKms; import de.intevation.flys.artifacts.model.WstValueTable; import de.intevation.flys.artifacts.model.WstValueTableFactory; import de.intevation.flys.artifacts.model.Calculation; import de.intevation.flys.artifacts.model.Calculation1; import de.intevation.flys.artifacts.model.Calculation2; import de.intevation.flys.artifacts.model.Calculation3; import de.intevation.flys.artifacts.model.Calculation4; import de.intevation.flys.artifacts.model.CalculationResult; import de.intevation.flys.artifacts.model.Segment; /** * The default WINFO artifact. * * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> */ public class WINFOArtifact extends FLYSArtifact { /** The logger for this class */ private static Logger logger = Logger.getLogger(WINFOArtifact.class); /** The name of the artifact.*/ public static final String ARTIFACT_NAME = "winfo"; /** XPath */ public static final String XPATH_STATIC_UI ="/art:result/art:ui/art:static"; /** * The default constructor. */ public WINFOArtifact() { } /** * This method returns a description of this artifact. * * @param data Some data. * @param context The CallContext. * * @return the description of this artifact. */ public Document describe(Document data, CallContext context) { logger.debug("Describe: the current state is: " + getCurrentStateId()); if (logger.isDebugEnabled()) { dumpArtifact(); } FLYSContext flysContext = getFlysContext(context); StateEngine stateEngine = (StateEngine) flysContext.get( FLYSContext.STATE_ENGINE_KEY); TransitionEngine transitionEngine = (TransitionEngine) flysContext.get( FLYSContext.TRANSITION_ENGINE_KEY); List<State> reachable = transitionEngine.getReachableStates( this, getCurrentState(context), stateEngine); Document description = XMLUtils.newDocument(); XMLUtils.ElementCreator creator = new XMLUtils.ElementCreator( description, ArtifactNamespaceContext.NAMESPACE_URI, ArtifactNamespaceContext.NAMESPACE_PREFIX); Element root = ProtocolUtils.createRootNode(creator); description.appendChild(root); State current = getCurrentState(context); ProtocolUtils.appendDescribeHeader(creator, root, identifier(), hash()); ProtocolUtils.appendState(creator, root, current); ProtocolUtils.appendReachableStates(creator, root, reachable); Element name = ProtocolUtils.createArtNode( creator, "name", new String[] { "value" }, new String[] { getName() }); Element ui = ProtocolUtils.createArtNode( creator, "ui", null, null); Element staticUI = ProtocolUtils.createArtNode( creator, "static", null, null); Element outs = ProtocolUtils.createArtNode( creator, "outputmodes", null, null); appendOutputModes(description, outs, context, identifier()); appendStaticUI(description, staticUI, context, identifier()); Element dynamic = current.describe( this, description, root, context, identifier()); if (dynamic != null) { ui.appendChild(dynamic); } ui.appendChild(staticUI); root.appendChild(name); root.appendChild(ui); root.appendChild(outs); return description; } /** * Returns the name of the concrete artifact. * * @return the name of the concrete artifact. */ public String getName() { return ARTIFACT_NAME; } protected void appendOutputModes( Document doc, Element outs, CallContext context, String uuid) { List<String> stateIds = getPreviousStateIds(); XMLUtils.ElementCreator creator = new XMLUtils.ElementCreator( doc, ArtifactNamespaceContext.NAMESPACE_URI, ArtifactNamespaceContext.NAMESPACE_PREFIX); FLYSContext flysContext = getFlysContext(context); StateEngine engine = (StateEngine) flysContext.get( FLYSContext.STATE_ENGINE_KEY); for (String stateId: stateIds) { logger.debug("Append output modes for state: " + stateId); DefaultState state = (DefaultState) engine.getState(stateId); List<Output> list = state.getOutputs(); if (list == null || list.size() == 0) { logger.debug("-> No output modes for this state."); continue; } List<Facet> fs = facets.get(stateId); if (fs == null || fs.size() == 0) { logger.debug("No facets found."); continue; } logger.debug("Found " + fs.size() + " facets in previous states."); List<Output> generated = generateOutputs(list, fs); ProtocolUtils.appendOutputModes(doc, outs, generated); } try { DefaultState cur = (DefaultState) getCurrentState(context); if (cur.validate(this, context)) { List<Output> list = cur.getOutputs(); if (list != null && list.size() > 0) { logger.debug( "Append output modes for state: " + cur.getID()); List<Facet> fs = facets.get(cur.getID()); if (fs != null && fs.size() > 0) { List<Output> generated = generateOutputs(list, fs); logger.debug("Found " + fs.size() + " current facets."); if (!generated.isEmpty()) { ProtocolUtils.appendOutputModes( doc, outs, generated); } } else { logger.debug("No facets found for the current state."); } } } } catch (IllegalArgumentException iae) { // state is not valid, so we do not append its outputs. } } /** * This method appends the static data - that has already been inserted by * the user - to the static node of the DESCRIBE document. * * @param doc The document. * @param ui The root node. * @param context The CallContext. * @param uuid The identifier of the artifact. */ protected void appendStaticUI( Document doc, Node ui, CallContext context, String uuid) { List<String> stateIds = getPreviousStateIds(); FLYSContext flysContext = getFlysContext(context); StateEngine engine = (StateEngine) flysContext.get( FLYSContext.STATE_ENGINE_KEY); for (String stateId: stateIds) { logger.debug("Append static data for state: " + stateId); DefaultState state = (DefaultState) engine.getState(stateId); ui.appendChild(state.describeStatic(this, doc, ui, context, uuid)); } } // // METHODS FOR RETRIEVING COMPUTED DATA FOR DIFFERENT CHART TYPES // /** * Returns the data that is computed by a waterlevel computation. * * @return an array of data triples that consist of W, Q and Kms. */ public CalculationResult getWaterlevelData() { logger.debug("WINFOArtifact.getWaterlevelData"); River river = getRiver(); if (river == null) { return error(new WQKms[0], "No river selected."); } double[] kms = getKms(); if (kms == null) { return error(new WQKms[0], "No Kms selected."); } double[] qs = getQs(); double[] ws = null; boolean qSel = true; if (qs == null) { logger.debug("Determine Q values based on a set of W values."); qSel = false; ws = getWs(); qs = getQsForWs(ws); if (qs == null) { return error(new WQKms[0], "conversion ws to qs failed."); } } WstValueTable wst = WstValueTableFactory.getTable(river); if (wst == null) { return error(new WQKms[0], "No Wst found for selected river."); } double [] range = getDistance(); if (range == null) { return error(new WQKms[0], "No range found"); } double refKm; if (isFreeQ()) { refKm = range[0]; logger.debug("'free' calculation (km " + refKm + ")"); } else { Gauge gauge = river.determineGaugeByPosition(range[0]); if (gauge == null) { return error( new WQKms[0], "No gauge found for km " + range[0]); } refKm = gauge.getStation().doubleValue(); logger.debug( "reference gauge: " + gauge.getName() + " (km " + refKm + ")"); } return computeWaterlevelData(kms, qs, ws, wst, refKm); } /** * Computes the data of a waterlevel computation based on the interpolation * in WstValueTable. * * @param kms The kilometer values. * @param qa The discharge values. * @param wst The WstValueTable used for the interpolation. * * @return an array of data triples that consist of W, Q and Kms. */ public static CalculationResult computeWaterlevelData( double [] kms, double [] qs, double [] ws, WstValueTable wst, double refKm ) { logger.info("WINFOArtifact.computeWaterlevelData"); Calculation1 calc1 = new Calculation1(kms, qs, ws, refKm); return calc1.calculate(wst); } /** * Returns the data that is computed by a duration curve computation. * * @return the data computed by a duration curve computation. */ public CalculationResult getDurationCurveData() { logger.debug("WINFOArtifact.getDurationCurveData"); River r = getRiver(); if (r == null) { return error(null, "Cannot determine river."); } Gauge g = getGauge(); if (g == null) { return error(null, "Cannot determine gauge."); } double[] locations = getLocations(); if (locations == null) { return error(null, "Cannot determine location."); } WstValueTable wst = WstValueTableFactory.getTable(r); if (wst == null) { return error(null, "No Wst found for selected river."); } return computeDurationCurveData(g, wst, locations[0]); } /** * Computes the data used to create duration curves. * * @param gauge The selected gauge. * @param location The selected location. * * @return the computed data. */ public static CalculationResult computeDurationCurveData( Gauge gauge, WstValueTable wst, double location) { logger.info("WINFOArtifact.computeDurationCurveData"); Object[] obj = MainValuesFactory.getDurationCurveData(gauge); int[] days = (int[]) obj[0]; double[] qs = (double[]) obj[1]; Calculation3 calculation = new Calculation3(location, days, qs); return calculation.calculate(wst); } /** * Returns the data that is used to create discharge curves. * */ public CalculationResult getDischargeCurveData() { River river = getRiver(); if (river == null) { return error(new WQKms[0], "no river found"); } double [] distance = getDistance(); if (distance == null) { return error(new WQKms[0], "no range found"); } List<Gauge> gauges = river.determineGauges(distance[0], distance[1]); if (gauges.isEmpty()) { return error(new WQKms[0], "no gauges found"); } String [] names = new String[gauges.size()]; for (int i = 0; i < names.length; ++i) { names[i] = gauges.get(i).getName(); } DischargeTables dt = new DischargeTables(river.getName(), names); Map<String, double [][]> map = dt.getValues(100d); ArrayList<WQKms> res = new ArrayList<WQKms>(); for (Gauge gauge: gauges) { String name = gauge.getName(); double [][] values = map.get(name); if (values == null) { continue; } double [] kms = new double[values[0].length]; Arrays.fill(kms, gauge.getStation().doubleValue()); res.add(new WQKms(kms, values[0], values[1], name)); } return new CalculationResult( res.toArray(new WQKms[res.size()]), new Calculation()); } /** * Returns the data that is computed by a discharge curve computation. * * @return the data computed by a discharge curve computation. */ public CalculationResult getComputedDischargeCurveData() throws NullPointerException { logger.debug("WINFOArtifact.getComputedDischargeCurveData"); River r = getRiver(); if (r == null) { return error(new WQKms[0], "Cannot determine river."); } double[] locations = getLocations(); if (locations == null) { return error(new WQKms[0], "Cannot determine location."); } WstValueTable wst = WstValueTableFactory.getTable(r); if (wst == null) { return error(new WQKms[0], "No Wst found for selected river."); } return computeDischargeCurveData(wst, locations[0]); } /** * Computes the data used to create computed discharge curves. * * @param wst The WstValueTable that is used for the interpolation. * @param location The location where the computation should be based on. * * @return an object that contains tuples of W/Q values at the specified * location. */ public static CalculationResult computeDischargeCurveData( WstValueTable wst, double location) { logger.info("WINFOArtifact.computeDischargeCurveData"); Calculation2 calculation = new Calculation2(location); return calculation.calculate(wst); } protected static final CalculationResult error(Object data, String msg) { return new CalculationResult(data, new Calculation(msg)); } /** * Returns the data computed by the discharge longitudinal section * computation. * * @return an array of WQKms object - one object for each given Q value. */ public CalculationResult getDischargeLongitudinalSectionData() { logger.debug("WINFOArtifact.getDischargeLongitudinalSectionData"); River river = getRiver(); if (river == null) { logger.debug("No river selected."); return error(new WQKms[0], "No river selected."); } WstValueTable table = WstValueTableFactory.getTable(river); if (table == null) { logger.debug("No wst found for selected river."); return error(new WQKms[0], "No wst found for selected river."); } List<Segment> segments = getSegments(); if (segments == null) { logger.debug("Cannot create segments."); return error(new WQKms[0], "Cannot create segments."); } double [] range = getFromToStep(); if (range == null) { logger.debug("Cannot figure out range."); return error(new WQKms[0], "Cannot figure out range."); } Calculation4 calc4 = new Calculation4(segments, river, isQ()); return calc4.calculate(table, range[0], range[1], range[2]); } } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :