Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/InputData.java @ 1119:7c4f81f74c47
merged gnv-artifacts
| author | Thomas Arendsen Hein <thomas@intevation.de> |
|---|---|
| date | Fri, 28 Sep 2012 12:14:00 +0200 |
| parents | f953c9a559d8 |
| children |
comparison
equal
deleted
inserted
replaced
| 1027:fca4b5eb8d2f | 1119:7c4f81f74c47 |
|---|---|
| 1 /* | |
| 2 * Copyright (c) 2010 by Intevation GmbH | |
| 3 * | |
| 4 * This program is free software under the LGPL (>=v2.1) | |
| 5 * Read the file LGPL.txt coming with the software for details | |
| 6 * or visit http://www.gnu.org/licenses/ if it does not exist. | |
| 7 */ | |
| 8 | |
| 9 package de.intevation.gnv.state; | |
| 10 | |
| 11 import java.io.Serializable; | |
| 12 | |
| 13 /** | |
| 14 * This interface defines the basic methods used to store multiple values with | |
| 15 * a specific key and name. | |
| 16 * | |
| 17 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | |
| 18 * | |
| 19 */ | |
| 20 public interface InputData extends Serializable { | |
| 21 | |
| 22 /** | |
| 23 * Method to Retrieve the name of this input data item. | |
| 24 * | |
| 25 * @return the name | |
| 26 */ | |
| 27 public String getName(); | |
| 28 | |
| 29 /** | |
| 30 * Method to retrieve the value of this input data item. A value might be a | |
| 31 * list of values separated by a specific character. | |
| 32 * | |
| 33 * @return the value | |
| 34 */ | |
| 35 public String getValue(); | |
| 36 | |
| 37 /** | |
| 38 * Method to store a further object at this input data item. | |
| 39 * | |
| 40 * @param o A further object. | |
| 41 */ | |
| 42 public void setObject(Object o); | |
| 43 | |
| 44 /** | |
| 45 * Method to retrieve the extra object. | |
| 46 * | |
| 47 * @return the extra object. | |
| 48 */ | |
| 49 public Object getObject(); | |
| 50 | |
| 51 /** | |
| 52 * Method to store descriptions for this input data item. | |
| 53 * | |
| 54 * @param description Array of descriptions. | |
| 55 */ | |
| 56 public void setDescription(String[] description); | |
| 57 | |
| 58 /** | |
| 59 * Method to retrieve a description specified by a given key. | |
| 60 * | |
| 61 * @param key Key. | |
| 62 * @return the description for this key. | |
| 63 */ | |
| 64 public String getDescription(String key); | |
| 65 | |
| 66 /** | |
| 67 * Method to retrieve all descriptions of this input data item. | |
| 68 * | |
| 69 * @return descriptions. | |
| 70 */ | |
| 71 public String[] getDescription(); | |
| 72 | |
| 73 /** | |
| 74 * Append a further string value to the value field devided by a separater | |
| 75 * character. | |
| 76 * | |
| 77 * @param value Value to append. | |
| 78 */ | |
| 79 public void concartValue(String value); | |
| 80 | |
| 81 /** | |
| 82 * Method to retrieve the character separated values split into an array. | |
| 83 * | |
| 84 * @return values as array. | |
| 85 */ | |
| 86 String[] splitValue(); | |
| 87 } | |
| 88 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 : |