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.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);

        /** 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. TODO not implemented yet
         **/
        protected List<Object> nodataValues = new ArrayList<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;
//
//              // 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 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 List<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 setNodataValues(final List<Object> nodataValues) {
                this.nodataValues = nodataValues;
        }

        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();
        }
}
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	518	import java.util.ArrayList;
33			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	534	* be ignored. TODO not implemented yet
79	alfonx	518	**/
80			protected List<Object> nodataValues = new ArrayList<Object>();
81
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	534	//
138			// // The THE_GEOM and shall never be visible!
139			// if (name.getLocalPart().equalsIgnoreCase("the_geom"))
140			// this.visible = false;
141			// else
142			// this.visible = visible;
143	alfonx	472
144	alfonx	244	this.unit = unit;
145			}
146
147			/**
148	alfonx	534	* Creates a new visible {@link AttributeMetadata}
149			*/
150			public AttributeMetadata(final Name name, final List<String> langs) {
151			this(name, true, new Translation(langs, name.getLocalPart()),
152			new Translation(), "");
153			}
154
155			/**
156			* Creates a new visible {@link AttributeMetadata}
157			*/
158			public AttributeMetadata(final Name name, final String defaultTitle,
159			final List<String> langs) {
160			this(name, true, new Translation(langs, defaultTitle),
161			new Translation(), "");
162			}
163
164			/**
165	alfonx	464	* Creates an {@link AttributeMetadata} object with the following
166			* information
167			*
168			* @param visible
169			* Shall this attribute be displayed or hidden from the user?
170			* @param title
171			* {@link Translation} for Name
172			* @param desc
173			* {@link Translation} for an attribute description
174			* @param unit
175			* {@link String} of the unit that the information is in
176	alfonx	244	*/
177	alfonx	464	public AttributeMetadata(final String localName, final Boolean visible,
178			final Translation title, final Translation desc, final String unit) {
179			this(new NameImpl(localName), true, title, desc, "");
180	alfonx	244	}
181
182	alfonx	464	/**
183			* Creates a new visible {@link AttributeMetadata} with default (no) values.
184			*/
185	alfonx	534	public AttributeMetadata(final String localName, final List<String> langs) {
186			this(localName, true, new Translation(langs, localName),
187			new Translation(), "");
188	alfonx	464	}
189
190			/**
191	alfonx	534	* Creates a new visible {@link AttributeMetadata}
192	alfonx	464	*/
193	alfonx	534	public AttributeMetadata(final String localName, final String defaultTitle,
194			final List<String> langs) {
195			this(localName, true, new Translation(langs, defaultTitle),
196			new Translation(), "");
197	alfonx	464	}
198
199			/**
200	alfonx	534	* Orders the attributes according to their {@link #weight}. Heavier =>
201			* further down.
202	alfonx	464	*/
203	alfonx	534	@Override
204			public int compareTo(final AttributeMetadata atm2) {
205			return new Integer(weight).compareTo(atm2.getWeight());
206	alfonx	464	}
207
208			/**
209	alfonx	534	* @see Copyable inferface
210	alfonx	464	*/
211	alfonx	534	@Override
212			public AttributeMetadata copy() {
213			return copyTo(new AttributeMetadata());
214	alfonx	464	}
215
216	alfonx	534	/**
217			* @see Copyable inferface
218			*/
219			@Override
220			public AttributeMetadata copyTo(final AttributeMetadata amd) {
221			getTitle().copyTo(amd.getTitle());
222			getDesc().copyTo(amd.getDesc());
223			amd.setUnit(getUnit());
224			amd.setVisible(isVisible());
225			amd.setName(new NameImpl(getName().getNamespaceURI(), getName()
226			.getLocalPart()));
227
228			amd.setWeight(getWeight());
229			amd.setFunctionX(getFunctionX());
230			amd.setFunctionA(getFunctionA());
231
232			for (final Object nodataValue : getNodataValues()) {
233			amd.getNodataValues().add(nodataValue);
234			}
235
236			return amd;
237	alfonx	420	}
238
239	alfonx	534	public Translation getDesc() {
240			return desc;
241	alfonx	464	}
242
243	alfonx	534	public Double getFunctionA() {
244			return functionA;
245	alfonx	523	}
246
247	alfonx	534	public Double getFunctionX() {
248			return functionX;
249	alfonx	244	}
250
251	alfonx	534	/**
252			* The local name. E.g. the name of the DBF column as a {@link String}
253			*/
254			public String getLocalName() {
255			return getName().getLocalPart();
256	alfonx	244	}
257
258	alfonx	534	/**
259			* The fully qualified {@link Name} of the attribute, e.g. <code>org.bla.plo:blub</code>
260			*/
261			public Name getName() {
262			return name;
263	alfonx	244	}
264
265	alfonx	534	public List<Object> getNodataValues() {
266			return nodataValues;
267	alfonx	244	}
268
269	alfonx	534	/**
270			* @return a number between 0 (bad) and 1 (good) that is calculated from the
271			* amount of translation available. If this attribute is not
272			* {@link #visible}, it will return 1.
273			*/
274			public double getQuality(final List<String> languages) {
275
276			if (!isVisible())
277			return 1.;
278
279			return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil
280			.qmTranslation(languages, getDesc()) * 1.) / 3.;
281	alfonx	244	}
282
283	alfonx	534	public Translation getTitle() {
284			return title;
285	alfonx	244	}
286
287			public String getUnit() {
288			return unit;
289			}
290
291	alfonx	534	public int getWeight() {
292			return weight;
293	alfonx	244	}
294	alfonx	420
295	alfonx	534	/**
296			* Will the end-user see this attribute?
297			*/
298			public boolean isVisible() {
299			return visible;
300			}
301	alfonx	464
302	alfonx	534	public void setDesc(final Translation desc) {
303			this.desc = desc;
304	alfonx	420	}
305
306	alfonx	534	public void setFunctionA(final Double functionA) {
307			this.functionA = functionA;
308	alfonx	420	}
309
310	alfonx	534	public void setFunctionX(final Double functionX) {
311			this.functionX = functionX;
312	alfonx	420	}
313	alfonx	464
314			/**
315			* The fully qualified Name of the attribute, e.g. org.bla.plo:blub
316			*/
317	alfonx	534	public void setLocalName(final String localName) {
318			this.name = new NameImpl(localName);
319	alfonx	464	}
320
321			/**
322	alfonx	534	* The fully qualified {@link Name} of the attribute, e.g. <code>org.bla.plo:blub</code>
323	alfonx	464	*/
324	alfonx	534	public void setName(final Name name) {
325	alfonx	464	this.name = name;
326			}
327
328	alfonx	534	public void setNodataValues(final List<Object> nodataValues) {
329			this.nodataValues = nodataValues;
330	alfonx	464	}
331	alfonx	518
332	alfonx	534	public void setTitle(final Translation title) {
333			this.title = title;
334			}
335
336			public void setUnit(final String unit) {
337			this.unit = unit;
338			}
339
340			public void setVisible(final boolean visible) {
341			this.visible = visible;
342			}
343
344	alfonx	518	/**
345	alfonx	534	* Shall the end-user see this attribute?
346			* @param visible
347	alfonx	518	*/
348	alfonx	534	public void setVisible(final Boolean visible) {
349			// // The THE_GEOM and shall never be visible!
350			// if (name.getLocalPart().equalsIgnoreCase("the_geom"))
351			// this.visible = false;
352			// else
353			// this.visible = visible;
354
355			this.visible = visible;
356	alfonx	518	}
357
358	alfonx	534	public void setWeight(final int weight) {
359			this.weight = weight;
360			}
361
362	alfonx	518	/**
363	alfonx	534	* For nicer debugging
364	alfonx	518	*/
365	alfonx	534	@Override
366			public String toString() {
367			StringBuffer sb = new StringBuffer();
368			if (name != null) sb.append(name.toString()+" ");
369			sb.append("weight="+weight+" ");
370			sb.append("title="+getTitle().toString());
371			return sb.toString();
372	alfonx	518	}
373	alfonx	244	}