Mercurial > dive4elements > river

annotate flys-client/src/main/java/org/dive4elements/river/client/shared/model/Data.java @ 5835:821a02bbfb4e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed internal java dependencies
author Sascha L. Teichmann <teichmann@intevation.de>
date Thu, 25 Apr 2013 13:12:15 +0200
parents f507086aa94b
children
rev   line source
5835
821a02bbfb4e Fixed internal java dependencies
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5834
diff changeset
1 package org.dive4elements.river.client.shared.model;
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
2
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 8
diff changeset
3 import java.io.Serializable;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 8
diff changeset
4
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
5
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
6 /**
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
7 * A Data object represents the necessary data of a single state of the
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
8 * artifact. It might provide several DataItems or just a single DataItem. The
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
9 * <code>type</code> makes it possible to validate the input in the client.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
10 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
11 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
12 */
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 8
diff changeset
13 public interface Data extends Serializable {
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
14
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
15 /**
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
16 * Returns the label of the item.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
17 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
18 * @return the label.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
19 */
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
20 public String getLabel();
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
21
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
22
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
23 /**
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
24 * Returns the description of the item.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
25 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
26 * @return the description.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
27 */
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
28 public String getDescription();
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
29
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
30
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
31 /**
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
32 * Returns the type of the item.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
33 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
34 * @return the type.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
35 */
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
36 public String getType();
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
37
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
38
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
39 /**
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
40 * Returns the DataItems provided by this Data object.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
41 *
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
42 * @return the DataItems.
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
43 */
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
44 public DataItem[] getItems();
514
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
45
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
46
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
47 /**
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
48 * Returns the default value of this data object.
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
49 *
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
50 * @return the default value.
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
51 */
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
52 public DataItem getDefault();
2535
d0a9acddbea2 Added an int data item used in int array data and added getter that returns
Raimund Renkert <raimund.renkert@intevation.de>
parents: 514
diff changeset
53
d0a9acddbea2 Added an int data item used in int array data and added getter that returns
Raimund Renkert <raimund.renkert@intevation.de>
parents: 514
diff changeset
54
d0a9acddbea2 Added an int data item used in int array data and added getter that returns
Raimund Renkert <raimund.renkert@intevation.de>
parents: 514
diff changeset
55 /**
d0a9acddbea2 Added an int data item used in int array data and added getter that returns
Raimund Renkert <raimund.renkert@intevation.de>
parents: 514
diff changeset
56 * Returns the values as colon separated string.
d0a9acddbea2 Added an int data item used in int array data and added getter that returns
Raimund Renkert <raimund.renkert@intevation.de>
parents: 514
diff changeset
57 *
d0a9acddbea2 Added an int data item used in int array data and added getter that returns
Raimund Renkert <raimund.renkert@intevation.de>
parents: 514
diff changeset
58 * @return colon separated string.
d0a9acddbea2 Added an int data item used in int array data and added getter that returns
Raimund Renkert <raimund.renkert@intevation.de>
parents: 514
diff changeset
59 */
d0a9acddbea2 Added an int data item used in int array data and added getter that returns
Raimund Renkert <raimund.renkert@intevation.de>
parents: 514
diff changeset
60 public String getStringValue();
8
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
61 }
9cb3ee7ed8ba Added interfaces for Artifacts, its ArtifactDescription and Data.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
62 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
http://dive4elements.wald.intevation.org