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

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