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

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/states/RangeState.java @ 6693:88bb0c794833

issue1391: Enable GaugeDischarge artifact to directly load a table by its ID This allows us to use the GaugeDischargeArtifact for any discharge tables that we have in our database. The name of the created facet is taken from the ids string as is also usual in the WMS artifacts.

author	Andre Heinecke <aheinecke@intevation.de>
date	Mon, 29 Jul 2013 12:19:57 +0200
parents	a0078e5e3b39
children	e4606eae8ea5

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: 5867 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: 5867 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: 4949 diff changeset	9 package org.dive4elements.river.artifacts.states;
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	10
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4949 diff changeset	11 import org.dive4elements.artifacts.Artifact;
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	12
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	13 import org.dive4elements.river.artifacts.D4EArtifact;
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	14
5831 bd047b71ab37 Repaired internal references Sascha L. Teichmann <teichmann@intevation.de> parents: 4949 diff changeset	15 import org.dive4elements.river.artifacts.access.RangeAccess;
4949 53be73133104 Removed obsolete imports. Sascha L. Teichmann <teichmann@intevation.de> parents: 4865 diff changeset	16
53be73133104 Removed obsolete imports. Sascha L. Teichmann <teichmann@intevation.de> parents: 4865 diff changeset	17 import org.apache.log4j.Logger;
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	18
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	19
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	20 /**
4865 1358d0c8481c RangeState and descendants: Use RangeAccess, resolve direct ld_* usage. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1685 diff changeset	21 * State in which km range is set.
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	22 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	23 */
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	24 public abstract class RangeState extends DefaultState {
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	25
1685 022f62c75878 Cosmetics. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1630 diff changeset	26 /** The logger that is used in this class. */
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	27 private Logger logger = Logger.getLogger(RangeState.class);
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	28
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	29
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	30 public RangeState() {
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	31 }
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	32
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	33 protected abstract double[] getMinMax(Artifact artifact);
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	34
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	35
1630 cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	36 protected boolean validateBounds(
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	37 double fromValid, double toValid,
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	38 double from, double to)
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	39 throws IllegalArgumentException
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	40 {
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	41 if (from < fromValid) {
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	42 logger.error(
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	43 "Invalid 'from'. " + from + " is smaller than " + fromValid);
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	44 throw new IllegalArgumentException("error_feed_from_out_of_range");
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	45 }
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	46 else if (to > toValid) {
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	47 logger.error(
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	48 "Invalid 'to'. " + to + " is bigger than " + toValid);
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	49 throw new IllegalArgumentException("error_feed_to_out_of_range");
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	50 }
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	51
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	52 return true;
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	53 }
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	54
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	55
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	56 /**
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	57 * Validates a given range with a given valid range.
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	58 *
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	59 * @param fromValid Valid lower value of the range.
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	60 * @param toValid Valid upper value of the range.
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	61 * @param from The lower value.
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	62 * @param to The upper value.
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	63 * @param step The step width.
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	64 *
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	65 * @return true, if everything was fine, otherwise an exception is thrown.
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	66 */
379 c21fb8de54f8 Enabled the FLYSArtifact to handle an array of inserted WQ values (without given ranges). Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 322 diff changeset	67 protected boolean validateBounds(
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	68 double fromValid, double toValid,
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	69 double from, double to, double step)
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	70 throws IllegalArgumentException
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	71 {
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	72 logger.debug("RangeState.validateRange");
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	73
1630 cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	74 // XXX The step width is not validated at the moment!
cafd8af6734a Improved bounds validation for distance only states. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 1051 diff changeset	75 return validateBounds(fromValid, toValid, from, to);
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	76 }
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	77
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	78
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	79 @Override
1050 eccf966fb677 State engine: Removed CallContext from state validation. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 921 diff changeset	80 public boolean validate(Artifact artifact)
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	81 throws IllegalArgumentException
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	82 {
5867 59ff03ff48f1 River artifacts: Renamed FLYSArtifact(Collection) to D4EArtifact(Collection). Sascha L. Teichmann <teichmann@intevation.de> parents: 5863 diff changeset	83 D4EArtifact flys = (D4EArtifact) artifact;
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	84
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	85 try {
6101 a0078e5e3b39 Removed unused context from RangeAccess and subclasses leading to some dead code removal. Sascha L. Teichmann <teichmann@intevation.de> parents: 5994 diff changeset	86 RangeAccess rangeAccess = new RangeAccess(flys);
4865 1358d0c8481c RangeState and descendants: Use RangeAccess, resolve direct ld_* usage. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1685 diff changeset	87 double from = rangeAccess.getFrom();
1358d0c8481c RangeState and descendants: Use RangeAccess, resolve direct ld_* usage. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1685 diff changeset	88 double to = rangeAccess.getTo();
1358d0c8481c RangeState and descendants: Use RangeAccess, resolve direct ld_* usage. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1685 diff changeset	89 double step = rangeAccess.getStep();
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	90
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	91 double[] minmax = getMinMax(flys);
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	92
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	93 return validateBounds(minmax[0], minmax[1], from, to, step);
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	94 }
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	95 catch (NumberFormatException nfe) {
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	96 throw new IllegalArgumentException("error_invalid_double_value");
610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	97 }
4865 1358d0c8481c RangeState and descendants: Use RangeAccess, resolve direct ld_* usage. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1685 diff changeset	98 catch (NullPointerException npe) {
1358d0c8481c RangeState and descendants: Use RangeAccess, resolve direct ld_* usage. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1685 diff changeset	99 throw new IllegalArgumentException("error_empty_state");
1358d0c8481c RangeState and descendants: Use RangeAccess, resolve direct ld_* usage. Felix Wolfsteller <felix.wolfsteller@intevation.de> parents: 1685 diff changeset	100 }
921 610d0e0f4f85 #159 Modifications in the transition model to support a state with a kilometer range input only. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 635 diff changeset	101 }
322 448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	102 }
448d0dc64357 The inserted ranges (distance and WQ ranges) are validated in the feed() operation. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: diff changeset	103 // 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/RangeState.java @ 6693:88bb0c794833