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