/[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

branches/1.0-gt2-2.6/src/skrueger/AttributeMetadata.java revision 464 by alfonx, Tue Oct 13 13:22:31 2009 UTC branches/2.0-RC2/src/skrueger/AttributeMetadata.java revision 658 by alfonx, Wed Feb 3 15:32:21 2010 UTC
# Line 29  Line 29 
29   ******************************************************************************/   ******************************************************************************/
30  package skrueger;  package skrueger;
31    
32    import java.util.ArrayList;
33    import java.util.HashSet;
34    import java.util.List;
35    
36  import org.apache.log4j.Logger;  import org.apache.log4j.Logger;
37  import org.geotools.feature.NameImpl;  import org.geotools.feature.NameImpl;
38    import org.geotools.feature.Feature.NULL;
39  import org.opengis.feature.type.AttributeDescriptor;  import org.opengis.feature.type.AttributeDescriptor;
40  import org.opengis.feature.type.Name;  import org.opengis.feature.type.Name;
41    
42  import skrueger.geotools.Copyable;  import skrueger.geotools.Copyable;
43  import skrueger.geotools.StyledLayerInterface;  import skrueger.geotools.StyledLayerInterface;
44    import skrueger.i8n.I8NUtil;
45  import skrueger.i8n.Translation;  import skrueger.i8n.Translation;
46    
47  /**  /**
48   * This class holds meta information about an attribute/column. This information   * This class holds meta information about an attribute/column. This information
49   * is used by {@link StyledLayerInterface}.   * is used by {@link StyledLayerInterface} and many others.<br/>
50   *   *
51   * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>   * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
52   */   */
53  public class AttributeMetadata implements Copyable<AttributeMetadata> {  public class AttributeMetadata implements Copyable<AttributeMetadata>,
54                    Comparable<AttributeMetadata> {
55            
56          static private final Logger LOGGER = Logger          static private final Logger LOGGER = Logger
57                          .getLogger(AttributeMetadata.class);                          .getLogger(AttributeMetadata.class);
58    
59          protected Translation title = new Translation();          /** Translation of the attribute's description **/
60          protected Translation desc = new Translation();          protected Translation desc = new Translation();
61          protected boolean visible = true;  
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 functionA = 0.;
67    
68            /**
69             * For numerical attributes the value can be transformed by VALUE*X+A when
70             * presented on screen. TODO not implemented yet
71             **/
72            protected Double functionX = 1.;
73    
74            /** The Name of the attribute **/
75            private Name name;
76    
77            /**
78             * 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             **/
82            protected HashSet<Object> nodataValues = new HashSet<Object>();
83    
84            /** Translation of the attribute's title **/
85            protected Translation title = new Translation();
86    
87            /**
88             * The unit append to all visualizations of values of this attribute (is not
89             * null)
90             **/
91          protected String unit = "";          protected String unit = "";
92          protected int colIdx;  
93          private org.opengis.feature.type.Name name;          /** 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           * Creates an {@link AttributeMetadata} object with the following
# Line 77  public class AttributeMetadata implement Line 136  public class AttributeMetadata implement
136                  this.setName(name);                  this.setName(name);
137                  this.title = title;                  this.title = title;
138                  this.desc = desc;                  this.desc = desc;
139                                    this.visible = visible;
                 // The THE_GEOM and shall never be visible!  
                 if (name.getLocalPart().equalsIgnoreCase("the_geom")) this.visible = false;  
                   
140                  this.unit = unit;                  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           * Creates an {@link AttributeMetadata} object with the following
# Line 105  public class AttributeMetadata implement Line 197  public class AttributeMetadata implement
197          /**          /**
198           * Creates a new visible {@link AttributeMetadata} with default (no) values.           * Creates a new visible {@link AttributeMetadata} with default (no) values.
199           */           */
200          public AttributeMetadata(final String localName, final String defaultTitle) {          public AttributeMetadata(final String localName, final List<String> langs) {
201                  this(localName, true, new Translation(defaultTitle), new Translation(),                  this(localName, true, new Translation(langs, localName),
202                                  "");                                  new Translation(), "");
203          }          }
204    
205          /**          /**
206           * Creates a new visible {@link AttributeMetadata} with default (no) values.           * Creates a new visible {@link AttributeMetadata}
207           */           */
208          public AttributeMetadata(final Name name, final String defaultTitle) {          public AttributeMetadata(final String localName, final String defaultTitle,
209                  this(name, true, new Translation(defaultTitle), new Translation(), "");                          final List<String> langs) {
210                    this(localName, true, new Translation(langs, defaultTitle),
211                                    new Translation(), "");
212          }          }
213    
214          /**          /**
215           * Creates a new visible {@link AttributeMetadata} with default (no) values.           * Orders the attributes according to their {@link #weight}. Heavier =>
216             * further down.
217           */           */
218          public AttributeMetadata(final Name name) {          @Override
219                  this(name, true, new Translation(name.getLocalPart()),          public int compareTo(final AttributeMetadata atm2) {
220                                  new Translation(), "");                  return new Integer(weight).compareTo(atm2.getWeight());
221          }          }
222    
223          /**          /**
224           * Creates a new visible {@link AttributeMetadata} with default (no) values.           * @see Copyable inferface
225           */           */
226          public AttributeMetadata(final String localName) {          @Override
227                  this(localName, true, new Translation(localName), new Translation(), "");          public AttributeMetadata copy() {
228                    return copyTo(new AttributeMetadata());
229          }          }
230    
231          /** Only used for {@link Copyable<AttributeMetaData>#copy()} **/          /**
232          private AttributeMetadata() {           * @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 AttributeMetadata(AttributeDescriptor attDesc) {          public Translation getDesc() {
255                  this(attDesc.getName());                  return desc;
256          }          }
257    
258          public boolean isVisible() {          public Double getFunctionA() {
259                  return visible;                  return functionA;
260          }          }
261    
262          public void setVisible(final Boolean visible) {          public Double getFunctionX() {
263                  this.visible = visible;                  return functionX;
264          }          }
 //  
 //      /** @return the index of this attribute in the underlying table/dbf **/  
 //      public int getColIdx() {  
 //              return colIdx;  
 //      }  
265    
266          public Translation getTitle() {          /**
267                  return title;           * 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          public void setTitle(final Translation title) {          /**
274                  this.title = title;           * 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 Translation getDesc() {          public HashSet<Object> getNodataValues() {
281                  return desc;                  return nodataValues;
282          }          }
283    
284          public void setDesc(final Translation desc) {          /**
285                  this.desc = desc;           * @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() {          public String getUnit() {
303                  return unit;                  return unit;
304          }          }
305    
306          public void setUnit(final String unit) {          public int getWeight() {
307                  this.unit = unit;                  return weight;
308          }          }
309    
310          @Override          /**
311          public AttributeMetadata copyTo(AttributeMetadata amd) {           * Will the end-user see this attribute?
312                  getTitle().copyTo(amd.getTitle());           */
313                  getDesc().copyTo(amd.getDesc());          public boolean isVisible() {
314                  amd.setUnit(getUnit());                  return visible;
315                  amd.setVisible(isVisible());          }
                 amd.setName(new NameImpl(getName().getNamespaceURI(), getName().getLocalPart()));  
316    
317                  return amd;          public void setDesc(final Translation desc) {
318                    this.desc = desc;
319          }          }
320    
321          @Override          public void setFunctionA(final Double functionA) {
322          public AttributeMetadata copy() {                  this.functionA = functionA;
                 return copyTo( new AttributeMetadata());  
323          }          }
324    
325          /**          public void setFunctionX(final Double functionX) {
326           * The local Name. E.g. the name of the DBF column as a String                  this.functionX = functionX;
          */  
         public String getLocalName() {  
                 return getName().getLocalPart();  
327          }          }
328    
329          /**          /**
330           * The fully qualified Name of the attribute, e.g. org.bla.plo:blub           * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
331           */           */
332          public Name getName() {          public void setLocalName(final String localName) {
333                  return name;                  this.name = new NameImpl(localName);
334          }          }
335    
336          /**          /**
337           * The fully qualified Name of the attribute, e.g. org.bla.plo:blub           * The fully qualified {@link Name} of the attribute, e.g. <code>org.bla.plo:blub</code>
338           */           */
339          public void setName(org.opengis.feature.type.Name name) {          public void setName(final Name name) {
340                  this.name = name;                  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           * The fully qualified Name of the attribute, e.g. org.bla.plo:blub           * Shall the end-user see this attribute?
361             * @param visible
362           */           */
363          public void setLocalName(String localName) {          public void setVisible(final Boolean visible) {
364                  this.name = new NameImpl(localName);  //              // 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.464  
changed lines
  Added in v.658
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26