teichmann@5831: package org.dive4elements.river.artifacts; felix@1047: felix@1047: import java.util.ArrayList; felix@1047: import java.util.List; felix@1047: felix@1047: import org.apache.log4j.Logger; felix@1047: felix@1047: import org.w3c.dom.Document; felix@1047: teichmann@5831: import org.dive4elements.artifactdatabase.data.DefaultStateData; teichmann@5831: import org.dive4elements.artifactdatabase.state.Facet; teichmann@5831: import org.dive4elements.artifactdatabase.state.FacetActivity; teichmann@5831: import org.dive4elements.artifactdatabase.state.DefaultOutput; teichmann@5831: import org.dive4elements.artifactdatabase.state.State; ingo@1095: teichmann@5831: import org.dive4elements.artifacts.Artifact; teichmann@5831: import org.dive4elements.artifacts.ArtifactFactory; teichmann@5831: import org.dive4elements.artifacts.CallMeta; felix@1078: teichmann@5831: import org.dive4elements.river.model.Gauge; teichmann@5831: import org.dive4elements.river.model.MainValue; teichmann@5831: import org.dive4elements.river.model.River; felix@1101: teichmann@5831: import org.dive4elements.river.artifacts.access.RangeAccess; teichmann@5831: import org.dive4elements.river.artifacts.model.Calculation; teichmann@5831: import org.dive4elements.river.artifacts.model.FacetTypes; teichmann@5831: import org.dive4elements.river.artifacts.model.MainValuesQFacet; teichmann@5831: import org.dive4elements.river.artifacts.model.MainValuesWFacet; teichmann@5831: import org.dive4elements.river.artifacts.model.NamedDouble; teichmann@5831: import org.dive4elements.river.artifacts.model.WstValueTable; teichmann@5831: import org.dive4elements.river.artifacts.model.WstValueTableFactory; felix@1101: teichmann@5831: import org.dive4elements.river.artifacts.states.StaticState; teichmann@5831: import org.dive4elements.river.artifacts.resources.Resources; teichmann@5831: teichmann@5831: import org.dive4elements.river.utils.FLYSUtils; felix@1078: felix@1047: felix@1047: /** felix@4126: * Artifact to access main and extreme values of a river. felix@1072: * This artifact neglects (Static)FLYSArtifacts capabilities of interaction felix@1072: * with the StateEngine by overriding the getState*-methods. felix@1047: */ felix@1047: public class MainValuesArtifact felix@1047: extends StaticFLYSArtifact felix@1809: implements FacetTypes sascha@1059: { felix@1047: /** The logger for this class. */ felix@1065: private static Logger logger = Logger.getLogger(MainValuesArtifact.class); felix@1047: felix@1047: /** The name of the artifact. */ felix@1065: public static final String ARTIFACT_NAME = "mainvalue"; felix@1072: felix@1771: /** The name of the static state for this artifact. */ felix@1771: public static final String STATIC_STATE_NAME = "state.mainvalue.static"; felix@1771: felix@1078: /** One and only state to be in. */ felix@1078: protected transient State state = null; felix@1078: felix@1072: sascha@3558: static { sascha@3558: // TODO: Move to configuration. sascha@3558: FacetActivity.Registry.getInstance().register( sascha@3558: ARTIFACT_NAME, sascha@3558: new FacetActivity() { sascha@3558: @Override sascha@3558: public Boolean isInitialActive( sascha@3558: Artifact artifact, sascha@3558: Facet facet, sascha@3558: String outputName sascha@3558: ) { sascha@3558: return outputName.equals("computed_discharge_curve") sascha@3558: || outputName.equals("duration_curve"); sascha@3558: } sascha@3558: }); sascha@3558: } sascha@3558: felix@5368: felix@1072: /** felix@1072: * Trivial Constructor. felix@1072: */ felix@1047: public MainValuesArtifact() { felix@1072: logger.debug("MainValuesArtifact.MainValuesartifact()"); felix@1047: } felix@1047: felix@1072: felix@1047: /** felix@1047: * Gets called from factory, to set things up. felix@1047: */ felix@1047: @Override felix@1047: public void setup( felix@1047: String identifier, felix@1047: ArtifactFactory factory, felix@1047: Object context, felix@1047: CallMeta callMeta, felix@1047: Document data) felix@1047: { felix@1072: logger.debug("MainValuesArtifact.setup"); felix@1787: state = new StaticState(STATIC_STATE_NAME); felix@1787: felix@4126: List fs = new ArrayList(); bjoern@4497: addFacets(state.getID(), fs); felix@4126: spawnState(); felix@4126: super.setup(identifier, factory, context, callMeta, data); felix@4126: String restriction = getDatacageIDValue(data); felix@4126: logger.debug("mainvalue restriction " + restriction); felix@4126: boolean restricted = restriction.endsWith("q") || restriction.endsWith("w"); felix@4126: if (!restricted || restriction.endsWith("q")) { felix@4126: Facet qfacet0 = new MainValuesQFacet( felix@4126: DURATION_MAINVALUES_Q, felix@4126: Resources.getMsg( felix@4126: callMeta, felix@4126: "facet.discharge_curves.mainvalues.q", felix@4126: "facet.discharge_curves.mainvalues.q"), felix@4126: false); felix@4126: Facet qfacet1 = new MainValuesQFacet( felix@4126: COMPUTED_DISCHARGE_MAINVALUES_Q, felix@4126: Resources.getMsg( felix@4126: callMeta, felix@4126: "facet.discharge_curves.mainvalues.q", felix@4126: "facet.discharge_curves.mainvalues.q"), felix@4126: false); felix@4126: Facet qfacet2 = new MainValuesQFacet( felix@4126: MAINVALUES_Q, felix@4126: Resources.getMsg( felix@4126: callMeta, felix@4126: "facet.discharge_curves.mainvalues.q", felix@4126: "facet.discharge_curves.mainvalues.q"), felix@4126: true); felix@5370: Facet qfacet3 = new MainValuesQFacet( felix@5370: HISTORICAL_DISCHARGE_MAINVALUES_Q, felix@5370: Resources.getMsg( felix@5370: callMeta, felix@5370: "historical_discharge.mainvalues.q", felix@5370: "historical_discharge.mainvalues.q"), felix@5370: false); teichmann@4736: felix@4126: fs.add(qfacet0); felix@4126: fs.add(qfacet1); felix@4126: fs.add(qfacet2); felix@5370: fs.add(qfacet3); felix@4126: } felix@4126: if (!restricted || restriction.endsWith("w")) { felix@5370: Facet wfacet1 = new MainValuesWFacet( felix@5370: COMPUTED_DISCHARGE_MAINVALUES_W, felix@5370: Resources.getMsg( felix@5370: callMeta, felix@5370: "facet.discharge_curves.mainvalues.w", felix@5370: "facet.discharge_curves.mainvalues.w"), felix@5370: false); felix@5370: Facet wfacet2 = new MainValuesWFacet( felix@5370: MAINVALUES_W, felix@5370: Resources.getMsg( felix@5370: callMeta, felix@5370: "facet.discharge_curves.mainvalues.w", felix@5370: "facet.discharge_curves.mainvalues.w"), felix@5370: true); felix@5370: Facet wfacet3 = new MainValuesWFacet( felix@5370: HISTORICAL_DISCHARGE_MAINVALUES_W, felix@5370: Resources.getMsg( felix@5370: callMeta, felix@5370: "historical_discharge.mainvalues.w", felix@5370: "historical_discharge.mainvalues.w"), felix@5370: true); felix@4126: fs.add(wfacet1); felix@4126: fs.add(wfacet2); felix@5370: fs.add(wfacet3); felix@4126: } felix@1080: } felix@1080: felix@1771: felix@1771: /** felix@1771: * Create "the" state. felix@1771: */ felix@1112: protected State spawnState() { felix@1787: state = new StaticState(STATIC_STATE_NAME); bjoern@4497: List fs = (List) getFacets(STATIC_STATE_NAME); felix@1771: felix@1847: DefaultOutput mainValuesOutput = new DefaultOutput( felix@1765: "computed_discharge_curve", felix@1765: "output.computed_discharge_curve", "image/png", felix@1771: fs, felix@1765: "chart"); felix@1112: felix@1847: state.getOutputs().add(mainValuesOutput); felix@1112: return state; felix@1112: } felix@1112: felix@1080: felix@5368: /** Get important data from the 'calling' artifact. */ felix@1080: @Override felix@1080: protected void initialize(Artifact artifact, Object context, CallMeta meta) { felix@1080: logger.debug("MainValuesArtifact.initialize"); raimund@2134: FLYSArtifact winfo = (FLYSArtifact) artifact; rrenkert@4937: RangeAccess rangeAccess = new RangeAccess(winfo, null); felix@5290: double [] locations = rangeAccess.getKmRange(); felix@5290: felix@1847: if (locations != null) { felix@1847: double location = locations[0]; rrenkert@4937: addData("ld_locations", new DefaultStateData("ld_locations", null, null, felix@1085: String.valueOf(location))); felix@1847: } felix@1847: else { felix@5290: logger.error("No location for mainvalues given."); felix@1847: } felix@1922: importData(winfo, "river"); felix@5371: // In the case of DischargeWQCurves, there are no locations, but a gauge. felix@5371: if (getDataAsString("ld_locations") == null) { felix@5371: // TODO its a tad difficult to remodel Range/Gauge-Access to felix@5371: // do this. felix@5371: String refGaugeID = winfo.getDataAsString("reference_gauge"); felix@5371: if (refGaugeID != null) { felix@5371: Gauge g = Gauge.getGaugeByOfficialNumber(Integer.parseInt(refGaugeID)); felix@5371: addData("ld_locations", new DefaultStateData("ld_locations", null, null, felix@5371: String.valueOf(g.getStation()))); felix@5371: } felix@5371: else { felix@5371: logger.error("MainValuesArtifact: No location/gauge."); felix@5371: } felix@5371: } felix@1047: } felix@1047: felix@1047: felix@1047: /** felix@1072: * Get a list containing the one and only State. felix@1085: * @param context ignored. felix@1072: * @return list with one and only state. felix@1047: */ felix@1072: @Override felix@1072: protected List getStates(Object context) { felix@1072: ArrayList states = new ArrayList(); felix@1112: states.add(getState()); felix@1072: return states; felix@1072: } felix@1047: felix@1047: felix@1072: /** felix@1072: * Get the "current" state. felix@1072: * @param cc ignored. felix@1072: * @return the "current" state. felix@1072: */ felix@1072: @Override ingo@1654: public State getCurrentState(Object cc) { felix@1072: return getState(); felix@1072: } felix@1072: felix@1072: felix@1072: /** felix@1072: * Get the only possible state. felix@1072: * @return the state. felix@1072: */ felix@1072: protected State getState() { felix@1072: return getState(null, null); felix@1072: } felix@1072: felix@1072: felix@1072: /** felix@1072: * Get the state. felix@1072: * @param context ignored. felix@1072: * @param stateID ignored. felix@1072: * @return the state. felix@1072: */ felix@1072: @Override felix@1072: protected State getState(Object context, String stateID) { felix@1112: if (state != null) felix@1112: return state; felix@1112: else felix@1112: return spawnState(); felix@1078: } felix@1078: felix@1093: felix@1085: /** felix@1089: * Access the Gauge that the mainvalues are taken from. felix@1089: * @return Gauge that main values are taken from or null in case of felix@1089: * invalid parameterization. felix@1089: */ felix@1085: protected Gauge getGauge() { felix@1100: River river = FLYSUtils.getRiver(this); felix@1065: felix@1847: // TODO use helper to get location as double rrenkert@4937: String locationStr = getDataAsString("ld_locations"); felix@1847: felix@5290: if (river == null) { felix@5290: logger.error("River is null"); felix@5290: return null; felix@5290: } felix@5290: felix@5290: if (locationStr == null) { felix@5290: logger.error("Locationstr is null"); felix@1085: return null; felix@1072: } felix@1065: felix@1847: double location = Double.parseDouble(locationStr); felix@1079: felix@1085: return river.determineGaugeByPosition(location); felix@1085: } felix@1085: felix@1089: felix@1089: /** felix@1101: * Get current location. felix@1101: * @return the location. felix@1089: */ felix@1101: public double getLocation() { rrenkert@4937: double location = Double.parseDouble(getDataAsString("ld_locations")); felix@1101: return location; felix@1089: } felix@1089: felix@1089: felix@1089: /** felix@1089: * Get a list of "Q" main values. felix@1089: * @return list of Q main values. felix@1089: */ felix@1957: public List getMainValuesQ(boolean atGauge) { felix@1089: List filteredList = new ArrayList(); felix@1085: Gauge gauge = getGauge(); felix@1101: WstValueTable interpolator = WstValueTableFactory.getTable(FLYSUtils.getRiver(this)); felix@1101: Calculation c = new Calculation(); felix@1101: double w_out[] = {0.0f}; felix@1101: double q_out[] = {0.0f}; felix@1101: double kms[] = {getLocation()}; felix@1101: double gaugeStation = gauge.getStation().doubleValue(); felix@1085: if (gauge != null) { felix@1085: List orig = gauge.getMainValues(); felix@1085: for (MainValue mv : orig) { felix@1085: if (mv.getMainValue().getType().getName().equals("Q")) { felix@1957: if (atGauge) { felix@1957: q_out[0] = mv.getValue().doubleValue(); felix@1957: } felix@1957: else { felix@1957: interpolator.interpolate(mv.getValue().doubleValue(), felix@1101: gaugeStation, kms, w_out, q_out, c); felix@1957: } felix@1089: filteredList.add(new NamedDouble( felix@1089: mv.getMainValue().getName(), felix@1101: q_out[0] felix@1089: )); felix@1085: } felix@1085: } felix@1065: } felix@1085: return filteredList; felix@1085: } felix@1085: felix@1089: felix@1089: /** felix@1089: * Get a list of "W" main values. felix@1957: * @param atGauge if true, do not interpolate felix@1089: * @return list of W main values. felix@1089: */ felix@1957: public List getMainValuesW(boolean atGauge) { felix@1089: List filteredList = new ArrayList(); felix@1085: Gauge gauge = getGauge(); felix@1101: WstValueTable interpolator = WstValueTableFactory.getTable(FLYSUtils.getRiver(this)); felix@1101: Calculation c = new Calculation(); felix@1847: felix@1101: double gaugeStation = gauge.getStation().doubleValue(); felix@1101: double w_out[] = {0.0f}; felix@1101: double q_out[] = {0.0f}; felix@1101: double kms[] = {getLocation()}; felix@1085: if (gauge != null) { felix@1085: List orig = gauge.getMainValues(); felix@1085: for (MainValue mv : orig) { felix@1957: if (atGauge) { felix@1957: if (mv.getMainValue().getType().getName().equals("W")) { felix@1957: filteredList.add(new NamedDouble(mv.getMainValue().getName(), felix@1957: mv.getValue().doubleValue())); sascha@3076: felix@1957: } felix@1957: } else felix@1101: // We cannot interpolate the W values, so derive them felix@1101: // from given Q values. felix@1101: if (mv.getMainValue().getType().getName().equals("Q")) { felix@1101: interpolator.interpolate(mv.getValue().doubleValue(), felix@1101: gaugeStation, kms, w_out, q_out, c); felix@1089: filteredList.add(new NamedDouble( felix@1101: "W(" + mv.getMainValue().getName() +")", felix@1101: w_out[0] felix@1089: )); felix@1085: } felix@1085: } felix@1065: } felix@1085: return filteredList; felix@1065: } felix@5398: felix@5398: felix@5398: /** felix@5398: * Returns the name of this artifact ('mainvalue'). felix@5398: * felix@5398: * @return 'mainvalue' felix@5398: */ felix@5398: public String getName() { felix@5398: return ARTIFACT_NAME; felix@5398: } felix@1047: } felix@1809: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :