29 |
******************************************************************************/ |
******************************************************************************/ |
30 |
package skrueger; |
package skrueger; |
31 |
|
|
32 |
|
import java.util.ArrayList; |
33 |
|
import java.util.List; |
34 |
|
|
35 |
import org.apache.log4j.Logger; |
import org.apache.log4j.Logger; |
36 |
import org.geotools.feature.NameImpl; |
import org.geotools.feature.NameImpl; |
37 |
import org.opengis.feature.type.AttributeDescriptor; |
import org.opengis.feature.type.AttributeDescriptor; |
39 |
|
|
40 |
import skrueger.geotools.Copyable; |
import skrueger.geotools.Copyable; |
41 |
import skrueger.geotools.StyledLayerInterface; |
import skrueger.geotools.StyledLayerInterface; |
42 |
|
import skrueger.i8n.I8NUtil; |
43 |
import skrueger.i8n.Translation; |
import skrueger.i8n.Translation; |
44 |
|
|
45 |
/** |
/** |
46 |
* This class holds meta information about an attribute/column. This information |
* This class holds meta information about an attribute/column. This information |
47 |
* is used by {@link StyledLayerInterface}. |
* is used by {@link StyledLayerInterface} and many others.<br/> |
48 |
* |
* |
49 |
* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a> |
* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a> |
50 |
*/ |
*/ |
51 |
public class AttributeMetadata implements Copyable<AttributeMetadata> { |
public class AttributeMetadata implements Copyable<AttributeMetadata>, |
52 |
|
Comparable<AttributeMetadata> { |
53 |
static private final Logger LOGGER = Logger |
static private final Logger LOGGER = Logger |
54 |
.getLogger(AttributeMetadata.class); |
.getLogger(AttributeMetadata.class); |
55 |
|
|
56 |
|
// public class WeightComparator implements Comparator<AttributeDescriptor> |
57 |
|
// { |
58 |
|
// |
59 |
|
// @Override |
60 |
|
// public int compare(AttributeDescriptor o1, AttributeDescriptor o2) { |
61 |
|
// // TODO Auto-generated method stub |
62 |
|
// return 0; |
63 |
|
// } |
64 |
|
// |
65 |
|
// }; |
66 |
|
|
67 |
|
/** Translation of the attribute's title **/ |
68 |
protected Translation title = new Translation(); |
protected Translation title = new Translation(); |
69 |
|
|
70 |
|
/** Translation of the attribute's description **/ |
71 |
protected Translation desc = new Translation(); |
protected Translation desc = new Translation(); |
72 |
|
|
73 |
|
/** Is the attribute visible to the user or ignored where possible **/ |
74 |
protected boolean visible = true; |
protected boolean visible = true; |
75 |
|
|
76 |
|
/** |
77 |
|
* The unit append to all visualizations of values of this attribute (is not |
78 |
|
* null) |
79 |
|
**/ |
80 |
protected String unit = ""; |
protected String unit = ""; |
81 |
protected int colIdx; |
|
82 |
private org.opengis.feature.type.Name name; |
/** The Name of the attribute **/ |
83 |
|
private Name name; |
84 |
|
|
85 |
|
public int getWeight() { |
86 |
|
return weight; |
87 |
|
} |
88 |
|
|
89 |
|
public void setWeight(int weight) { |
90 |
|
this.weight = weight; |
91 |
|
} |
92 |
|
|
93 |
|
public List<Object> getNodataValues() { |
94 |
|
return nodataValues; |
95 |
|
} |
96 |
|
|
97 |
|
public void setNodataValues(List<Object> nodataValues) { |
98 |
|
this.nodataValues = nodataValues; |
99 |
|
} |
100 |
|
|
101 |
|
public Double getFunctionX() { |
102 |
|
return functionX; |
103 |
|
} |
104 |
|
|
105 |
|
public void setFunctionX(Double functionX) { |
106 |
|
this.functionX = functionX; |
107 |
|
} |
108 |
|
|
109 |
|
public Double getFunctionA() { |
110 |
|
return functionA; |
111 |
|
} |
112 |
|
|
113 |
|
public void setFunctionA(Double functionA) { |
114 |
|
this.functionA = functionA; |
115 |
|
} |
116 |
|
|
117 |
|
public void setVisible(boolean visible) { |
118 |
|
this.visible = visible; |
119 |
|
} |
120 |
|
|
121 |
|
/** |
122 |
|
* When listed, the attributes are listed according to their weight (heavier |
123 |
|
* => further down) |
124 |
|
**/ |
125 |
|
protected int weight = 0; |
126 |
|
|
127 |
|
/** |
128 |
|
* Allows to define general NODATA values for an attribute. e.g. -9999 can |
129 |
|
* be set and will always be interpreted as NULL internally and will usually |
130 |
|
* be ignored. |
131 |
|
**/ |
132 |
|
protected List<Object> nodataValues = new ArrayList<Object>(); |
133 |
|
|
134 |
|
/** |
135 |
|
* For numerical attributes the value can be transformed by VALUE*X+A when |
136 |
|
* presented on screen |
137 |
|
**/ |
138 |
|
protected Double functionX = 1.; |
139 |
|
|
140 |
|
/** |
141 |
|
* For numerical attributes the value can be transformed by VALUE*X+A when |
142 |
|
* presented on screen |
143 |
|
**/ |
144 |
|
protected Double functionA = 0.; |
145 |
|
|
146 |
/** |
/** |
147 |
* Creates an {@link AttributeMetadata} object with the following |
* Creates an {@link AttributeMetadata} object with the following |
165 |
this.setName(name); |
this.setName(name); |
166 |
this.title = title; |
this.title = title; |
167 |
this.desc = desc; |
this.desc = desc; |
168 |
|
|
169 |
// The THE_GEOM and shall never be visible! |
// The THE_GEOM and shall never be visible! |
170 |
if (name.getLocalPart().equalsIgnoreCase("the_geom")) this.visible = false; |
if (name.getLocalPart().equalsIgnoreCase("the_geom")) |
171 |
|
this.visible = false; |
172 |
|
else |
173 |
|
this.visible = visible; |
174 |
|
|
175 |
this.unit = unit; |
this.unit = unit; |
176 |
} |
} |
177 |
|
|
196 |
/** |
/** |
197 |
* Creates a new visible {@link AttributeMetadata} with default (no) values. |
* Creates a new visible {@link AttributeMetadata} with default (no) values. |
198 |
*/ |
*/ |
199 |
public AttributeMetadata(final String localName, final String defaultTitle) { |
public AttributeMetadata(final String localName, final String defaultTitle, List<String> langs) { |
200 |
this(localName, true, new Translation(defaultTitle), new Translation(), |
this(localName, true, new Translation(langs, defaultTitle), new Translation(), |
201 |
""); |
""); |
202 |
} |
} |
203 |
|
|
204 |
/** |
/** |
205 |
* Creates a new visible {@link AttributeMetadata} with default (no) values. |
* Creates a new visible {@link AttributeMetadata} with default (no) values. |
206 |
*/ |
*/ |
207 |
public AttributeMetadata(final Name name, final String defaultTitle) { |
public AttributeMetadata(final Name name, final String defaultTitle, List<String> langs) { |
208 |
this(name, true, new Translation(defaultTitle), new Translation(), ""); |
this(name, true, new Translation(langs, defaultTitle), new Translation(), ""); |
209 |
} |
} |
210 |
|
|
211 |
/** |
/** |
212 |
* Creates a new visible {@link AttributeMetadata} with default (no) values. |
* Creates a new visible {@link AttributeMetadata} with default (no) values. |
213 |
*/ |
*/ |
214 |
public AttributeMetadata(final Name name) { |
public AttributeMetadata(final Name name, List<String> langs) { |
215 |
this(name, true, new Translation(name.getLocalPart()), |
this(name, true, new Translation(langs, name.getLocalPart()), |
216 |
new Translation(), ""); |
new Translation(), ""); |
217 |
} |
} |
218 |
|
|
219 |
/** |
/** |
220 |
* Creates a new visible {@link AttributeMetadata} with default (no) values. |
* Creates a new visible {@link AttributeMetadata} with default (no) values. |
221 |
*/ |
*/ |
222 |
public AttributeMetadata(final String localName) { |
public AttributeMetadata(final String localName, List<String> langs) { |
223 |
this(localName, true, new Translation(localName), new Translation(), ""); |
this(localName, true, new Translation(langs, localName), new Translation(), ""); |
224 |
} |
} |
225 |
|
|
226 |
/** Only used for {@link Copyable<AttributeMetaData>#copy()} **/ |
/** Only used for {@link Copyable<AttributeMetaData>#copy()} **/ |
227 |
private AttributeMetadata() { |
private AttributeMetadata() { |
228 |
} |
} |
229 |
|
|
230 |
public AttributeMetadata(AttributeDescriptor attDesc) { |
public AttributeMetadata(AttributeDescriptor attDesc, List<String> langs) { |
231 |
this(attDesc.getName()); |
this(attDesc.getName(), langs); |
232 |
|
} |
233 |
|
|
234 |
|
public AttributeMetadata(AttributeDescriptor attDesc, int weight, List<String> langs) { |
235 |
|
this(attDesc.getName(), langs); |
236 |
|
setWeight(weight); |
237 |
} |
} |
238 |
|
|
239 |
public boolean isVisible() { |
public boolean isVisible() { |
241 |
} |
} |
242 |
|
|
243 |
public void setVisible(final Boolean visible) { |
public void setVisible(final Boolean visible) { |
244 |
|
|
245 |
|
// The THE_GEOM and shall never be visible! // TODO MAKE BETTER |
246 |
|
if (name.getLocalPart().equalsIgnoreCase("the_geom")) |
247 |
|
this.visible = false; |
248 |
|
else |
249 |
|
this.visible = visible; |
250 |
|
|
251 |
this.visible = visible; |
this.visible = visible; |
252 |
} |
} |
|
// |
|
|
// /** @return the index of this attribute in the underlying table/dbf **/ |
|
|
// public int getColIdx() { |
|
|
// return colIdx; |
|
|
// } |
|
253 |
|
|
254 |
public Translation getTitle() { |
public Translation getTitle() { |
255 |
return title; |
return title; |
281 |
getDesc().copyTo(amd.getDesc()); |
getDesc().copyTo(amd.getDesc()); |
282 |
amd.setUnit(getUnit()); |
amd.setUnit(getUnit()); |
283 |
amd.setVisible(isVisible()); |
amd.setVisible(isVisible()); |
284 |
amd.setName(new NameImpl(getName().getNamespaceURI(), getName().getLocalPart())); |
amd.setName(new NameImpl(getName().getNamespaceURI(), getName() |
285 |
|
.getLocalPart())); |
286 |
|
|
287 |
|
amd.setWeight(getWeight()); |
288 |
|
amd.setFunctionX(getFunctionX()); |
289 |
|
amd.setFunctionA(getFunctionA()); |
290 |
|
|
291 |
|
for (Object nodataValue : getNodataValues()) { |
292 |
|
amd.getNodataValues().add(nodataValue); |
293 |
|
} |
294 |
|
|
295 |
return amd; |
return amd; |
296 |
} |
} |
297 |
|
|
298 |
@Override |
@Override |
299 |
public AttributeMetadata copy() { |
public AttributeMetadata copy() { |
300 |
return copyTo( new AttributeMetadata()); |
return copyTo(new AttributeMetadata()); |
301 |
} |
} |
302 |
|
|
303 |
/** |
/** |
327 |
public void setLocalName(String localName) { |
public void setLocalName(String localName) { |
328 |
this.name = new NameImpl(localName); |
this.name = new NameImpl(localName); |
329 |
} |
} |
330 |
|
|
331 |
|
/** |
332 |
|
* Orders the Attributes according to their weight. Heavier => further down. |
333 |
|
*/ |
334 |
|
@Override |
335 |
|
public int compareTo(AttributeMetadata atm2) { |
336 |
|
// Double double1 = new Double(1./weight); |
337 |
|
// double double2 = 1./atm2.getWeight(); |
338 |
|
return new Integer(weight).compareTo(atm2.getWeight()); |
339 |
|
} |
340 |
|
|
341 |
|
/** |
342 |
|
* @return a number between 0 (bad) and 1 (good) that is calculated from the amount of translation available in the visible attributes |
343 |
|
*/ |
344 |
|
public double getQuality(List<String> languages) { |
345 |
|
return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil |
346 |
|
.qmTranslation(languages, getDesc()) * 1.) / 3.; |
347 |
|
} |
348 |
} |
} |