comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/ExtendedInputData.java @ 796:a5526908f92f

Added javadoc in state package. gnv-artifacts/trunk@878 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 01 Apr 2010 09:15:36 +0000
parents c907636c0288
children feae2f9d6c6f
comparison
equal deleted inserted replaced
795:cdade5005cba 796:a5526908f92f
1 package de.intevation.gnv.state; 1 package de.intevation.gnv.state;
2 2
3 /** 3 /**
4 * This class is used to save the relation between two attributes. Mainly used
5 * to save the relation between a measurement and the parameter it belongs to.
6 *
7 * @see MeasurementState
4 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> 8 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
5 */ 9 */
6 public class ExtendedInputData extends DefaultInputData { 10 public class ExtendedInputData extends DefaultInputData {
7 11
12 /**
13 * The separater used to separate measurement ids and parameter ids.
14 */
8 public static final String SEPARATOR = ";"; 15 public static final String SEPARATOR = ";";
9 16
17 /**
18 * The parameter this object belongs to.
19 */
10 protected String parameterid; 20 protected String parameterid;
11 21
22 /**
23 * Constructcor.
24 *
25 * @param name
26 * @param value
27 * @param object
28 * @param parameterid
29 */
12 public ExtendedInputData( 30 public ExtendedInputData(
13 String name, 31 String name,
14 String value, 32 String value,
15 Object object, 33 Object object,
16 String parameterid) 34 String parameterid)
17 { 35 {
18 super(name, value, object); 36 super(name, value, object);
19 this.parameterid = parameterid; 37 this.parameterid = parameterid;
20 } 38 }
21 39
40 /**
41 * Return the parameter ids this object belongs to.
42 *
43 * @return the parameter id.
44 */
22 public String getParameterID() { 45 public String getParameterID() {
23 return parameterid; 46 return parameterid;
24 } 47 }
25 48
49 /**
50 * Set the parameter ids.
51 *
52 * @param parameterid Parameter ids.
53 */
26 public void setParameter(String parameterid) { 54 public void setParameter(String parameterid) {
27 this.parameterid = parameterid; 55 this.parameterid = parameterid;
28 } 56 }
29 57
58 /**
59 * Return all parameter ids as array.
60 *
61 * @return Array of parameter ids.
62 */
30 public String[] splitParameter() { 63 public String[] splitParameter() {
31 if (parameterid != null) 64 if (parameterid != null)
32 return parameterid.split(SEPARATOR); 65 return parameterid.split(SEPARATOR);
33 66
34 return null; 67 return null;

http://dive4elements.wald.intevation.org