--- trunk/src/skrueger/AttributeMetaData.java 2009/07/14 15:57:19 224 +++ branches/1.0-gt2-2.6/src/skrueger/AttributeMetadata.java 2009/10/13 13:22:31 464 @@ -1,88 +1,223 @@ -package skrueger; - -import org.apache.log4j.Logger; - -import skrueger.geotools.StyledLayerInterface; -import skrueger.i8n.Translation; - -/** - * This class holds meta information about an attribute/column. This - * information is used by {@link StyledLayerInterface}. - * - * @author Stefan Alfons Krüger - */ -public class AttributeMetaData { - static private final Logger LOGGER = Logger - .getLogger(AttributeMetaData.class); - protected Translation title = new Translation(); - protected Translation desc = new Translation(); - protected boolean visible = false; - protected String unit = ""; - protected int colIdx; - - /** - * Creates an {@link AttributeMetaData} object with the following information - * @param colIdx The column index of this attribute in the underlying table/dbf/etc... - * @param visible Shall this attribute be displayed or hidden from the user? - * @param title {@link Translation} for Name - * @param desc {@link Translation} for an attribute description - * @param unit {@link String} of the unit that the information is in - */ - public AttributeMetaData(final int colIdx, final Boolean visible, - final Translation title, final Translation desc, final String unit) { - - this.colIdx = colIdx; - this.title = title; - this.desc = desc; - if (colIdx == 0){ - // The first attribut is THE_GEOM and shall never be visible! - this.visible = false; - }else - this.visible = visible; - this.unit = unit; - } - - /** - * Creates a new visible {@link AttributeMetaData} with default (no) values. - */ - public AttributeMetaData(final Integer col, final String defaultName) { - this(col, true, new Translation(defaultName), new Translation(), ""); - } - - public Boolean isVisible() { - return visible; - } - - public void setVisible(final Boolean visible) { - this.visible = visible; - } - - /** @return the index of this attribute in the underlying table/dbf **/ - public int getColIdx() { - return colIdx; - } - - public Translation getTitle() { - return title; - } - - public void setTitle(final Translation title) { - this.title = title; - } - - public Translation getDesc() { - return desc; - } - - public void setDesc(final Translation desc) { - this.desc = desc; - } - - public String getUnit() { - return unit; - } - - public void setUnit(final String unit) { - this.unit = unit; - } -} +/******************************************************************************* + * Copyright (c) 2009 Martin O. J. Schmitz. + * + * This file is part of the SCHMITZM library - a collection of utility + * classes based on Java 1.6, focusing (not only) on Java Swing + * and the Geotools library. + * + * The SCHMITZM project is hosted at: + * http://wald.intevation.org/projects/schmitzm/ + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public License + * as published by the Free Software Foundation; either version 3 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License (license.txt) + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * or try this link: http://www.gnu.org/licenses/lgpl.html + * + * Contributors: + * Martin O. J. Schmitz - initial API and implementation + * Stefan A. Krüger - additional utility classes + ******************************************************************************/ +package skrueger; + +import org.apache.log4j.Logger; +import org.geotools.feature.NameImpl; +import org.opengis.feature.type.AttributeDescriptor; +import org.opengis.feature.type.Name; + +import skrueger.geotools.Copyable; +import skrueger.geotools.StyledLayerInterface; +import skrueger.i8n.Translation; + +/** + * This class holds meta information about an attribute/column. This information + * is used by {@link StyledLayerInterface}. + * + * @author Stefan Alfons Krüger + */ +public class AttributeMetadata implements Copyable { + static private final Logger LOGGER = Logger + .getLogger(AttributeMetadata.class); + + protected Translation title = new Translation(); + protected Translation desc = new Translation(); + protected boolean visible = true; + protected String unit = ""; + protected int colIdx; + private org.opengis.feature.type.Name name; + + /** + * Creates an {@link AttributeMetadata} object with the following + * information + * + * @param colIdx + * The column index of this attribute in the underlying + * table/dbf/etc... + * @param visible + * Shall this attribute be displayed or hidden from the user? + * @param title + * {@link Translation} for Name + * @param desc + * {@link Translation} for an attribute description + * @param unit + * {@link String} of the unit that the information is in + */ + public AttributeMetadata(final Name name, final Boolean visible, + final Translation title, final Translation desc, final String unit) { + + this.setName(name); + this.title = title; + this.desc = desc; + + // The THE_GEOM and shall never be visible! + if (name.getLocalPart().equalsIgnoreCase("the_geom")) this.visible = false; + + this.unit = unit; + } + + /** + * Creates an {@link AttributeMetadata} object with the following + * information + * + * @param visible + * Shall this attribute be displayed or hidden from the user? + * @param title + * {@link Translation} for Name + * @param desc + * {@link Translation} for an attribute description + * @param unit + * {@link String} of the unit that the information is in + */ + public AttributeMetadata(final String localName, final Boolean visible, + final Translation title, final Translation desc, final String unit) { + this(new NameImpl(localName), true, title, desc, ""); + } + + /** + * Creates a new visible {@link AttributeMetadata} with default (no) values. + */ + public AttributeMetadata(final String localName, final String defaultTitle) { + this(localName, true, new Translation(defaultTitle), new Translation(), + ""); + } + + /** + * Creates a new visible {@link AttributeMetadata} with default (no) values. + */ + public AttributeMetadata(final Name name, final String defaultTitle) { + this(name, true, new Translation(defaultTitle), new Translation(), ""); + } + + /** + * Creates a new visible {@link AttributeMetadata} with default (no) values. + */ + public AttributeMetadata(final Name name) { + this(name, true, new Translation(name.getLocalPart()), + new Translation(), ""); + } + + /** + * Creates a new visible {@link AttributeMetadata} with default (no) values. + */ + public AttributeMetadata(final String localName) { + this(localName, true, new Translation(localName), new Translation(), ""); + } + + /** Only used for {@link Copyable#copy()} **/ + private AttributeMetadata() { + } + + public AttributeMetadata(AttributeDescriptor attDesc) { + this(attDesc.getName()); + } + + public boolean isVisible() { + return visible; + } + + public void setVisible(final Boolean visible) { + this.visible = visible; + } +// +// /** @return the index of this attribute in the underlying table/dbf **/ +// public int getColIdx() { +// return colIdx; +// } + + public Translation getTitle() { + return title; + } + + public void setTitle(final Translation title) { + this.title = title; + } + + public Translation getDesc() { + return desc; + } + + public void setDesc(final Translation desc) { + this.desc = desc; + } + + public String getUnit() { + return unit; + } + + public void setUnit(final String unit) { + this.unit = unit; + } + + @Override + public AttributeMetadata copyTo(AttributeMetadata amd) { + getTitle().copyTo(amd.getTitle()); + getDesc().copyTo(amd.getDesc()); + amd.setUnit(getUnit()); + amd.setVisible(isVisible()); + amd.setName(new NameImpl(getName().getNamespaceURI(), getName().getLocalPart())); + + return amd; + } + + @Override + public AttributeMetadata copy() { + return copyTo( new AttributeMetadata()); + } + + /** + * The local Name. E.g. the name of the DBF column as a String + */ + public String getLocalName() { + return getName().getLocalPart(); + } + + /** + * The fully qualified Name of the attribute, e.g. org.bla.plo:blub + */ + public Name getName() { + return name; + } + + /** + * 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; + } + + /** + * The fully qualified Name of the attribute, e.g. org.bla.plo:blub + */ + public void setLocalName(String localName) { + this.name = new NameImpl(localName); + } +}