/[schmitzm]/trunk/src/skrueger/AttributeMetadataInterface.java
ViewVC logotype

Diff of /trunk/src/skrueger/AttributeMetadataInterface.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

trunk/src/skrueger/AttributeMetaData.java revision 93 by alfonx, Fri May 1 16:24:15 2009 UTC branches/1.0-gt2-2.6/src/skrueger/AttributeMetadata.java revision 472 by alfonx, Wed Oct 14 22:48:50 2009 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.StyledMapInterface;   * 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 StyledMapInterface}.   *
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 org.apache.log4j.Logger;
33            import org.geotools.feature.NameImpl;
34                  this.colIdx = colIdx;  import org.opengis.feature.type.AttributeDescriptor;
35                  this.title = title;  import org.opengis.feature.type.Name;
36                  this.desc = desc;  
37                  if (colIdx == 0){  import skrueger.geotools.Copyable;
38                          // The first attribut is THE_GEOM and shall never be visible!  import skrueger.geotools.StyledLayerInterface;
39                          this.visible = false;  import skrueger.i8n.Translation;
40                  }else  
41                          this.visible = visible;  /**
42                  this.unit = unit;   * This class holds meta information about an attribute/column. This information
43          }   * is used by {@link StyledLayerInterface}.
44     *
45          /**   * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
46           * Creates a new visible {@link AttributeMetaData} with default (no) values.     */
47           */  public class AttributeMetadata implements Copyable<AttributeMetadata> {
48          public AttributeMetaData(final Integer col, final String defaultName) {          static private final Logger LOGGER = Logger
49                  this(col, true, new Translation(defaultName), new Translation(), "");                          .getLogger(AttributeMetadata.class);
50          }  
51            protected Translation title = new Translation();
52          public Boolean isVisible() {          protected Translation desc = new Translation();
53                  return visible;          protected boolean visible = true;
54          }          protected String unit = "";
55            protected int colIdx;
56          public void setVisible(final Boolean visible) {          private Name name;
57                  this.visible = visible;  
58          }          /**
59             * Creates an {@link AttributeMetadata} object with the following
60          /** @return the index of this attribute in the underlying table/dbf **/           * information
61          public int getColIdx() {           *
62                  return colIdx;           * @param colIdx
63          }           *            The column index of this attribute in the underlying
64             *            table/dbf/etc...
65          public Translation getTitle() {           * @param visible
66                  return title;           *            Shall this attribute be displayed or hidden from the user?
67          }           * @param title
68             *            {@link Translation} for Name
69          public void setTitle(final Translation title) {           * @param desc
70                  this.title = title;           *            {@link Translation} for an attribute description
71          }           * @param unit
72             *            {@link String} of the unit that the information is in
73          public Translation getDesc() {           */
74                  return desc;          public AttributeMetadata(final Name name, final Boolean visible,
75          }                          final Translation title, final Translation desc, final String unit) {
76    
77          public void setDesc(final Translation desc) {                  this.setName(name);
78                  this.desc = desc;                  this.title = title;
79          }                  this.desc = desc;
80    
81          public String getUnit() {                  // The THE_GEOM and shall never be visible!
82                  return unit;                  if (name.getLocalPart().equalsIgnoreCase("the_geom"))
83          }                          this.visible = false;
84                    else
85          public void setUnit(final String unit) {                          this.visible = visible;
86                  this.unit = unit;  
87          }                  this.unit = unit;
88  }          }
89    
90            /**
91             * Creates an {@link AttributeMetadata} object with the following
92             * information
93             *
94             * @param visible
95             *            Shall this attribute be displayed or hidden from the user?
96             * @param title
97             *            {@link Translation} for Name
98             * @param desc
99             *            {@link Translation} for an attribute description
100             * @param unit
101             *            {@link String} of the unit that the information is in
102             */
103            public AttributeMetadata(final String localName, final Boolean visible,
104                            final Translation title, final Translation desc, final String unit) {
105                    this(new NameImpl(localName), true, title, desc, "");
106            }
107    
108            /**
109             * Creates a new visible {@link AttributeMetadata} with default (no) values.
110             */
111            public AttributeMetadata(final String localName, final String defaultTitle) {
112                    this(localName, true, new Translation(defaultTitle), new Translation(),
113                                    "");
114            }
115    
116            /**
117             * Creates a new visible {@link AttributeMetadata} with default (no) values.
118             */
119            public AttributeMetadata(final Name name, final String defaultTitle) {
120                    this(name, true, new Translation(defaultTitle), new Translation(), "");
121            }
122    
123            /**
124             * Creates a new visible {@link AttributeMetadata} with default (no) values.
125             */
126            public AttributeMetadata(final Name name) {
127                    this(name, true, new Translation(name.getLocalPart()),
128                                    new Translation(), "");
129            }
130    
131            /**
132             * Creates a new visible {@link AttributeMetadata} with default (no) values.
133             */
134            public AttributeMetadata(final String localName) {
135                    this(localName, true, new Translation(localName), new Translation(), "");
136            }
137    
138            /** Only used for {@link Copyable<AttributeMetaData>#copy()} **/
139            private AttributeMetadata() {
140            }
141    
142            public AttributeMetadata(AttributeDescriptor attDesc) {
143                    this(attDesc.getName());
144            }
145    
146            public boolean isVisible() {
147                    return visible;
148            }
149    
150            public void setVisible(final Boolean visible) {
151                    this.visible = visible;
152            }
153    
154            //
155            // /** @return the index of this attribute in the underlying table/dbf **/
156            // public int getColIdx() {
157            // return colIdx;
158            // }
159    
160            public Translation getTitle() {
161                    return title;
162            }
163    
164            public void setTitle(final Translation title) {
165                    this.title = title;
166            }
167    
168            public Translation getDesc() {
169                    return desc;
170            }
171    
172            public void setDesc(final Translation desc) {
173                    this.desc = desc;
174            }
175    
176            public String getUnit() {
177                    return unit;
178            }
179    
180            public void setUnit(final String unit) {
181                    this.unit = unit;
182            }
183    
184            @Override
185            public AttributeMetadata copyTo(AttributeMetadata amd) {
186                    getTitle().copyTo(amd.getTitle());
187                    getDesc().copyTo(amd.getDesc());
188                    amd.setUnit(getUnit());
189                    amd.setVisible(isVisible());
190                    amd.setName(new NameImpl(getName().getNamespaceURI(), getName()
191                                    .getLocalPart()));
192    
193                    return amd;
194            }
195    
196            @Override
197            public AttributeMetadata copy() {
198                    return copyTo(new AttributeMetadata());
199            }
200    
201            /**
202             * The local Name. E.g. the name of the DBF column as a String
203             */
204            public String getLocalName() {
205                    return getName().getLocalPart();
206            }
207    
208            /**
209             * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
210             */
211            public Name getName() {
212                    return name;
213            }
214    
215            /**
216             * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
217             */
218            public void setName(org.opengis.feature.type.Name name) {
219                    this.name = name;
220            }
221    
222            /**
223             * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
224             */
225            public void setLocalName(String localName) {
226                    this.name = new NameImpl(localName);
227            }
228    }
Legend:
Removed from v.93  
changed lines
  Added in v.472
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26