/[schmitzm]/trunk/src/skrueger/AttributeMetadataImpl.java
ViewVC logotype

Diff of /trunk/src/skrueger/AttributeMetadataImpl.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

trunk/src/skrueger/AttributeMetaData.java revision 2 by mojays, Tue Feb 24 22:43:52 2009 UTC branches/2.0-RC1/src/skrueger/AttributeMetadata.java revision 604 by alfonx, Wed Dec 9 14:15:53 2009 UTC
# Line 1  Line 1 
1  package skrueger;  /*******************************************************************************
2     * Copyright (c) 2009 Martin O. J. Schmitz.
3  import org.apache.log4j.Logger;   *
4     * This file is part of the SCHMITZM library - a collection of utility
5  import skrueger.geotools.StyledMapInterface;   * classes based on Java 1.6, focusing (not only) on Java Swing
6  import skrueger.i8n.Translation;   * and the Geotools library.
7     *
8  /**   * The SCHMITZM project is hosted at:
9   * This class holds meta information about an attribute/column. This   * http://wald.intevation.org/projects/schmitzm/
10   * information is used by {@link StyledMapInterface}.   *
11   *   * This program is free software; you can redistribute it and/or
12   * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>   * modify it under the terms of the GNU Lesser General Public License
13   */   * as published by the Free Software Foundation; either version 3
14  public class AttributeMetaData {   * of the License, or (at your option) any later version.
15          static private final Logger LOGGER = Logger   *
16                          .getLogger(AttributeMetaData.class);   * This program is distributed in the hope that it will be useful,
17          protected Translation title = new Translation();   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18          protected Translation desc = new Translation();   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19          protected boolean visible = false;   * GNU General Public License for more details.
20          protected String unit = "";   *
21          protected int colIdx;   * 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           * Creates an {@link AttributeMetaData} object with the following information   * or try this link: http://www.gnu.org/licenses/lgpl.html
25           * @param colIdx The column index of this attribute in the underlying table/dbf/etc...   *
26           * @param visible Shall this attribute be displayed or hidden from the user?   * Contributors:
27           * @param title {@link Translation} for Name   *     Martin O. J. Schmitz - initial API and implementation
28           * @param desc {@link Translation} for an attribute description   *     Stefan A. Krüger - additional utility classes
29           * @param unit {@link String} of the unit that the information is in   ******************************************************************************/
30           */  package skrueger;
31          public AttributeMetaData(final int colIdx, final Boolean visible,  
32                          final Translation title, final Translation desc, final String unit) {  import java.util.ArrayList;
33            import java.util.List;
34                  this.colIdx = colIdx;  
35                  this.title = title;  import org.apache.log4j.Logger;
36                  this.desc = desc;  import org.geotools.feature.NameImpl;
37                  if (colIdx == 0){  import org.opengis.feature.type.AttributeDescriptor;
38                          // The first attribut is THE_GEOM and shall never be visible!  import org.opengis.feature.type.Name;
39                          this.visible = false;  
40                  }else  import skrueger.geotools.Copyable;
41                          this.visible = visible;  import skrueger.geotools.StyledLayerInterface;
42                  this.unit = unit;  import skrueger.i8n.I8NUtil;
43          }  import skrueger.i8n.Translation;
44    
45          /**  /**
46           * Creates a {@link AttributeMetaData} with default (no) values.   * This class holds meta information about an attribute/column. This information
47           */   * is used by {@link StyledLayerInterface} and many others.<br/>
48          public AttributeMetaData(final Integer col, final String defaultName) {   *
49                  this(col, true, new Translation(defaultName), new Translation(""), "");   * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
50          }   */
51    public class AttributeMetadata implements Copyable<AttributeMetadata>,
52          public Boolean isVisible() {                  Comparable<AttributeMetadata> {
53                  return visible;          
54          }          static private final Logger LOGGER = Logger
55                            .getLogger(AttributeMetadata.class);
56          public void setVisible(final Boolean visible) {  
57                  this.visible = visible;          /** Translation of the attribute's description **/
58          }          protected Translation desc = new Translation();
59    
60          /** @return the index of this attribute in the underlying table/dbf **/          /**
61          public int getColIdx() {           * For numerical attributes the value can be transformed by VALUE*X+A when
62                  return colIdx;           * presented on screen. TODO not implemented yet
63          }           **/
64            protected Double functionA = 0.;
65          public Translation getTitle() {  
66                  return title;          /**
67          }           * For numerical attributes the value can be transformed by VALUE*X+A when
68             * presented on screen. TODO not implemented yet
69          public void setTitle(final Translation title) {           **/
70                  this.title = title;          protected Double functionX = 1.;
71          }  
72            /** The Name of the attribute **/
73          public Translation getDesc() {          private Name name;
74                  return desc;  
75          }          /**
76             * Allows to define general NODATA values for an attribute. e.g. -9999 can
77          public void setDesc(final Translation desc) {           * be set and will always be interpreted as NULL internally and will usually
78                  this.desc = desc;           * be ignored. TODO not implemented yet
79          }           **/
80            protected List<Object> nodataValues = new ArrayList<Object>();
81          public String getUnit() {  
82                  return unit;          /** Translation of the attribute's title **/
83          }          protected Translation title = new Translation();
84    
85          public void setUnit(final String unit) {          /**
86                  this.unit = unit;           * The unit append to all visualizations of values of this attribute (is not
87          }           * null)
88  }           **/
89            protected String unit = "";
90    
91            /** Is the attribute visible to the user or ignored where possible **/
92            protected boolean visible = true;
93    
94            /**
95             * When listed, the attributes are listed according to their {@link #weight} (heavier
96             * => further down)
97             * @see #compareTo(AttributeMetadata)
98             **/
99            protected int weight = 0;
100    
101            /** 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            /**
116             * 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             */
131            public AttributeMetadata(final Name name, final Boolean visible,
132                            final Translation title, final Translation desc, final String unit) {
133    
134                    this.setName(name);
135                    this.title = title;
136                    this.desc = desc;
137                    this.visible = visible;
138                    this.unit = unit;
139            }
140    
141            /**
142             * Creates a new visible {@link AttributeMetadata}
143             */
144            public AttributeMetadata(final Name name, final List<String> langs) {
145                    this(name, true, new Translation(langs, name.getLocalPart()),
146                                    new Translation(), "");
147            }
148    
149            /**
150             * Creates a new visible {@link AttributeMetadata}
151             */
152            public AttributeMetadata(final Name name, final String defaultTitle,
153                            final List<String> langs) {
154                    this(name, true, new Translation(langs, defaultTitle),
155                                    new Translation(), "");
156            }
157    
158            /**
159             * Creates an {@link AttributeMetadata} object with the following
160             * information
161             *
162             * @param visible
163             *            Shall this attribute be displayed or hidden from the user?
164             * @param title
165             *            {@link Translation} for Name
166             * @param desc
167             *            {@link Translation} for an attribute description
168             * @param unit
169             *            {@link String} of the unit that the information is in
170             */
171            public AttributeMetadata(final String localName, final Boolean visible,
172                            final Translation title, final Translation desc, final String unit) {
173                    this(new NameImpl(localName), true, title, desc, "");
174            }
175    
176            /**
177             * Creates a new visible {@link AttributeMetadata} with default (no) values.
178             */
179            public AttributeMetadata(final String localName, final List<String> langs) {
180                    this(localName, true, new Translation(langs, localName),
181                                    new Translation(), "");
182            }
183    
184            /**
185             * Creates a new visible {@link AttributeMetadata}
186             */
187            public AttributeMetadata(final String localName, final String defaultTitle,
188                            final List<String> langs) {
189                    this(localName, true, new Translation(langs, defaultTitle),
190                                    new Translation(), "");
191            }
192    
193            /**
194             * Orders the attributes according to their {@link #weight}. Heavier =>
195             * further down.
196             */
197            @Override
198            public int compareTo(final AttributeMetadata atm2) {
199                    return new Integer(weight).compareTo(atm2.getWeight());
200            }
201    
202            /**
203             * @see Copyable inferface
204             */
205            @Override
206            public AttributeMetadata copy() {
207                    return copyTo(new AttributeMetadata());
208            }
209    
210            /**
211             * @see Copyable inferface
212             */
213            @Override
214            public AttributeMetadata copyTo(final AttributeMetadata amd) {
215                    getTitle().copyTo(amd.getTitle());
216                    getDesc().copyTo(amd.getDesc());
217                    amd.setUnit(getUnit());
218                    amd.setVisible(isVisible());
219                    amd.setName(new NameImpl(getName().getNamespaceURI(), getName()
220                                    .getLocalPart()));
221    
222                    amd.setWeight(getWeight());
223                    amd.setFunctionX(getFunctionX());
224                    amd.setFunctionA(getFunctionA());
225    
226                    for (final Object nodataValue : getNodataValues()) {
227                            amd.getNodataValues().add(nodataValue);
228                    }
229    
230                    return amd;
231            }
232    
233            public Translation getDesc() {
234                    return desc;
235            }
236    
237            public Double getFunctionA() {
238                    return functionA;
239            }
240    
241            public Double getFunctionX() {
242                    return functionX;
243            }
244    
245            /**
246             * The local name. E.g. the name of the DBF column as a {@link String}
247             */
248            public String getLocalName() {
249                    return getName().getLocalPart();
250            }
251    
252            /**
253             * The fully qualified {@link Name} of the attribute, e.g. <code>org.bla.plo:blub</code>
254             */
255            public Name getName() {
256                    return name;
257            }
258    
259            public List<Object> getNodataValues() {
260                    return nodataValues;
261            }
262    
263            /**
264             * @return a number between 0 (bad) and 1 (good) that is calculated from the
265             *         amount of translation available. If this attribute is not
266             *         {@link #visible}, it will return 1.
267             */
268            public double getQuality(final List<String> languages) {
269    
270                    if (!isVisible())
271                            return 1.;
272    
273                    return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil
274                                    .qmTranslation(languages, getDesc()) * 1.) / 3.;
275            }
276    
277            public Translation getTitle() {
278                    return title;
279            }
280    
281            public String getUnit() {
282                    return unit;
283            }
284    
285            public int getWeight() {
286                    return weight;
287            }
288    
289            /**
290             * Will the end-user see this attribute?
291             */
292            public boolean isVisible() {
293                    return visible;
294            }
295    
296            public void setDesc(final Translation desc) {
297                    this.desc = desc;
298            }
299    
300            public void setFunctionA(final Double functionA) {
301                    this.functionA = functionA;
302            }
303    
304            public void setFunctionX(final Double functionX) {
305                    this.functionX = functionX;
306            }
307    
308            /**
309             * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
310             */
311            public void setLocalName(final String localName) {
312                    this.name = new NameImpl(localName);
313            }
314    
315            /**
316             * The fully qualified {@link Name} of the attribute, e.g. <code>org.bla.plo:blub</code>
317             */
318            public void setName(final Name name) {
319                    this.name = name;
320            }
321    
322            public void setNodataValues(final List<Object> nodataValues) {
323                    this.nodataValues = nodataValues;
324            }
325    
326            public void setTitle(final Translation title) {
327                    this.title = title;
328            }
329    
330            public void setUnit(final String unit) {
331                    this.unit = unit;
332            }
333    
334            public void setVisible(final boolean visible) {
335                    this.visible = visible;
336            }
337    
338            /**
339             * Shall the end-user see this attribute?
340             * @param visible
341             */
342            public void setVisible(final Boolean visible) {
343    //              // The THE_GEOM and shall never be visible!
344    //              if (name.getLocalPart().equalsIgnoreCase("the_geom"))
345    //                      this.visible = false;
346    //              else
347    //                      this.visible = visible;
348    
349                    this.visible = visible;
350            }
351    
352            public void setWeight(final int weight) {
353                    this.weight = weight;
354            }
355            
356            /**
357             * For nicer debugging
358             */
359            @Override
360            public String toString() {
361                    StringBuffer sb = new StringBuffer();
362                    if (name != null) sb.append(name.toString()+" ");
363                    sb.append("weight="+weight+" ");
364                    sb.append("title="+getTitle().toString());
365                    return sb.toString();
366            }
367    }
Legend:
Removed from v.2  
changed lines
  Added in v.604
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26