/[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 trunk/src/skrueger/AttributeMetadataImpl.java revision 772 by alfonx, Sun Mar 21 14:05:26 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;  import org.geotools.feature.NameImpl;
37  import org.opengis.feature.type.AttributeDescriptor;  import org.opengis.feature.type.AttributeDescriptor;
 import org.opengis.feature.type.Name;  
38    
39  import skrueger.geotools.Copyable;  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 information   * This class holds meta information about an attribute/column. This information
46   * 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 implements Copyable<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    
56          protected Translation title = new Translation();          /**
57          protected Translation desc = new Translation();           * For numerical attributes the value can be transformed by VALUE*X+A when
58          protected boolean visible = true;           * presented on screen. TODO not implemented yet
59          protected String unit = "";           **/
60          protected int colIdx;          protected Double functionA = 0.;
         private org.opengis.feature.type.Name name;  
61    
62          /**          /**
63           * Creates an {@link AttributeMetadata} object with the following           * 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 functionX = 1.;
67    
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           * information
86           *           *
87           * @param colIdx           * @param colIdx
# Line 71  public class AttributeMetadata implement Line 96  public class AttributeMetadata implement
96           * @param unit           * @param unit
97           *            {@link String} of the unit that the information is in           *            {@link String} of the unit that the information is in
98           */           */
99          public AttributeMetadata(final Name name, 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.setName(name);                  this.setName(name);
103                  this.title = title;                  this.title = title;
104                  this.desc = desc;                  this.desc = desc;
105                                    this.visible = visible;
106                  // The THE_GEOM and shall never be visible!                  this.unit = unit;
107                  if (name.getLocalPart().equalsIgnoreCase("the_geom")) this.visible = false;          }
108                    
109            /**
110             * 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 AttributeMetadataImpl(final NameImpl name, final Boolean visible,
122                            final String unit) {
123                    this.setName(name);
124                    this.visible = visible;
125                  this.unit = unit;                  this.unit = unit;
126          }          }
127    
128          /**          /**
129           * Creates an {@link AttributeMetadata} object with the following           * 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            /**
137             * 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            /**
146             * Creates an {@link AttributeMetadataImpl} object with the following
147           * information           * information
148           *           *
149           * @param visible           * @param visible
# Line 97  public class AttributeMetadata implement Line 155  public class AttributeMetadata implement
155           * @param unit           * @param unit
156           *            {@link String} of the unit that the information is in           *            {@link String} of the unit that the information is in
157           */           */
158          public AttributeMetadata(final String localName, final Boolean visible,          public AttributeMetadataImpl(final String localName, final Boolean visible,
159                          final Translation title, final Translation desc, final String unit) {                          final Translation title, final Translation desc, final String unit) {
160                  this(new NameImpl(localName), true, title, desc, "");                  this(new NameImpl(localName), true, title, desc, "");
161          }          }
162    
163          /**          /**
164           * Creates a new visible {@link AttributeMetadata} with default (no) values.           * Creates a new visible {@link AttributeMetadataImpl} with default (no)
165             * values.
166           */           */
167          public AttributeMetadata(final String localName, final String defaultTitle) {          public AttributeMetadataImpl(final String localName,
168                  this(localName, true, new Translation(defaultTitle), new Translation(),                          final List<String> langs) {
169                                  "");                  this(localName, true, new Translation(langs, localName),
170                                    new Translation(), "");
171          }          }
172    
173          /**          /**
174           * Creates a new visible {@link AttributeMetadata} with default (no) values.           * Creates a new visible {@link AttributeMetadataImpl}
175           */           */
176          public AttributeMetadata(final Name name, final String defaultTitle) {          public AttributeMetadataImpl(final String localName,
177                  this(name, true, new Translation(defaultTitle), new Translation(), "");                          final String defaultTitle, final List<String> langs) {
178                    this(localName, true, new Translation(langs, defaultTitle),
179                                    new Translation(), "");
180          }          }
181    
182          /**          /**
183           * Creates a new visible {@link AttributeMetadata} with default (no) values.           * Orders the attributes according to their {@link #weight}. Heavier =>
184             * further down.
185           */           */
186          public AttributeMetadata(final Name name) {          @Override
187                  this(name, true, new Translation(name.getLocalPart()),          public int compareTo(final AttributeMetadataInterface atm2) {
188                                  new Translation(), "");                  return new Integer(weight).compareTo(new Double(atm2.getWeight())
189                                    .intValue());
190          }          }
191    
192          /**          /**
193           * Creates a new visible {@link AttributeMetadata} with default (no) values.           * @see Copyable inferface
194           */           */
195          public AttributeMetadata(final String localName) {          @Override
196                  this(localName, true, new Translation(localName), new Translation(), "");          public AttributeMetadataInterface copy() {
197          }                  return copyTo(new AttributeMetadataImpl());
   
         /** Only used for {@link Copyable<AttributeMetaData>#copy()} **/  
         private AttributeMetadata() {  
         }  
   
         public AttributeMetadata(AttributeDescriptor attDesc) {  
                 this(attDesc.getName());  
198          }          }
199    
200          public boolean isVisible() {          /**
201                  return visible;           * @see Copyable inferface
202          }           */
203            @Override
204            public AttributeMetadataInterface copyTo(final AttributeMetadataInterface 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          public void setVisible(final Boolean visible) {                  amd.setWeight(getWeight());
                 this.visible = visible;  
         }  
 //  
 //      /** @return the index of this attribute in the underlying table/dbf **/  
 //      public int getColIdx() {  
 //              return colIdx;  
 //      }  
213    
214          public Translation getTitle() {                  if (amd instanceof AttributeMetadataImpl) {
215                  return title;                          AttributeMetadataImpl amd_ = (AttributeMetadataImpl) amd;
         }  
216    
217          public void setTitle(final Translation title) {                          amd_.setFunctionX(getFunctionX());
218                  this.title = title;                          amd_.setFunctionA(getFunctionA());
219          }                          amd_.setNodataValues(getNodataValues());
220                    }
221    
222          public Translation getDesc() {                  return amd;
                 return desc;  
223          }          }
224    
225          public void setDesc(final Translation desc) {          // only to be used by copyTo()
226                  this.desc = desc;          private void setNodataValues(HashSet<Object> nodataValues_) {
227                    nodataValues = nodataValues_;
228          }          }
229    
230          public String getUnit() {          public Double getFunctionA() {
231                  return unit;                  return functionA;
232          }          }
233    
234          public void setUnit(final String unit) {          public Double getFunctionX() {
235                  this.unit = unit;                  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          @Override
244          public AttributeMetadata copyTo(AttributeMetadata amd) {          public double getQuality(final List<String> languages) {
                 getTitle().copyTo(amd.getTitle());  
                 getDesc().copyTo(amd.getDesc());  
                 amd.setUnit(getUnit());  
                 amd.setVisible(isVisible());  
                 amd.setName(new NameImpl(getName().getNamespaceURI(), getName().getLocalPart()));  
245    
246                  return amd;                  if (!isVisible())
247          }                          return 1.;
248    
249          @Override                  return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil
250          public AttributeMetadata copy() {                                  .qmTranslation(languages, getDesc()) * 1.) / 3.;
                 return copyTo( new AttributeMetadata());  
251          }          }
252    
253          /**          public void setFunctionA(final Double functionA) {
254           * The local Name. E.g. the name of the DBF column as a String                  this.functionA = functionA;
          */  
         public String getLocalName() {  
                 return getName().getLocalPart();  
255          }          }
256    
257          /**          public void setFunctionX(final Double functionX) {
258           * The fully qualified Name of the attribute, e.g. org.bla.plo:blub                  this.functionX = functionX;
          */  
         public Name getName() {  
                 return name;  
259          }          }
260    
         /**  
          * The fully qualified Name of the attribute, e.g. org.bla.plo:blub  
          */  
         public void setName(org.opengis.feature.type.Name name) {  
                 this.name = name;  
         }  
261    
         /**  
          * The fully qualified Name of the attribute, e.g. org.bla.plo:blub  
          */  
         public void setLocalName(String localName) {  
                 this.name = new NameImpl(localName);  
         }  
262  }  }
Legend:
Removed from v.464  
changed lines
  Added in v.772
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26