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