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ü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 |
|
|
34 |
this.colIdx = colIdx; |
import skrueger.geotools.Copyable; |
35 |
this.title = title; |
import skrueger.geotools.StyledLayerInterface; |
36 |
this.desc = desc; |
import skrueger.i8n.Translation; |
37 |
if (colIdx == 0){ |
|
38 |
// The first attribut is THE_GEOM and shall never be visible! |
/** |
39 |
this.visible = false; |
* This class holds meta information about an attribute/column. This |
40 |
}else |
* information is used by {@link StyledLayerInterface}. |
41 |
this.visible = visible; |
* |
42 |
this.unit = unit; |
* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a> |
43 |
} |
*/ |
44 |
|
public class AttributeMetadata implements Copyable<AttributeMetadata>{ |
45 |
/** |
static private final Logger LOGGER = Logger |
46 |
* Creates a new visible {@link AttributeMetaData} with default (no) values. |
.getLogger(AttributeMetadata.class); |
47 |
*/ |
protected Translation title = new Translation(); |
48 |
public AttributeMetaData(final Integer col, final String defaultName) { |
protected Translation desc = new Translation(); |
49 |
this(col, true, new Translation(defaultName), new Translation(), ""); |
protected boolean visible = false; |
50 |
} |
protected String unit = ""; |
51 |
|
protected int colIdx; |
52 |
public Boolean isVisible() { |
|
53 |
return visible; |
/** |
54 |
} |
* Creates an {@link AttributeMetadata} object with the following information |
55 |
|
* @param colIdx The column index of this attribute in the underlying table/dbf/etc... |
56 |
public void setVisible(final Boolean visible) { |
* @param visible Shall this attribute be displayed or hidden from the user? |
57 |
this.visible = visible; |
* @param title {@link Translation} for Name |
58 |
} |
* @param desc {@link Translation} for an attribute description |
59 |
|
* @param unit {@link String} of the unit that the information is in |
60 |
/** @return the index of this attribute in the underlying table/dbf **/ |
*/ |
61 |
public int getColIdx() { |
public AttributeMetadata(final int colIdx, final Boolean visible, |
62 |
return colIdx; |
final Translation title, final Translation desc, final String unit) { |
63 |
} |
|
64 |
|
this.colIdx = colIdx; |
65 |
public Translation getTitle() { |
this.title = title; |
66 |
return title; |
this.desc = desc; |
67 |
} |
if (colIdx == 0){ |
68 |
|
// The first attribute is THE_GEOM and shall never be visible! |
69 |
public void setTitle(final Translation title) { |
this.visible = false; |
70 |
this.title = title; |
}else |
71 |
} |
this.visible = visible; |
72 |
|
this.unit = unit; |
73 |
public Translation getDesc() { |
} |
74 |
return desc; |
|
75 |
} |
/** |
76 |
|
* Creates a new visible {@link AttributeMetadata} with default (no) values. |
77 |
public void setDesc(final Translation desc) { |
*/ |
78 |
this.desc = desc; |
public AttributeMetadata(final Integer col, final String defaultName) { |
79 |
} |
this(col, true, new Translation(defaultName), new Translation(), ""); |
80 |
|
} |
81 |
public String getUnit() { |
|
82 |
return unit; |
/** Only used for {@link Copyable<AttributeMetaData>#copy()}**/ |
83 |
} |
private AttributeMetadata() { |
84 |
|
} |
85 |
public void setUnit(final String unit) { |
|
86 |
this.unit = unit; |
public boolean isVisible() { |
87 |
} |
return visible; |
88 |
} |
} |
89 |
|
|
90 |
|
public void setVisible(final Boolean visible) { |
91 |
|
this.visible = visible; |
92 |
|
} |
93 |
|
|
94 |
|
/** @return the index of this attribute in the underlying table/dbf **/ |
95 |
|
public int getColIdx() { |
96 |
|
return colIdx; |
97 |
|
} |
98 |
|
|
99 |
|
public Translation getTitle() { |
100 |
|
return title; |
101 |
|
} |
102 |
|
|
103 |
|
public void setTitle(final Translation title) { |
104 |
|
this.title = title; |
105 |
|
} |
106 |
|
|
107 |
|
public Translation getDesc() { |
108 |
|
return desc; |
109 |
|
} |
110 |
|
|
111 |
|
public void setDesc(final Translation desc) { |
112 |
|
this.desc = desc; |
113 |
|
} |
114 |
|
|
115 |
|
public String getUnit() { |
116 |
|
return unit; |
117 |
|
} |
118 |
|
|
119 |
|
public void setUnit(final String unit) { |
120 |
|
this.unit = unit; |
121 |
|
} |
122 |
|
|
123 |
|
@Override |
124 |
|
public AttributeMetadata copyTo(AttributeMetadata amd) { |
125 |
|
getTitle().copyTo(amd.getTitle()); |
126 |
|
getDesc().copyTo(amd.getDesc()); |
127 |
|
amd.setUnit(getUnit()); |
128 |
|
amd.setVisible(isVisible()); |
129 |
|
amd.setColIdx(getColIdx()); |
130 |
|
|
131 |
|
return amd; |
132 |
|
} |
133 |
|
|
134 |
|
@Override |
135 |
|
public AttributeMetadata copy() { |
136 |
|
AttributeMetadata amd = new AttributeMetadata(); |
137 |
|
getTitle().copyTo(amd.getTitle()); |
138 |
|
getDesc().copyTo(amd.getDesc()); |
139 |
|
amd.setUnit(getUnit()); |
140 |
|
amd.setVisible(isVisible()); |
141 |
|
amd.setColIdx(getColIdx()); |
142 |
|
|
143 |
|
return amd; |
144 |
|
} |
145 |
|
|
146 |
|
private void setColIdx(int colIdx_) { |
147 |
|
colIdx = colIdx_; |
148 |
|
} |
149 |
|
} |