src/skrueger/AttributeMetadataImpl.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.HashSet;
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);

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