src/skrueger/AttributeMetadataInterface.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.List;

import org.apache.log4j.Logger;
import org.geotools.feature.NameImpl;
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);

        // public class WeightComparator implements Comparator<AttributeDescriptor>
        // {
        //
        // @Override
        // public int compare(AttributeDescriptor o1, AttributeDescriptor o2) {
        // // TODO Auto-generated method stub
        // return 0;
        // }
        //              
        // };

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

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

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

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

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

        public int getWeight() {
                return weight;
        }

        public void setWeight(int weight) {
                this.weight = weight;
        }

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

        public void setNodataValues(List<Object> nodataValues) {
                this.nodataValues = nodataValues;
        }

        public Double getFunctionX() {
                return functionX;
        }

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

        public Double getFunctionA() {
                return functionA;
        }

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

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

        /**
         * When listed, the attributes are listed according to their weight (heavier
         * => further down)
         **/
        protected int weight = 0;

        /**
         * 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.
         **/
        protected List<Object> nodataValues = new ArrayList<Object>();

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

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

        /**
         * 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;

                // The THE_GEOM and shall never be visible!
                if (name.getLocalPart().equalsIgnoreCase("the_geom"))
                        this.visible = false;
                else
                        this.visible = visible;

                this.unit = unit;
        }

        /**
         * 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 String defaultTitle, List<String> langs) {
                this(localName, true, new Translation(langs, defaultTitle), new Translation(),
                                "");
        }

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

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

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

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

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

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

        public boolean isVisible() {
                return visible;
        }

        public void setVisible(final Boolean visible) {

                // The THE_GEOM and shall never be visible! // TODO MAKE BETTER
                if (name.getLocalPart().equalsIgnoreCase("the_geom"))
                        this.visible = false;
                else
                        this.visible = visible;
                
                this.visible = visible;
        }

        public Translation getTitle() {
                return title;
        }

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

        public Translation getDesc() {
                return desc;
        }

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

        public String getUnit() {
                return unit;
        }

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

        @Override
        public AttributeMetadata copyTo(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 (Object nodataValue : getNodataValues()) {
                        amd.getNodataValues().add(nodataValue);
                }

                return amd;
        }

        @Override
        public AttributeMetadata copy() {
                return copyTo(new AttributeMetadata());
        }

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

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

        /**
         * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
         */
        public void setName(org.opengis.feature.type.Name name) {
                this.name = name;
        }

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

        /**
         * Orders the Attributes according to their weight. Heavier => further down.
         */
        @Override
        public int compareTo(AttributeMetadata atm2) {
                // Double double1 = new Double(1./weight);
                // double double2 = 1./atm2.getWeight();
                return new Integer(weight).compareTo(atm2.getWeight());
        }

        /**
         * @return a number between 0 (bad) and 1 (good) that is calculated from the amount of translation available in the visible attributes
         */
        public double getQuality(List<String> languages) {
                return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil
                                .qmTranslation(languages, getDesc()) * 1.) / 3.;
        }
}
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.List;
34
35	import org.apache.log4j.Logger;
36	import org.geotools.feature.NameImpl;
37	import org.opengis.feature.type.AttributeDescriptor;
38	import org.opengis.feature.type.Name;
39
40	import skrueger.geotools.Copyable;
41	import skrueger.geotools.StyledLayerInterface;
42	import skrueger.i8n.I8NUtil;
43	import skrueger.i8n.Translation;
44
45	/**
46	* This class holds meta information about an attribute/column. This information
47	* is used by {@link StyledLayerInterface} and many others.<br/>
48	*
49	* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a>
50	*/
51	public class AttributeMetadata implements Copyable<AttributeMetadata>,
52	Comparable<AttributeMetadata> {
53	static private final Logger LOGGER = Logger
54	.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();
69
70	/ Translation of the attribute's description /
71	protected Translation desc = new Translation();
72
73	/ Is the attribute visible to the user or ignored where possible /
74	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 = "";
81
82	/ 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
148	* information
149	*
150	* @param colIdx
151	* The column index of this attribute in the underlying
152	* table/dbf/etc...
153	* @param visible
154	* Shall this attribute be displayed or hidden from the user?
155	* @param title
156	* {@link Translation} for Name
157	* @param desc
158	* {@link Translation} for an attribute description
159	* @param unit
160	* {@link String} of the unit that the information is in
161	*/
162	public AttributeMetadata(final Name name, final Boolean visible,
163	final Translation title, final Translation desc, final String unit) {
164
165	this.setName(name);
166	this.title = title;
167	this.desc = desc;
168
169	// The THE_GEOM and shall never be visible!
170	if (name.getLocalPart().equalsIgnoreCase("the_geom"))
171	this.visible = false;
172	else
173	this.visible = visible;
174
175	this.unit = unit;
176	}
177
178	/**
179	* Creates an {@link AttributeMetadata} object with the following
180	* information
181	*
182	* @param visible
183	* Shall this attribute be displayed or hidden from the user?
184	* @param title
185	* {@link Translation} for Name
186	* @param desc
187	* {@link Translation} for an attribute description
188	* @param unit
189	* {@link String} of the unit that the information is in
190	*/
191	public AttributeMetadata(final String localName, final Boolean visible,
192	final Translation title, final Translation desc, final String unit) {
193	this(new NameImpl(localName), true, title, desc, "");
194	}
195
196	/**
197	* Creates a new visible {@link AttributeMetadata} with default (no) values.
198	*/
199	public AttributeMetadata(final String localName, final String defaultTitle, List<String> langs) {
200	this(localName, true, new Translation(langs, defaultTitle), new Translation(),
201	"");
202	}
203
204	/**
205	* Creates a new visible {@link AttributeMetadata} with default (no) values.
206	*/
207	public AttributeMetadata(final Name name, final String defaultTitle, List<String> langs) {
208	this(name, true, new Translation(langs, defaultTitle), new Translation(), "");
209	}
210
211	/**
212	* Creates a new visible {@link AttributeMetadata} with default (no) values.
213	*/
214	public AttributeMetadata(final Name name, List<String> langs) {
215	this(name, true, new Translation(langs, name.getLocalPart()),
216	new Translation(), "");
217	}
218
219	/**
220	* Creates a new visible {@link AttributeMetadata} with default (no) values.
221	*/
222	public AttributeMetadata(final String localName, List<String> langs) {
223	this(localName, true, new Translation(langs, localName), new Translation(), "");
224	}
225
226	/ Only used for {@link Copyable<AttributeMetaData>#copy()} /
227	private AttributeMetadata() {
228	}
229
230	public AttributeMetadata(AttributeDescriptor attDesc, List<String> langs) {
231	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() {
240	return visible;
241	}
242
243	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;
252	}
253
254	public Translation getTitle() {
255	return title;
256	}
257
258	public void setTitle(final Translation title) {
259	this.title = title;
260	}
261
262	public Translation getDesc() {
263	return desc;
264	}
265
266	public void setDesc(final Translation desc) {
267	this.desc = desc;
268	}
269
270	public String getUnit() {
271	return unit;
272	}
273
274	public void setUnit(final String unit) {
275	this.unit = unit;
276	}
277
278	@Override
279	public AttributeMetadata copyTo(AttributeMetadata amd) {
280	getTitle().copyTo(amd.getTitle());
281	getDesc().copyTo(amd.getDesc());
282	amd.setUnit(getUnit());
283	amd.setVisible(isVisible());
284	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;
296	}
297
298	@Override
299	public AttributeMetadata copy() {
300	return copyTo(new AttributeMetadata());
301	}
302
303	/**
304	* The local Name. E.g. the name of the DBF column as a String
305	*/
306	public String getLocalName() {
307	return getName().getLocalPart();
308	}
309
310	/**
311	* The fully qualified Name of the attribute, e.g. org.bla.plo:blub
312	*/
313	public Name getName() {
314	return name;
315	}
316
317	/**
318	* The fully qualified Name of the attribute, e.g. org.bla.plo:blub
319	*/
320	public void setName(org.opengis.feature.type.Name name) {
321	this.name = name;
322	}
323
324	/**
325	* The fully qualified Name of the attribute, e.g. org.bla.plo:blub
326	*/
327	public void setLocalName(String localName) {
328	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	}