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