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 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 AttributeMetadataImpl extends AbstractAttributeMetadata implements
                QualityQuantizable {

        static private final Logger LOGGER = Logger
                        .getLogger(AttributeMetadataImpl.class);

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

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

        public AttributeMetadataImpl(final AttributeDescriptor attDesc,
                        final int weight, final List<String> langs) {
                this( new NameImpl(attDesc.getName().getNamespaceURI(), attDesc.getName().getLocalPart()), langs);
                setWeight(weight);
        }

        public AttributeMetadataImpl(final AttributeDescriptor attDesc,
                        final List<String> langs) {
                this(new NameImpl(attDesc.getName().getNamespaceURI(), attDesc.getName().getLocalPart()), langs);
        }

        /**
         * Creates an {@link AttributeMetadataImpl} 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 AttributeMetadataImpl(final NameImpl 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 AttributeMetadataImpl} 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 AttributeMetadataImpl(final NameImpl name, final Boolean visible,
                        final String unit) {
                this.setName(name);
                this.visible = visible;
                this.unit = unit;
        }

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

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

        /**
         * Creates an {@link AttributeMetadataImpl} 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 AttributeMetadataImpl(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 AttributeMetadataImpl} with default (no)
         * values.
         */
        public AttributeMetadataImpl(final String localName,
                        final List<String> langs) {
                this(localName, true, new Translation(langs, localName),
                                new Translation(), "");
        }

        /**
         * Creates a new visible {@link AttributeMetadataImpl}
         */
        public AttributeMetadataImpl(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 AttributeMetadataInterface atm2) {
                return new Integer(weight).compareTo(new Double(atm2.getWeight())
                                .intValue());
        }

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

        /**
         * @see Copyable inferface
         */
        @Override
        public AttributeMetadataInterface copyTo(final AttributeMetadataInterface 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());

                if (amd instanceof AttributeMetadataImpl) {
                        AttributeMetadataImpl amd_ = (AttributeMetadataImpl) amd;

                        amd_.setFunctionX(getFunctionX());
                        amd_.setFunctionA(getFunctionA());
                        amd_.setNodataValues(getNodataValues());
                }

                return amd;
        }

        // only to be used by copyTo()
        private void setNodataValues(HashSet<Object> nodataValues_) {
                nodataValues = nodataValues_;
        }

        public Double getFunctionA() {
                return functionA;
        }

        public Double getFunctionX() {
                return functionX;
        }

        /**
         * @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.
         */
        @Override
        public double getQuality(final List<String> languages) {

                if (!isVisible())
                        return 1.;

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

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

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


}
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.HashSet;
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
39	import skrueger.geotools.Copyable;
40	import skrueger.geotools.StyledLayerInterface;
41	import skrueger.i8n.I8NUtil;
42	import skrueger.i8n.Translation;
43
44	/**
45	* This class holds meta information about an attribute/column. This information
46	* is used by {@link StyledLayerInterface} and many others.<br/>
47	*
48	* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a>
49	*/
50	public class AttributeMetadataImpl extends AbstractAttributeMetadata implements
51	QualityQuantizable {
52
53	static private final Logger LOGGER = Logger
54	.getLogger(AttributeMetadataImpl.class);
55
56	/**
57	* For numerical attributes the value can be transformed by VALUE*X+A when
58	* presented on screen. TODO not implemented yet
59	**/
60	protected Double functionA = 0.;
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 functionX = 1.;
67
68	/ Only used for {@link Copyable<AttributeMetaData>#copy()} /
69	private AttributeMetadataImpl() {
70	}
71
72	public AttributeMetadataImpl(final AttributeDescriptor attDesc,
73	final int weight, final List<String> langs) {
74	this( new NameImpl(attDesc.getName().getNamespaceURI(), attDesc.getName().getLocalPart()), langs);
75	setWeight(weight);
76	}
77
78	public AttributeMetadataImpl(final AttributeDescriptor attDesc,
79	final List<String> langs) {
80	this(new NameImpl(attDesc.getName().getNamespaceURI(), attDesc.getName().getLocalPart()), langs);
81	}
82
83	/**
84	* Creates an {@link AttributeMetadataImpl} object with the following
85	* information
86	*
87	* @param colIdx
88	* The column index of this attribute in the underlying
89	* table/dbf/etc...
90	* @param visible
91	* Shall this attribute be displayed or hidden from the user?
92	* @param title
93	* {@link Translation} for Name
94	* @param desc
95	* {@link Translation} for an attribute description
96	* @param unit
97	* {@link String} of the unit that the information is in
98	*/
99	public AttributeMetadataImpl(final NameImpl name, final Boolean visible,
100	final Translation title, final Translation desc, final String unit) {
101
102	this.setName(name);
103	this.title = title;
104	this.desc = desc;
105	this.visible = visible;
106	this.unit = unit;
107	}
108
109	/**
110	* Creates an {@link AttributeMetadataImpl} object with the following
111	* information
112	*
113	* @param colIdx
114	* The column index of this attribute in the underlying
115	* table/dbf/etc...
116	* @param visible
117	* Shall this attribute be displayed or hidden from the user?
118	* @param unit
119	* {@link String} of the unit that the information is in
120	*/
121	public AttributeMetadataImpl(final NameImpl name, final Boolean visible,
122	final String unit) {
123	this.setName(name);
124	this.visible = visible;
125	this.unit = unit;
126	}
127
128	/**
129	* Creates a new visible {@link AttributeMetadataImpl}
130	*/
131	public AttributeMetadataImpl(final NameImpl name, final List<String> langs) {
132	this(name, true, new Translation(langs, name.getLocalPart()),
133	new Translation(), "");
134	}
135
136	/**
137	* Creates a new visible {@link AttributeMetadataImpl}
138	*/
139	public AttributeMetadataImpl(final NameImpl name, final String defaultTitle,
140	final List<String> langs) {
141	this(name, true, new Translation(langs, defaultTitle),
142	new Translation(), "");
143	}
144
145	/**
146	* Creates an {@link AttributeMetadataImpl} object with the following
147	* information
148	*
149	* @param visible
150	* Shall this attribute be displayed or hidden from the user?
151	* @param title
152	* {@link Translation} for Name
153	* @param desc
154	* {@link Translation} for an attribute description
155	* @param unit
156	* {@link String} of the unit that the information is in
157	*/
158	public AttributeMetadataImpl(final String localName, final Boolean visible,
159	final Translation title, final Translation desc, final String unit) {
160	this(new NameImpl(localName), true, title, desc, "");
161	}
162
163	/**
164	* Creates a new visible {@link AttributeMetadataImpl} with default (no)
165	* values.
166	*/
167	public AttributeMetadataImpl(final String localName,
168	final List<String> langs) {
169	this(localName, true, new Translation(langs, localName),
170	new Translation(), "");
171	}
172
173	/**
174	* Creates a new visible {@link AttributeMetadataImpl}
175	*/
176	public AttributeMetadataImpl(final String localName,
177	final String defaultTitle, final List<String> langs) {
178	this(localName, true, new Translation(langs, defaultTitle),
179	new Translation(), "");
180	}
181
182	/**
183	* Orders the attributes according to their {@link #weight}. Heavier =>
184	* further down.
185	*/
186	@Override
187	public int compareTo(final AttributeMetadataInterface atm2) {
188	return new Integer(weight).compareTo(new Double(atm2.getWeight())
189	.intValue());
190	}
191
192	/**
193	* @see Copyable inferface
194	*/
195	@Override
196	public AttributeMetadataInterface copy() {
197	return copyTo(new AttributeMetadataImpl());
198	}
199
200	/**
201	* @see Copyable inferface
202	*/
203	@Override
204	public AttributeMetadataInterface copyTo(final AttributeMetadataInterface amd) {
205	getTitle().copyTo(amd.getTitle());
206	getDesc().copyTo(amd.getDesc());
207	amd.setUnit(getUnit());
208	amd.setVisible(isVisible());
209	amd.setName(new NameImpl(getName().getNamespaceURI(), getName()
210	.getLocalPart()));
211
212	amd.setWeight(getWeight());
213
214	if (amd instanceof AttributeMetadataImpl) {
215	AttributeMetadataImpl amd_ = (AttributeMetadataImpl) amd;
216
217	amd_.setFunctionX(getFunctionX());
218	amd_.setFunctionA(getFunctionA());
219	amd_.setNodataValues(getNodataValues());
220	}
221
222	return amd;
223	}
224
225	// only to be used by copyTo()
226	private void setNodataValues(HashSet<Object> nodataValues_) {
227	nodataValues = nodataValues_;
228	}
229
230	public Double getFunctionA() {
231	return functionA;
232	}
233
234	public Double getFunctionX() {
235	return functionX;
236	}
237
238	/**
239	* @return a number between 0 (bad) and 1 (good) that is calculated from the
240	* amount of translation available. If this attribute is not
241	* {@link #visible}, it will return 1.
242	*/
243	@Override
244	public double getQuality(final List<String> languages) {
245
246	if (!isVisible())
247	return 1.;
248
249	return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil
250	.qmTranslation(languages, getDesc()) * 1.) / 3.;
251	}
252
253	public void setFunctionA(final Double functionA) {
254	this.functionA = functionA;
255	}
256
257	public void setFunctionX(final Double functionX) {
258	this.functionX = functionX;
259	}
260
261
262	}