src/skrueger/AttributeMetadata.java

/*******************************************************************************
 * Copyright (c) 2009 Martin O. J. Schmitz.
 * 
 * This file is part of the SCHMITZM library - a collection of utility 
 * classes based on Java 1.6, focusing (not only) on Java Swing 
 * and the Geotools library.
 * 
 * The SCHMITZM project is hosted at:
 * http://wald.intevation.org/projects/schmitzm/
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License (license.txt)
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * or try this link: http://www.gnu.org/licenses/lgpl.html
 * 
 * Contributors:
 *     Martin O. J. Schmitz - initial API and implementation
 *     Stefan A. Krüger - additional utility classes
 ******************************************************************************/
package skrueger;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;

import org.apache.log4j.Logger;
import org.geotools.feature.NameImpl;
import org.geotools.feature.Feature.NULL;
import org.opengis.feature.type.AttributeDescriptor;
import org.opengis.feature.type.Name;

import skrueger.geotools.Copyable;
import skrueger.geotools.StyledLayerInterface;
import skrueger.i8n.I8NUtil;
import skrueger.i8n.Translation;

/**
 * This class holds meta information about an attribute/column. This information
 * is used by {@link StyledLayerInterface} and many others.<br/>
 * 
 * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
 */
public class AttributeMetadata implements Copyable<AttributeMetadata>,
                Comparable<AttributeMetadata> {
        
        static private final Logger LOGGER = Logger
                        .getLogger(AttributeMetadata.class);

        /** Translation of the attribute's description **/
        protected Translation desc = new Translation();

        /**
         * For numerical attributes the value can be transformed by VALUE*X+A when
         * presented on screen. TODO not implemented yet
         **/
        protected Double functionA = 0.;

        /**
         * For numerical attributes the value can be transformed by VALUE*X+A when
         * presented on screen. TODO not implemented yet
         **/
        protected Double functionX = 1.;

        /** The Name of the attribute **/
        private Name name;

        /**
         * Allows to define general NODATA values for an attribute. e.g. -9999 can
         * be set and will always be interpreted as NULL internally and will usually
         * be ignored. This overcomes the problem, that 
         **/
        protected final HashSet<Object> nodataValues = new HashSet<Object>();

        /** Translation of the attribute's title **/
        protected Translation title = new Translation();

        /**
         * The unit append to all visualizations of values of this attribute (is not
         * null)
         **/
        protected String unit = "";

        /** Is the attribute visible to the user or ignored where possible **/
        protected boolean visible = true;

        /**
         * When listed, the attributes are listed according to their {@link #weight} (heavier
         * => further down)
         * @see #compareTo(AttributeMetadata)
         **/
        protected int weight = 0;

        /** Only used for {@link Copyable<AttributeMetaData>#copy()} **/
        private AttributeMetadata() {
        }

        public AttributeMetadata(final AttributeDescriptor attDesc, final int weight,
                        final List<String> langs) {
                this(attDesc.getName(), langs);
                setWeight(weight);
        }

        public AttributeMetadata(final AttributeDescriptor attDesc, final List<String> langs) {
                this(attDesc.getName(), langs);
        }

        /**
         * Creates an {@link AttributeMetadata} object with the following
         * information
         * 
         * @param colIdx
         *            The column index of this attribute in the underlying
         *            table/dbf/etc...
         * @param visible
         *            Shall this attribute be displayed or hidden from the user?
         * @param title
         *            {@link Translation} for Name
         * @param desc
         *            {@link Translation} for an attribute description
         * @param unit
         *            {@link String} of the unit that the information is in
         */
        public AttributeMetadata(final Name name, final Boolean visible,
                        final Translation title, final Translation desc, final String unit) {

                this.setName(name);
                this.title = title;
                this.desc = desc;
                this.visible = visible;
                this.unit = unit;
        }
        

        /**
         * Creates an {@link AttributeMetadata} object with the following
         * information
         * 
         * @param colIdx
         *            The column index of this attribute in the underlying
         *            table/dbf/etc...
         * @param visible
         *            Shall this attribute be displayed or hidden from the user?
         * @param unit
         *            {@link String} of the unit that the information is in
         */
        public AttributeMetadata(final Name name, final Boolean visible, final String unit) {
                this.setName(name);
                this.visible = visible;
                this.unit = unit;
        }

        /**
         * Creates a new visible {@link AttributeMetadata}
         */
        public AttributeMetadata(final Name name, final List<String> langs) {
                this(name, true, new Translation(langs, name.getLocalPart()),
                                new Translation(), "");
        }

        /**
         * Creates a new visible {@link AttributeMetadata} 
         */
        public AttributeMetadata(final Name name, final String defaultTitle,
                        final List<String> langs) {
                this(name, true, new Translation(langs, defaultTitle),
                                new Translation(), "");
        }

        /**
         * Creates an {@link AttributeMetadata} object with the following
         * information
         * 
         * @param visible
         *            Shall this attribute be displayed or hidden from the user?
         * @param title
         *            {@link Translation} for Name
         * @param desc
         *            {@link Translation} for an attribute description
         * @param unit
         *            {@link String} of the unit that the information is in
         */
        public AttributeMetadata(final String localName, final Boolean visible,
                        final Translation title, final Translation desc, final String unit) {
                this(new NameImpl(localName), true, title, desc, "");
        }

        /**
         * Creates a new visible {@link AttributeMetadata} with default (no) values.
         */
        public AttributeMetadata(final String localName, final List<String> langs) {
                this(localName, true, new Translation(langs, localName),
                                new Translation(), "");
        }

        /**
         * Creates a new visible {@link AttributeMetadata} 
         */
        public AttributeMetadata(final String localName, final String defaultTitle,
                        final List<String> langs) {
                this(localName, true, new Translation(langs, defaultTitle),
                                new Translation(), "");
        }

        /**
         * Orders the attributes according to their {@link #weight}. Heavier =>
         * further down.
         */
        @Override
        public int compareTo(final AttributeMetadata atm2) {
                return new Integer(weight).compareTo(atm2.getWeight());
        }

        /**
         * @see Copyable inferface
         */
        @Override
        public AttributeMetadata copy() {
                return copyTo(new AttributeMetadata());
        }

        /**
         * @see Copyable inferface
         */
        @Override
        public AttributeMetadata copyTo(final AttributeMetadata amd) {
                getTitle().copyTo(amd.getTitle());
                getDesc().copyTo(amd.getDesc());
                amd.setUnit(getUnit());
                amd.setVisible(isVisible());
                amd.setName(new NameImpl(getName().getNamespaceURI(), getName()
                                .getLocalPart()));

                amd.setWeight(getWeight());
                amd.setFunctionX(getFunctionX());
                amd.setFunctionA(getFunctionA());

                for (final Object nodataValue : getNodataValues()) {
                        amd.getNodataValues().add(nodataValue);
                }

                return amd;
        }

        public Translation getDesc() {
                return desc;
        }

        public Double getFunctionA() {
                return functionA;
        }

        public Double getFunctionX() {
                return functionX;
        }

        /**
         * The local name. E.g. the name of the DBF column as a {@link String}
         */
        public String getLocalName() {
                return getName().getLocalPart();
        }

        /**
         * The fully qualified {@link Name} of the attribute, e.g. <code>org.bla.plo:blub</code>
         */
        public Name getName() {
                return name;
        }

        public HashSet<Object> getNodataValues() {
                return nodataValues;
        }

        /**
         * @return a number between 0 (bad) and 1 (good) that is calculated from the
         *         amount of translation available. If this attribute is not
         *         {@link #visible}, it will return 1.
         */
        public double getQuality(final List<String> languages) {

                if (!isVisible())
                        return 1.;

                return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil
                                .qmTranslation(languages, getDesc()) * 1.) / 3.;
        }

        public Translation getTitle() {
                return title;
        }

        public String getUnit() {
                return unit;
        }

        public int getWeight() {
                return weight;
        }

        /**
         * Will the end-user see this attribute?
         */
        public boolean isVisible() {
                return visible;
        }

        public void setDesc(final Translation desc) {
                this.desc = desc;
        }

        public void setFunctionA(final Double functionA) {
                this.functionA = functionA;
        }

        public void setFunctionX(final Double functionX) {
                this.functionX = functionX;
        }

        /**
         * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
         */
        public void setLocalName(final String localName) {
                this.name = new NameImpl(localName);
        }

        /**
         * The fully qualified {@link Name} of the attribute, e.g. <code>org.bla.plo:blub</code>
         */
        public void setName(final Name name) {
                this.name = name;
        }

        public void addNodataValue(Object nodataValue) {
                this.nodataValues.add(nodataValue);
        }
        
        public void removeNodataValue(Object nodataValue) {
                this.nodataValues.remove(nodataValue);
        }

        public void setTitle(final Translation title) {
                this.title = title;
        }

        public void setUnit(final String unit) {
                this.unit = unit;
        }

        public void setVisible(final boolean visible) {
                this.visible = visible;
        }

        /**
         * Shall the end-user see this attribute?
         * @param visible
         */
        public void setVisible(final Boolean visible) {
//              // The THE_GEOM and shall never be visible! 
//              if (name.getLocalPart().equalsIgnoreCase("the_geom"))
//                      this.visible = false;
//              else
//                      this.visible = visible;

                this.visible = visible;
        }

        public void setWeight(final int weight) {
                this.weight = weight;
        }
        
        /**
         * For nicer debugging
         */
        @Override
        public String toString() {
                StringBuffer sb = new StringBuffer();
                if (name != null) sb.append(name.toString()+" ");
                sb.append("weight="+weight+" ");
                sb.append("title="+getTitle().toString());
                return sb.toString();
        }

        /**
         * Takes any value object and checks it against the NODATA values. If the
         * value equals a NODATA value, <code>null</code> is returned. Otherwise the
         * same object is returned.
         * 
         * Note: This method is called often.
         */
        public Object fiterNodata(final Object value) {
                if (nodataValues.contains(value)) return null;
                return value;
        }
}
1	/*******************************************************************************
2	* Copyright (c) 2009 Martin O. J. Schmitz.
3	*
4	* This file is part of the SCHMITZM library - a collection of utility
5	* classes based on Java 1.6, focusing (not only) on Java Swing
6	* and the Geotools library.
7	*
8	* The SCHMITZM project is hosted at:
9	* http://wald.intevation.org/projects/schmitzm/
10	*
11	* This program is free software; you can redistribute it and/or
12	* modify it under the terms of the GNU Lesser General Public License
13	* as published by the Free Software Foundation; either version 3
14	* of the License, or (at your option) any later version.
15	*
16	* This program is distributed in the hope that it will be useful,
17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19	* GNU General Public License for more details.
20	*
21	* You should have received a copy of the GNU Lesser General Public License (license.txt)
22	* along with this program; if not, write to the Free Software
23	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24	* or try this link: http://www.gnu.org/licenses/lgpl.html
25	*
26	* Contributors:
27	* Martin O. J. Schmitz - initial API and implementation
28	* Stefan A. Krüger - additional utility classes
29	******************************************************************************/
30	package skrueger;
31
32	import java.util.ArrayList;
33	import java.util.HashSet;
34	import java.util.List;
35
36	import org.apache.log4j.Logger;
37	import org.geotools.feature.NameImpl;
38	import org.geotools.feature.Feature.NULL;
39	import org.opengis.feature.type.AttributeDescriptor;
40	import org.opengis.feature.type.Name;
41
42	import skrueger.geotools.Copyable;
43	import skrueger.geotools.StyledLayerInterface;
44	import skrueger.i8n.I8NUtil;
45	import skrueger.i8n.Translation;
46
47	/**
48	* This class holds meta information about an attribute/column. This information
49	* is used by {@link StyledLayerInterface} and many others.<br/>
50	*
51	* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a>
52	*/
53	public class AttributeMetadata implements Copyable<AttributeMetadata>,
54	Comparable<AttributeMetadata> {
55
56	static private final Logger LOGGER = Logger
57	.getLogger(AttributeMetadata.class);
58
59	/ Translation of the attribute's description /
60	protected Translation desc = new Translation();
61
62	/**
63	* For numerical attributes the value can be transformed by VALUE*X+A when
64	* presented on screen. TODO not implemented yet
65	**/
66	protected Double functionA = 0.;
67
68	/**
69	* For numerical attributes the value can be transformed by VALUE*X+A when
70	* presented on screen. TODO not implemented yet
71	**/
72	protected Double functionX = 1.;
73
74	/ The Name of the attribute /
75	private Name name;
76
77	/**
78	* Allows to define general NODATA values for an attribute. e.g. -9999 can
79	* be set and will always be interpreted as NULL internally and will usually
80	* be ignored. This overcomes the problem, that
81	**/
82	protected final HashSet<Object> nodataValues = new HashSet<Object>();
83
84	/ Translation of the attribute's title /
85	protected Translation title = new Translation();
86
87	/**
88	* The unit append to all visualizations of values of this attribute (is not
89	* null)
90	**/
91	protected String unit = "";
92
93	/ Is the attribute visible to the user or ignored where possible /
94	protected boolean visible = true;
95
96	/**
97	* When listed, the attributes are listed according to their {@link #weight} (heavier
98	* => further down)
99	* @see #compareTo(AttributeMetadata)
100	**/
101	protected int weight = 0;
102
103	/ Only used for {@link Copyable<AttributeMetaData>#copy()} /
104	private AttributeMetadata() {
105	}
106
107	public AttributeMetadata(final AttributeDescriptor attDesc, final int weight,
108	final List<String> langs) {
109	this(attDesc.getName(), langs);
110	setWeight(weight);
111	}
112
113	public AttributeMetadata(final AttributeDescriptor attDesc, final List<String> langs) {
114	this(attDesc.getName(), langs);
115	}
116
117	/**
118	* Creates an {@link AttributeMetadata} object with the following
119	* information
120	*
121	* @param colIdx
122	* The column index of this attribute in the underlying
123	* table/dbf/etc...
124	* @param visible
125	* Shall this attribute be displayed or hidden from the user?
126	* @param title
127	* {@link Translation} for Name
128	* @param desc
129	* {@link Translation} for an attribute description
130	* @param unit
131	* {@link String} of the unit that the information is in
132	*/
133	public AttributeMetadata(final Name name, final Boolean visible,
134	final Translation title, final Translation desc, final String unit) {
135
136	this.setName(name);
137	this.title = title;
138	this.desc = desc;
139	this.visible = visible;
140	this.unit = unit;
141	}
142
143
144	/**
145	* Creates an {@link AttributeMetadata} object with the following
146	* information
147	*
148	* @param colIdx
149	* The column index of this attribute in the underlying
150	* table/dbf/etc...
151	* @param visible
152	* Shall this attribute be displayed or hidden from the user?
153	* @param unit
154	* {@link String} of the unit that the information is in
155	*/
156	public AttributeMetadata(final Name name, final Boolean visible, final String unit) {
157	this.setName(name);
158	this.visible = visible;
159	this.unit = unit;
160	}
161
162	/**
163	* Creates a new visible {@link AttributeMetadata}
164	*/
165	public AttributeMetadata(final Name name, final List<String> langs) {
166	this(name, true, new Translation(langs, name.getLocalPart()),
167	new Translation(), "");
168	}
169
170	/**
171	* Creates a new visible {@link AttributeMetadata}
172	*/
173	public AttributeMetadata(final Name name, final String defaultTitle,
174	final List<String> langs) {
175	this(name, true, new Translation(langs, defaultTitle),
176	new Translation(), "");
177	}
178
179	/**
180	* Creates an {@link AttributeMetadata} object with the following
181	* information
182	*
183	* @param visible
184	* Shall this attribute be displayed or hidden from the user?
185	* @param title
186	* {@link Translation} for Name
187	* @param desc
188	* {@link Translation} for an attribute description
189	* @param unit
190	* {@link String} of the unit that the information is in
191	*/
192	public AttributeMetadata(final String localName, final Boolean visible,
193	final Translation title, final Translation desc, final String unit) {
194	this(new NameImpl(localName), true, title, desc, "");
195	}
196
197	/**
198	* Creates a new visible {@link AttributeMetadata} with default (no) values.
199	*/
200	public AttributeMetadata(final String localName, final List<String> langs) {
201	this(localName, true, new Translation(langs, localName),
202	new Translation(), "");
203	}
204
205	/**
206	* Creates a new visible {@link AttributeMetadata}
207	*/
208	public AttributeMetadata(final String localName, final String defaultTitle,
209	final List<String> langs) {
210	this(localName, true, new Translation(langs, defaultTitle),
211	new Translation(), "");
212	}
213
214	/**
215	* Orders the attributes according to their {@link #weight}. Heavier =>
216	* further down.
217	*/
218	@Override
219	public int compareTo(final AttributeMetadata atm2) {
220	return new Integer(weight).compareTo(atm2.getWeight());
221	}
222
223	/**
224	* @see Copyable inferface
225	*/
226	@Override
227	public AttributeMetadata copy() {
228	return copyTo(new AttributeMetadata());
229	}
230
231	/**
232	* @see Copyable inferface
233	*/
234	@Override
235	public AttributeMetadata copyTo(final AttributeMetadata amd) {
236	getTitle().copyTo(amd.getTitle());
237	getDesc().copyTo(amd.getDesc());
238	amd.setUnit(getUnit());
239	amd.setVisible(isVisible());
240	amd.setName(new NameImpl(getName().getNamespaceURI(), getName()
241	.getLocalPart()));
242
243	amd.setWeight(getWeight());
244	amd.setFunctionX(getFunctionX());
245	amd.setFunctionA(getFunctionA());
246
247	for (final Object nodataValue : getNodataValues()) {
248	amd.getNodataValues().add(nodataValue);
249	}
250
251	return amd;
252	}
253
254	public Translation getDesc() {
255	return desc;
256	}
257
258	public Double getFunctionA() {
259	return functionA;
260	}
261
262	public Double getFunctionX() {
263	return functionX;
264	}
265
266	/**
267	* The local name. E.g. the name of the DBF column as a {@link String}
268	*/
269	public String getLocalName() {
270	return getName().getLocalPart();
271	}
272
273	/**
274	* The fully qualified {@link Name} of the attribute, e.g. <code>org.bla.plo:blub</code>
275	*/
276	public Name getName() {
277	return name;
278	}
279
280	public HashSet<Object> getNodataValues() {
281	return nodataValues;
282	}
283
284	/**
285	* @return a number between 0 (bad) and 1 (good) that is calculated from the
286	* amount of translation available. If this attribute is not
287	* {@link #visible}, it will return 1.
288	*/
289	public double getQuality(final List<String> languages) {
290
291	if (!isVisible())
292	return 1.;
293
294	return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil
295	.qmTranslation(languages, getDesc()) * 1.) / 3.;
296	}
297
298	public Translation getTitle() {
299	return title;
300	}
301
302	public String getUnit() {
303	return unit;
304	}
305
306	public int getWeight() {
307	return weight;
308	}
309
310	/**
311	* Will the end-user see this attribute?
312	*/
313	public boolean isVisible() {
314	return visible;
315	}
316
317	public void setDesc(final Translation desc) {
318	this.desc = desc;
319	}
320
321	public void setFunctionA(final Double functionA) {
322	this.functionA = functionA;
323	}
324
325	public void setFunctionX(final Double functionX) {
326	this.functionX = functionX;
327	}
328
329	/**
330	* The fully qualified Name of the attribute, e.g. org.bla.plo:blub
331	*/
332	public void setLocalName(final String localName) {
333	this.name = new NameImpl(localName);
334	}
335
336	/**
337	* The fully qualified {@link Name} of the attribute, e.g. <code>org.bla.plo:blub</code>
338	*/
339	public void setName(final Name name) {
340	this.name = name;
341	}
342
343	public void addNodataValue(Object nodataValue) {
344	this.nodataValues.add(nodataValue);
345	}
346
347	public void removeNodataValue(Object nodataValue) {
348	this.nodataValues.remove(nodataValue);
349	}
350
351	public void setTitle(final Translation title) {
352	this.title = title;
353	}
354
355	public void setUnit(final String unit) {
356	this.unit = unit;
357	}
358
359	public void setVisible(final boolean visible) {
360	this.visible = visible;
361	}
362
363	/**
364	* Shall the end-user see this attribute?
365	* @param visible
366	*/
367	public void setVisible(final Boolean visible) {
368	// // The THE_GEOM and shall never be visible!
369	// if (name.getLocalPart().equalsIgnoreCase("the_geom"))
370	// this.visible = false;
371	// else
372	// this.visible = visible;
373
374	this.visible = visible;
375	}
376
377	public void setWeight(final int weight) {
378	this.weight = weight;
379	}
380
381	/**
382	* For nicer debugging
383	*/
384	@Override
385	public String toString() {
386	StringBuffer sb = new StringBuffer();
387	if (name != null) sb.append(name.toString()+" ");
388	sb.append("weight="+weight+" ");
389	sb.append("title="+getTitle().toString());
390	return sb.toString();
391	}
392
393	/**
394	* Takes any value object and checks it against the NODATA values. If the
395	* value equals a NODATA value, <code>null</code> is returned. Otherwise the
396	* same object is returned.
397	*
398	* Note: This method is called often.
399	*/
400	public Object fiterNodata(final Object value) {
401	if (nodataValues.contains(value)) return null;
402	return value;
403	}
404	}