annotate flys-client/src/main/java/de/intevation/flys/client/shared/model/DefaultData.java @ 1442:4a6814be92ba

Cosmetics, doc. flys-client/trunk@3438 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Fri, 16 Dec 2011 13:26:19 +0000
parents f6fbfdc813f0
children d0a9acddbea2
rev   line source
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
1 package de.intevation.flys.client.shared.model;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
2
1435
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
3 import de.intevation.flys.client.shared.model.DefaultDataItem;
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
4
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
5 /**
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
6 * The default implementation of a {@link Data} item. This class just implements
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
7 * constructors to create instances and the necessary methods of the interface.
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
8 *
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
9 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
10 */
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
11 public class DefaultData implements Data {
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
12
1442
4a6814be92ba Cosmetics, doc.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 1435
diff changeset
13 /** The label of this Data object. */
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
14 protected String label;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
15
1442
4a6814be92ba Cosmetics, doc.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 1435
diff changeset
16 /** The description. */
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
17 protected String description;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
18
1442
4a6814be92ba Cosmetics, doc.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 1435
diff changeset
19 /** The type. */
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
20 protected String type;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
21
1442
4a6814be92ba Cosmetics, doc.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 1435
diff changeset
22 /** The DataItems. */
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
23 protected DataItem[] items;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
24
1442
4a6814be92ba Cosmetics, doc.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 1435
diff changeset
25 /** The default DataItem. */
514
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
26 protected DataItem defaultItem;
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
27
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
28
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
29 public DefaultData() {
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
30 }
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
31
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
32
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
33 /**
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
34 * The default constructor to create new DefaultData objects.
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
35 *
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
36 * @param label The label.
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
37 * @param description The description.
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
38 * @param type The type.
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
39 * @param items The DataItems.
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
40 */
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
41 public DefaultData(
22
a85bac235069 Implemented code to parse the UIProvider that should be used for a current state.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 12
diff changeset
42 String label,
a85bac235069 Implemented code to parse the UIProvider that should be used for a current state.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 12
diff changeset
43 String description,
a85bac235069 Implemented code to parse the UIProvider that should be used for a current state.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 12
diff changeset
44 String type,
51
a2923d63f530 Introduced a data structure DataList to manage to list of Data objects of a single state.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 49
diff changeset
45 DataItem[] items)
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
46 {
514
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
47 this(label, description, type, items, null);
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
48 }
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
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 * The constructor to create new DefaultData objects with a default value.
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
53 *
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
54 * @param label The label.
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
55 * @param description The description.
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
56 * @param type The type.
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
57 * @param items The DataItems.
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
58 * @param defaultItem The default DataItem.
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
59 */
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
60 public DefaultData(
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
61 String label,
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
62 String description,
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
63 String type,
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
64 DataItem[] items,
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
65 DataItem defaultItem)
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
66 {
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
67 this.label = label;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
68 this.description = description;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
69 this.type = type;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
70 this.items = items;
514
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
71 this.defaultItem = defaultItem;
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
72 }
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
73
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
74
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
75 public String getLabel() {
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
76 return label;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
77 }
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
78
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
79
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
80 public String getDescription() {
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
81 return description;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
82 }
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
83
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
84
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
85 public String getType() {
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
86 return type;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
87 }
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
88
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
89
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
90 public DataItem[] getItems() {
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
91 return items;
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
92 }
514
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
93
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
94
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
95 public DataItem getDefault() {
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
96 return defaultItem;
b9127f876a6a Enhanced the Data object to save default values/labels.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 51
diff changeset
97 }
1435
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
98
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
99
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
100 /** Conveniently create simplistic data. */
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
101 public static DefaultData createSimpleStringData(
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
102 String name,
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
103 String value
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
104 ) {
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
105 DefaultDataItem d = new DefaultDataItem(name, name, value);
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
106 return new DefaultData(name, null, null, new DataItem[] {d});
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
107 }
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
108
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
109 /** Conveniently create simplistic data array. */
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
110 public static Data[] createSimpleStringDataArray(
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
111 String name,
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
112 String value
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
113 ) {
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
114 DefaultDataItem d = new DefaultDataItem(name, name, value);
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
115 return new Data[]
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
116 { new DefaultData(name, null, null, new DataItem[] {d})};
f6fbfdc813f0 Allow client to access artifacts data via CollectionItems and Themes.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 514
diff changeset
117 }
12
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
118 }
fa0aad20af53 Adjusted interfaces used for the ArtifactDescription and added default implementations.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
119 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org