dive4elements/river: artifacts/src/main/java/org/dive4elements/river/artifacts/states/DefaultState.java annotate

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/states/DefaultState.java @ 9801:1d7a72a50183 3.2.x tip

Assume Compose V2, consistently

author	Tom Gottfried <tom@intevation.de>
date	Thu, 23 Nov 2023 10:14:13 +0100
parents	0a5239a1e46e
children

rev	line source
5863 4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	2 * Software engineering by Intevation GmbH
4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	3 *
5994 af13ceeba52a Removed trailing whitespace. Sascha L. Teichmann <teichmann@intevation.de> parents: 5909 diff changeset	4 * This file is Free Software under the GNU AGPL (>=v3)
5863 4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
5994 af13ceeba52a Removed trailing whitespace. Sascha L. Teichmann <teichmann@intevation.de> parents: 5909 diff changeset	6 * documentation coming with Dive4Elements River for details.
5863 4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	7 */
4897a58c8746 River artifacts: Added new copyright headers. Sascha L. Teichmann <teichmann@intevation.de> parents: 5838 diff changeset	8
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	9 package org.dive4elements.river.artifacts.states;
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	10
669 23fced04ffdb #103 PART 1: The numbers which are written into the static DESCRIBE part are i18n formatted now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 660 diff changeset	11 import java.text.NumberFormat;
23fced04ffdb #103 PART 1: The numbers which are written into the static DESCRIBE part are i18n formatted now. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 660 diff changeset	12 import java.util.Locale;
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	13 import java.util.Map;
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	14 import java.util.List;
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	15
9726 0a5239a1e46e Upgrade to Log4j 2 Tom Gottfried <tom@intevation.de> parents: 8636 diff changeset	16 import org.apache.logging.log4j.Logger;
0a5239a1e46e Upgrade to Log4j 2 Tom Gottfried <tom@intevation.de> parents: 8636 diff changeset	17 import org.apache.logging.log4j.LogManager;
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	18
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	19 import org.w3c.dom.Document;
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	20 import org.w3c.dom.Element;
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	21 import org.w3c.dom.Node;
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	22
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	23 import org.dive4elements.artifacts.Artifact;
bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	24 import org.dive4elements.artifacts.ArtifactNamespaceContext;
bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	25 import org.dive4elements.artifacts.CallContext;
bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	26 import org.dive4elements.artifacts.CallMeta;
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	27
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	28 import org.dive4elements.artifacts.common.utils.XMLUtils;
bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	29 import org.dive4elements.artifacts.common.utils.XMLUtils.ElementCreator;
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	30
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	31 import org.dive4elements.artifactdatabase.ProtocolUtils;
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	32
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	33 import org.dive4elements.artifactdatabase.data.StateData;
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	34
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	35 import org.dive4elements.artifactdatabase.state.AbstractState;
bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	36 import org.dive4elements.artifactdatabase.state.Facet;
bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	37
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	38 import org.dive4elements.river.artifacts.D4EArtifact;
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	39
bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4155 diff changeset	40 import org.dive4elements.river.artifacts.resources.Resources;
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	41
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	42
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	43 /**
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	44 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	45 */
8275 97e148487186 The default state is no more abstract. Raimund Renkert <rrenkert@intevation.de> parents: 8202 diff changeset	46 public class DefaultState extends AbstractState {
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	47
8202 e4606eae8ea5 sed src/*/.java 's/logger/log/g' Sascha L. Teichmann <teichmann@intevation.de> parents: 6052 diff changeset	48 /** The log that is used in this class. */
9726 0a5239a1e46e Upgrade to Log4j 2 Tom Gottfried <tom@intevation.de> parents: 8636 diff changeset	49 private static Logger log = LogManager.getLogger(DefaultState.class);
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	50
2015 61667c3a0003 Disabled default values in Artifact's DESCRIBE document - added a system property to re-enable those default values. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1768 diff changeset	51
1768 41ba2276d785 Cosmetics. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1743 diff changeset	52 /** The three possible compute types. */
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	53 public static enum ComputeType {
942 796c54058dc4 Added artifacts/states for WMS background an river axis and a configuration for the output-defaults. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 941 diff changeset	54 FEED, ADVANCE, INIT
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	55 }
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	56
1768 41ba2276d785 Cosmetics. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1743 diff changeset	57
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	58 protected StateData getData(D4EArtifact artifact, String name) {
624 929137ee8154 ISSUE-62 (part I/II) States are no longer filled with data - if a state needs user input, it needs to query the owner artifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 379 diff changeset	59 return artifact.getData(name);
929137ee8154 ISSUE-62 (part I/II) States are no longer filled with data - if a state needs user input, it needs to query the owner artifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 379 diff changeset	60 }
929137ee8154 ISSUE-62 (part I/II) States are no longer filled with data - if a state needs user input, it needs to query the owner artifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 379 diff changeset	61
929137ee8154 ISSUE-62 (part I/II) States are no longer filled with data - if a state needs user input, it needs to query the owner artifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 379 diff changeset	62
1136 8da5f5a9ed3c Cosmetics, docs. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1050 diff changeset	63 /**
8da5f5a9ed3c Cosmetics, docs. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1050 diff changeset	64 * Append to a node and return xml description relevant for gui.
8da5f5a9ed3c Cosmetics, docs. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1050 diff changeset	65 */
134 f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	66 public Element describeStatic(
624 929137ee8154 ISSUE-62 (part I/II) States are no longer filled with data - if a state needs user input, it needs to query the owner artifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 379 diff changeset	67 Artifact artifact,
134 f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	68 Document document,
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	69 Node root,
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	70 CallContext context,
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	71 String uuid)
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	72 {
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	73 ElementCreator creator = new ElementCreator(
134 f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	74 document,
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	75 ArtifactNamespaceContext.NAMESPACE_URI,
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	76 ArtifactNamespaceContext.NAMESPACE_PREFIX);
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	77
142 b43671a551d1 Append human readable strings of the selected values to the DESCRIBE output. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 136 diff changeset	78 CallMeta meta = context.getMeta();
b43671a551d1 Append human readable strings of the selected values to the DESCRIBE output. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 136 diff changeset	79
5909 6dfd967dcae9 D4E river: Fixed substitution on help URL. Sascha L. Teichmann <teichmann@intevation.de> parents: 5867 diff changeset	80 String helpText = getHelpText();
6dfd967dcae9 D4E river: Fixed substitution on help URL. Sascha L. Teichmann <teichmann@intevation.de> parents: 5867 diff changeset	81 if (helpText != null) {
6dfd967dcae9 D4E river: Fixed substitution on help URL. Sascha L. Teichmann <teichmann@intevation.de> parents: 5867 diff changeset	82 helpText = replaceHelpUrl(
6dfd967dcae9 D4E river: Fixed substitution on help URL. Sascha L. Teichmann <teichmann@intevation.de> parents: 5867 diff changeset	83 Resources.getMsg(meta, helpText, helpText));
6dfd967dcae9 D4E river: Fixed substitution on help URL. Sascha L. Teichmann <teichmann@intevation.de> parents: 5867 diff changeset	84 }
2661 17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	85
142 b43671a551d1 Append human readable strings of the selected values to the DESCRIBE output. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 136 diff changeset	86 String label = Resources.getMsg(meta, getID(), getID());
136 2e510c998adb New state for the location/distance input and some litte modifications of the DefaultState. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 135 diff changeset	87 Element ui = ProtocolUtils.createArtNode(
134 f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	88 creator, "state",
2661 17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	89 new String[] { "name", "uiprovider", "label", "helpText"},
17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	90 new String[] { getID(), getUIProvider(), label, helpText });
134 f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	91
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	92 Map<String, StateData> theData = getData();
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	93 if (theData == null) {
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	94 return ui;
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	95 }
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	96
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	97 D4EArtifact flys = (D4EArtifact)artifact;
134 f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	98
3732 fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	99 for (String name: theData.keySet()) {
1180 1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	100 appendStaticData(flys, context, creator, ui, name);
134 f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	101 }
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	102
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	103 return ui;
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	104 }
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	105
f3dfa188d8b2 Let the states describe the static ui part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 129 diff changeset	106
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	107 protected void appendStaticData(
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	108 D4EArtifact flys,
1180 1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	109 CallContext context,
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	110 ElementCreator cr,
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	111 Element ui,
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	112 String name
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	113 ) {
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	114 StateData data = getData(flys, name);
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	115 String value = (data != null) ? (String) data.getValue() : null;
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	116
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	117 if (value == null) {
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	118 return;
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	119 }
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	120
2205 a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	121 String type = data.getType();
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	122
8202 e4606eae8ea5 sed src/*/.java 's/logger/log/g' Sascha L. Teichmann <teichmann@intevation.de> parents: 6052 diff changeset	123 if (log.isDebugEnabled()) {
e4606eae8ea5 sed src/*/.java 's/logger/log/g' Sascha L. Teichmann <teichmann@intevation.de> parents: 6052 diff changeset	124 log.debug(
3732 fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	125 "Append element " + type + "'" +
fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	126 name + "' (" + value + ")");
fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	127 }
2205 a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	128
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	129 Element e = createStaticData(flys, cr, context, name, value, type);
1180 1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	130
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	131 ui.appendChild(e);
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	132
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	133 }
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	134
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	135
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	136 /**
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	137 * Creates a <i>data</i> element used in the static part of the DESCRIBE
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	138 * document.
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	139 *
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	140 * @param creator The ElementCreator that is used to build new Elements.
3284 d9af29a4bb85 Various cosmetic doc fixes. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 2661 diff changeset	141 * @param cc The CallContext object used for nested i18n retrieval.
1180 1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	142 * @param name The name of the data item.
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	143 * @param value The value as string.
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	144 *
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	145 * @return an Element.
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	146 */
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	147 protected Element createStaticData(
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	148 D4EArtifact flys,
1180 1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	149 ElementCreator creator,
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	150 CallContext cc,
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	151 String name,
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	152 String value,
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	153 String type
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	154 ) {
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	155 Element dataElement = creator.create("data");
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	156 creator.addAttr(dataElement, "name", name, true);
1180 1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	157 creator.addAttr(dataElement, "type", type, true);
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	158
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	159 Element itemElement = creator.create("item");
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	160 creator.addAttr(itemElement, "value", value, true);
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	161
2205 a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	162 creator.addAttr(
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	163 itemElement,
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	164 "label",
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	165 getLabelFor(cc, name, value, type),
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	166 true);
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	167
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	168 dataElement.appendChild(itemElement);
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	169
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	170 return dataElement;
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	171 }
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	172
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	173
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	174 /**
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	175 * @param cc
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	176 * @param name
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	177 * @param value
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	178 * @param type
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	179 *
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	180 * @return
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	181 */
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	182 protected String getLabelFor(
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	183 CallContext cc,
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	184 String name,
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	185 String value,
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	186 String type
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	187 ) {
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	188 CallMeta meta = cc.getMeta();
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	189
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	190 try {
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	191 // XXX A better way to format the output would be to use the
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	192 // 'type' value of the data objects.
3732 fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	193 double doubleVal = Double.parseDouble(value);
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	194 Locale l = Resources.getLocale(meta);
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	195 NumberFormat nf = NumberFormat.getInstance(l);
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	196
2205 a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	197 return nf.format(doubleVal);
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	198 }
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	199 catch (NumberFormatException nfe) {
2205 a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	200 return Resources.getMsg(meta, value, value);
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	201 }
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	202 }
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	203
fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	204
3407 70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	205 /**
8615 054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	206 * This method returns the default value and label for <i>data</i>.
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	207 *
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	208 * Override this method in a subclass to set an appropiate default
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	209 * value.
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	210 * The default label can be ignored by the client (e.g. the gwt-client).
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	211 * but shall not be null.
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	212 *
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	213 * Example implementation:
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	214 * if (data != null && data.getName().equals("the_answer")) {
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	215 * return new String[] {"42", "the_answer"};
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	216 * }
054d1b57ae4a (issue1755) Clarify how default mecahnism works and remove unused config value. Andre Heinecke <andre.heinecke@intevation.de> parents: 8275 diff changeset	217 *
3407 70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	218 * @param context The CallContext used for i18n.
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	219 * @param data The data objects that the defaults are for.
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	220 * @return a String[] with [default value, default label].
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	221 */
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	222 protected String[] getDefaultsFor(CallContext context, StateData data) {
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	223 return null;
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	224 }
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	225
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	226
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	227 public Element describe(
306 35301cc3b875 Modified the states' describe() method - related to the last commit. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 142 diff changeset	228 Artifact artifact,
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	229 Document document,
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	230 Node root,
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	231 CallContext context,
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	232 String uuid)
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	233 {
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	234 ElementCreator creator = new ElementCreator(
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	235 document,
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	236 ArtifactNamespaceContext.NAMESPACE_URI,
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	237 ArtifactNamespaceContext.NAMESPACE_PREFIX);
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	238
6052 799af7909e8d Expand the Help Url also in the describe method Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	239 String helpText = getHelpText();
799af7909e8d Expand the Help Url also in the describe method Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	240 if (helpText != null) {
799af7909e8d Expand the Help Url also in the describe method Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	241 helpText = replaceHelpUrl(
799af7909e8d Expand the Help Url also in the describe method Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	242 Resources.getMsg(context.getMeta(), helpText, helpText));
799af7909e8d Expand the Help Url also in the describe method Andre Heinecke <aheinecke@intevation.de> parents: 5994 diff changeset	243 }
2661 17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	244
135 2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	245 Element ui = null;
2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	246 String uiprovider = getUIProvider();
2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	247 if (uiprovider != null) {
1136 8da5f5a9ed3c Cosmetics, docs. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1050 diff changeset	248 ui = ProtocolUtils.createArtNode(
135 2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	249 creator, "dynamic",
2661 17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	250 new String[] { "uiprovider", "helpText" },
17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	251 new String[] { uiprovider, helpText });
135 2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	252 }
2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	253 else {
2661 17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	254 ui = ProtocolUtils.createArtNode(
17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	255 creator, "dynamic",
17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	256 new String[] { "helpText" },
17927c60ac1c Added 'helpText' fields to the transition model. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2214 diff changeset	257 new String[] { helpText });
135 2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	258 }
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	259
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	260 Map<String, StateData> theData = getData();
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	261 if (theData == null) {
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	262 return ui;
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	263 }
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	264
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	265 D4EArtifact flys = (D4EArtifact)artifact;
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	266
3732 fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	267 for (String name: theData.keySet()) {
624 929137ee8154 ISSUE-62 (part I/II) States are no longer filled with data - if a state needs user input, it needs to query the owner artifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 379 diff changeset	268 StateData data = getData(flys, name);
929137ee8154 ISSUE-62 (part I/II) States are no longer filled with data - if a state needs user input, it needs to query the owner artifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 379 diff changeset	269
3732 fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	270 if (data == null) {
fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	271 data = getData(name);
fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	272 }
624 929137ee8154 ISSUE-62 (part I/II) States are no longer filled with data - if a state needs user input, it needs to query the owner artifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 379 diff changeset	273
313 89bd0417418f The location/distance state now writes default values into DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 306 diff changeset	274 Element select = createData(creator, artifact, data, context);
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	275
3407 70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	276 String[] defaults = getDefaultsFor(context, data);
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	277 if (defaults != null && defaults.length > 1) {
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	278 creator.addAttr(select, "defaultValue", defaults[0], true);
70e9d56e21fc Set default value of MINFO SQ relation's outliers parameter to 3. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 3284 diff changeset	279 creator.addAttr(select, "defaultLabel", defaults[1], true);
630 40d3039f85ac ISSUE-40 (part I/II) Write values that the user had former selected / inserted into DESCRIBE document to preselect such data in the UI. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 624 diff changeset	280 }
40d3039f85ac ISSUE-40 (part I/II) Write values that the user had former selected / inserted into DESCRIBE document to preselect such data in the UI. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 624 diff changeset	281
2189 19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	282 appendItems(artifact, creator, name, context, select);
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	283 ui.appendChild(select);
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	284 }
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	285
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	286 return ui;
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	287 }
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	288
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	289
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	290 /**
2189 19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	291 * @param artifact
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	292 * @param creator
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	293 * @param name
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	294 * @param context
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	295 * @param select
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	296 */
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	297 protected void appendItems(
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	298 Artifact artifact,
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	299 ElementCreator creator,
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	300 String name,
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	301 CallContext context,
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	302 Element select
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	303 ) {
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	304 Element choices = ProtocolUtils.createArtNode(
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	305 creator, "choices", null, null);
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	306
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	307 select.appendChild(choices);
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	308
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	309 Element[] items = createItems(creator, artifact, name, context);
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	310 if (items != null) {
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	311 for (Element item: items) {
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	312 choices.appendChild(item);
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	313 }
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	314 }
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	315 }
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	316
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	317
19518116a49a Refactored some code in DefaultState to better override the base class. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2015 diff changeset	318 /**
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	319 * This method creates the root node that contains the list of selectable
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	320 * items.
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	321 *
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	322 * @param cr The ElementCreator.
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	323 *
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	324 * @return the root node of the item list.
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	325 */
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	326 protected Element createData(
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	327 ElementCreator cr,
313 89bd0417418f The location/distance state now writes default values into DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 306 diff changeset	328 Artifact artifact,
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	329 StateData data,
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	330 CallContext context)
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	331 {
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	332 Element select = ProtocolUtils.createArtNode(
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	333 cr, "select", null, null);
129 b06cd117b565 Appended a missing node to the DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 128 diff changeset	334 cr.addAttr(select, "name", data.getName(), true);
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	335
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	336 Element label = ProtocolUtils.createArtNode(
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	337 cr, "label", null, null);
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	338
129 b06cd117b565 Appended a missing node to the DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 128 diff changeset	339 select.appendChild(label);
b06cd117b565 Appended a missing node to the DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 128 diff changeset	340
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	341 label.setTextContent(Resources.getMsg(
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	342 context.getMeta(),
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	343 getID(),
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	344 getID()));
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	345
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	346 return select;
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	347 }
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	348
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	349
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	350 /**
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	351 * This method creates a list of items. These items represent the amount of
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	352 * input data that is possible for this state.
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	353 *
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	354 * @param cr The ElementCreator.
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	355 * @param name The name of the amount of data.
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	356 *
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	357 * @return a list of items.
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	358 */
660 627be3ca1ab6 code clean up in states Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 635 diff changeset	359 protected Element[] createItems(
1159 fb5a7ff9feb8 Suppress the GeoJSON string for the FloodMap creation to be included in the static DESCRIBE part. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1136 diff changeset	360 ElementCreator cr,
313 89bd0417418f The location/distance state now writes default values into DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 306 diff changeset	361 Artifact artifact,
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	362 String name,
660 627be3ca1ab6 code clean up in states Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 635 diff changeset	363 CallContext context
627be3ca1ab6 code clean up in states Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 635 diff changeset	364 ) {
627be3ca1ab6 code clean up in states Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 635 diff changeset	365 return null;
627be3ca1ab6 code clean up in states Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 635 diff changeset	366 }
135 2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	367
2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	368
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 313 diff changeset	369 /**
1180 1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	370 * This method is used to create an <i>item</i> Element that contains two
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	371 * further elements <i>label</i> and <i>value</i>. The label and value
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	372 * elements both have text nodes.
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	373 *
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	374 * @param cr The ElementCreator used to build new Elements.
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	375 * @param obj This implementation awaits a String array with [0] = label and
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	376 * [1] = value.
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	377 *
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	378 * @return an Element.
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	379 */
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	380 protected Element createItem(XMLUtils.ElementCreator cr, Object obj) {
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	381 Element item = ProtocolUtils.createArtNode(cr, "item", null, null);
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	382 Element label = ProtocolUtils.createArtNode(cr, "label", null, null);
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	383 Element value = ProtocolUtils.createArtNode(cr, "value", null, null);
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	384
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	385 String[] arr = (String[]) obj;
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	386
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	387 label.setTextContent(arr[0]);
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	388 value.setTextContent(arr[1]);
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	389
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	390 item.appendChild(label);
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	391 item.appendChild(value);
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	392
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	393 return item;
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	394 }
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	395
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	396
1aba1a75beb2 Write the name of the selected waterlevels (used for the floodmap) into the static DESCRIBE. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1176 diff changeset	397 /**
1176 28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	398 * This method transform a given value into a StateData object.
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	399 *
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	400 * @param flys The D4EArtifact.
1176 28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	401 * @param name The name of the data object.
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	402 * @param val The value of the data object.
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	403 *
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	404 * @return a StateData object with <i>name</i> and <i>val</i>ue.
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	405 */
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	406 public StateData transform(
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	407 D4EArtifact flys,
1176 28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	408 CallContext cc,
2205 a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	409 StateData stateData,
1176 28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	410 String name,
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	411 String val
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	412 ) {
8202 e4606eae8ea5 sed src/*/.java 's/logger/log/g' Sascha L. Teichmann <teichmann@intevation.de> parents: 6052 diff changeset	413 if (log.isDebugEnabled()) {
e4606eae8ea5 sed src/*/.java 's/logger/log/g' Sascha L. Teichmann <teichmann@intevation.de> parents: 6052 diff changeset	414 log.debug("Transform data ('" + name + "','" + val + "')");
3732 fe29b0226faf More iterator code simplification. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 3414 diff changeset	415 }
2205 a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	416
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	417 stateData.setValue(val);
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	418
a22e0cb6eace Format the timerange (static ui) inserted in the 'historical discharge curves' calculation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 2189 diff changeset	419 return stateData;
1176 28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	420 }
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	421
28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	422
8636 7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	423 /** Override this to do validation.
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	424 *
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	425 * Throw an IllegalArgumentException with a localized
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	426 * error message that should be presented to the user in case
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	427 * the date provided is invalid. */
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	428 public void validate(Artifact artifact, CallContext context)
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	429 throws IllegalArgumentException {
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	430 validate(artifact); /* For compatibility so that classes that
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	431 override this method still work. */
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	432 }
1176 28154920e0b3 Introduced the possibility for States to transform/modify input before the data is added to FLYSArtifact. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1159 diff changeset	433 /**
8636 7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	434 * This method is deprecated.
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	435 * Override the function with the callcontext instead to do
7d1a32a543cb (issue1755) Extend validation to allow localized error messages. Andre Heinecke <andre.heinecke@intevation.de> parents: 8615 diff changeset	436 * localization of error.s
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 313 diff changeset	437 */
1050 eccf966fb677 State engine: Removed CallContext from state validation. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 1029 diff changeset	438 public boolean validate(Artifact artifact)
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 313 diff changeset	439 throws IllegalArgumentException
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 313 diff changeset	440 {
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 313 diff changeset	441 return true;
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 313 diff changeset	442 }
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 313 diff changeset	443
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 313 diff changeset	444
1691 17648043429f Cosmetics, docs, annotations. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1180 diff changeset	445 /**
17648043429f Cosmetics, docs, annotations. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1180 diff changeset	446 * Returns which UIProvider shall be used to aid user input.
17648043429f Cosmetics, docs, annotations. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1180 diff changeset	447 */
135 2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	448 protected String getUIProvider() {
2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	449 return null;
2d6e02787d00 Added a method to retrieve the UIProvider for a state. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 134 diff changeset	450 }
687 06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 669 diff changeset	451
1136 8da5f5a9ed3c Cosmetics, docs. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1050 diff changeset	452
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	453 public Object computeAdvance(
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	454 D4EArtifact artifact,
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	455 String hash,
742 c09c9e05ecfa Removed trailing whitespace. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 697 diff changeset	456 CallContext context,
c09c9e05ecfa Removed trailing whitespace. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 697 diff changeset	457 List<Facet> facets,
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	458 Object old
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	459 ) {
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	460 return null;
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	461 }
687 06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 669 diff changeset	462
1136 8da5f5a9ed3c Cosmetics, docs. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1050 diff changeset	463
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	464 public Object computeFeed(
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	465 D4EArtifact artifact,
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	466 String hash,
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	467 CallContext context,
742 c09c9e05ecfa Removed trailing whitespace. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 697 diff changeset	468 List<Facet> facets,
697 b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	469 Object old
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 687 diff changeset	470 ) {
687 06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 669 diff changeset	471 return null;
06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 669 diff changeset	472 }
941 1b509e4cf99b Added a computeInit() method to intialize data/facets after creating new artifacts. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 742 diff changeset	473
1136 8da5f5a9ed3c Cosmetics, docs. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1050 diff changeset	474
941 1b509e4cf99b Added a computeInit() method to intialize data/facets after creating new artifacts. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 742 diff changeset	475 public Object computeInit(
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	476 D4EArtifact artifact,
941 1b509e4cf99b Added a computeInit() method to intialize data/facets after creating new artifacts. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 742 diff changeset	477 String hash,
958 ae198bef4ba0 Added configurations for river WMSe (currently for Saar, Mosel, Elbe). Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 942 diff changeset	478 Object context,
941 1b509e4cf99b Added a computeInit() method to intialize data/facets after creating new artifacts. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 742 diff changeset	479 CallMeta meta,
1b509e4cf99b Added a computeInit() method to intialize data/facets after creating new artifacts. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 742 diff changeset	480 List<Facet> facets)
1b509e4cf99b Added a computeInit() method to intialize data/facets after creating new artifacts. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 742 diff changeset	481 {
1b509e4cf99b Added a computeInit() method to intialize data/facets after creating new artifacts. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 742 diff changeset	482 return null;
1b509e4cf99b Added a computeInit() method to intialize data/facets after creating new artifacts. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 742 diff changeset	483 }
126 b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	484 }
b18aebd1342f Added an abstract base class DefaultState for States. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	485 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :

Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/states/DefaultState.java @ 9801:1d7a72a50183 3.2.x tip