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. Tzeggai - 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 Tzeggai</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 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 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 Name 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 Name name, final List<String> langs) {
                this(name, true, new Translation(langs, name.getLocalPart()),
                                new Translation(), "");
        }

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