--- branches/1.0-gt2-2.6/src/skrueger/AttributeMetadata.java	2009/11/18 09:54:52	523
+++ trunk/src/skrueger/AttributeMetadataInterface.java	2010/04/10 16:12:40	797
@@ -1,348 +1,123 @@
-/*******************************************************************************
- * 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 java.util.ArrayList;
-import java.util.List;
+import java.util.HashSet;
 
-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.I8NUtil;
 import skrueger.i8n.Translation;
 
-/**
- * This class holds meta information about an attribute/column. This information
- * is used by {@link StyledLayerInterface} and many others.<br/>
- * 
- * @author <a href="mailto:skpublic@wikisquare.de">Stefan Alfons Kr&uuml;ger</a>
- */
-public class AttributeMetadata implements Copyable<AttributeMetadata>,
-		Comparable<AttributeMetadata> {
-	static private final Logger LOGGER = Logger
-			.getLogger(AttributeMetadata.class);
-
-	// public class WeightComparator implements Comparator<AttributeDescriptor>
-	// {
-	//
-	// @Override
-	// public int compare(AttributeDescriptor o1, AttributeDescriptor o2) {
-	// // TODO Auto-generated method stub
-	// return 0;
-	// }
-	//		
-	// };
-
-	/** Translation of the attribute's title **/
-	protected Translation title = new Translation();
-
-	/** Translation of the attribute's description **/
-	protected Translation desc = new Translation();
-
-	/** Is the attribute visible to the user or ignored where possible **/
-	protected boolean visible = true;
-
-	/**
-	 * The unit append to all visualizations of values of this attribute (is not
-	 * null)
-	 **/
-	protected String unit = "";
-
-	/** The Name of the attribute **/
-	private Name name;
-
-	public int getWeight() {
-		return weight;
-	}
-
-	public void setWeight(int weight) {
-		this.weight = weight;
-	}
-
-	public List<Object> getNodataValues() {
-		return nodataValues;
-	}
-
-	public void setNodataValues(List<Object> nodataValues) {
-		this.nodataValues = nodataValues;
-	}
-
-	public Double getFunctionX() {
-		return functionX;
-	}
-
-	public void setFunctionX(Double functionX) {
-		this.functionX = functionX;
-	}
-
-	public Double getFunctionA() {
-		return functionA;
-	}
-
-	public void setFunctionA(Double functionA) {
-		this.functionA = functionA;
-	}
-
-	public void setVisible(boolean visible) {
-		this.visible = visible;
-	}
-
-	/**
-	 * When listed, the attributes are listed according to their weight (heavier
-	 * => further down)
-	 **/
-	protected int weight = 0;
-
-	/**
-	 * Allows to define general NODATA values for an attribute. e.g. -9999 can
-	 * be set and will always be interpreted as NULL internally and will usually
-	 * be ignored.
-	 **/
-	protected List<Object> nodataValues = new ArrayList<Object>();
-
-	/**
-	 * For numerical attributes the value can be transformed by VALUE*X+A when
-	 * presented on screen
-	 **/
-	protected Double functionX = 1.;
-
-	/**
-	 * For numerical attributes the value can be transformed by VALUE*X+A when
-	 * presented on screen
-	 **/
-	protected Double functionA = 0.;
+public interface AttributeMetadataInterface extends Copyable<AttributeMetadataInterface>,
+		Comparable<AttributeMetadataInterface> {
 
 	/**
-	 * 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;
-		else
-			this.visible = visible;
-
-		this.unit = unit;
-	}
+	 * @return a translatable title for this attribute..
+	 */
+	public Translation getTitle();
 
 	/**
-	 * 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
+	 * Set a translatable title for this attribute..
 	 */
-	public AttributeMetadata(final String localName, final Boolean visible,
-			final Translation title, final Translation desc, final String unit) {
-		this(new NameImpl(localName), true, title, desc, "");
-	}
-
+	public void setTitle(Translation title);
+	
 	/**
-	 * Creates a new visible {@link AttributeMetadata} with default (no) values.
+	 * Set an untranslated title for this attribute or pass a {@link Translation} encryped as a {@link String}
 	 */
-	public AttributeMetadata(final String localName, final String defaultTitle) {
-		this(localName, true, new Translation(defaultTitle), new Translation(),
-				"");
-	}
+	public void setTitle(String title);
 
 	/**
-	 * Creates a new visible {@link AttributeMetadata} with default (no) values.
+	 * @return a translatable description for this attribute
 	 */
-	public AttributeMetadata(final Name name, final String defaultTitle) {
-		this(name, true, new Translation(defaultTitle), new Translation(), "");
-	}
+	public Translation getDesc();
 
 	/**
-	 * Creates a new visible {@link AttributeMetadata} with default (no) values.
+	 * Set a translatable description for this attribute.
 	 */
-	public AttributeMetadata(final Name name) {
-		this(name, true, new Translation(name.getLocalPart()),
-				new Translation(), "");
-	}
+	public void setDesc(Translation desc);
 
 	/**
-	 * Creates a new visible {@link AttributeMetadata} with default (no) values.
+	 * Set an untranslated description for this attribute or pass a {@link Translation} encryped as a {@link String}  
 	 */
-	public AttributeMetadata(final String localName) {
-		this(localName, true, new Translation(localName), new Translation(), "");
-	}
-
-	/** Only used for {@link Copyable<AttributeMetaData>#copy()} **/
-	private AttributeMetadata() {
-	}
-
-	public AttributeMetadata(AttributeDescriptor attDesc) {
-		this(attDesc.getName());
-	}
-
-	public AttributeMetadata(AttributeDescriptor attDesc, int weight) {
-		this(attDesc.getName());
-		setWeight(weight);
-	}
-
-	public boolean isVisible() {
-		return visible;
-	}
-
-	public void setVisible(final Boolean visible) {
-
-		// The THE_GEOM and shall never be visible! // TODO MAKE BETTER
-		if (name.getLocalPart().equalsIgnoreCase("the_geom"))
-			this.visible = false;
-		else
-			this.visible = visible;
-		
-		this.visible = visible;
-	}
-
-	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 void setDesc(String desc);
 
-	public String getUnit() {
-		return unit;
-	}
 
-	public void setUnit(final String unit) {
-		this.unit = unit;
-	}
+	/**
+	 * The local name. E.g. the name of the DBF column as a {@link String}.
+	 */
+	public String getLocalName();
 
-	@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()));
+	/**
+	 * A short form for #setName(new NameImpl(localName))
+	 */
+	public void setLocalName(String localName);
 
-		amd.setWeight(getWeight());
-		amd.setFunctionX(getFunctionX());
-		amd.setFunctionA(getFunctionA());
+	/**
+	 * The fully qualified {@link Name} of the attribute, e.g.
+	 * <code>org.bla.plo:blub</code>. The second part equals the
+	 * {@link #getLocalName()} value. The first may be <code>null</code> or
+	 * represent the layer name.
+	 */
+	public Name getName();
 
-		for (Object nodataValue : getNodataValues()) {
-			amd.getNodataValues().add(nodataValue);
-		}
+	/**
+	 * set the fully qualified {@link Name} of this attribute.
+	 */
+	public void setName(Name name);
 
-		return amd;
-	}
+	/**
+	 * A list og objects that represent NODATA-values for this attribute. The
+	 * objects are supporsed to be correctly casted already. That means that the
+	 * NODATA objects listed here have must have the same type as the values of
+	 * this object.
+	 */
+	public HashSet<Object> getNodataValues();
 
-	@Override
-	public AttributeMetadata copy() {
-		return copyTo(new AttributeMetadata());
-	}
+	/**
+	 * Takes any value object and checks it against the NODATA values. If the
+	 * value equals a NODATA value, <code>null</code> is returned. Otherwise the
+	 * same object is returned.
+	 * 
+	 * Note: This method is called often.
+	 */
+	public Object fiterNodata(Object value);
 
 	/**
-	 * The local Name. E.g. the name of the DBF column as a String
+	 * @return a non-translatable unit {@link String} for this attribute values.
 	 */
-	public String getLocalName() {
-		return getName().getLocalPart();
-	}
+	public String getUnit();
 
 	/**
-	 * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
+	 * Set a unit {@link String} for this attribute values.
 	 */
-	public Name getName() {
-		return name;
-	}
+	public void setUnit(String unit);
 
 	/**
-	 * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
+	 * @return A value defining the position of this attribute whenever the
+	 *         attributes are listed to an end-user. The higher the weight, the
+	 *         lower the position. (heavy goes down, light goes up)
 	 */
-	public void setName(org.opengis.feature.type.Name name) {
-		this.name = name;
-	}
+	public double getWeight();
 
 	/**
-	 * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
+	 * set a value defining the position of this attribute whenever the
+	 * attributes are listed to an end-user. The higher the weight, the lower
+	 * the position. (heavy goes down, light goes up)
 	 */
-	public void setLocalName(String localName) {
-		this.name = new NameImpl(localName);
-	}
+	public void setWeight(double weight);
 
 	/**
-	 * Orders the Attributes according to their weight. Heavier => further down.
+	 * @return <code>false</code> if this attribute should not be selectable or
+	 *         shown to the end-user.
 	 */
-	@Override
-	public int compareTo(AttributeMetadata atm2) {
-		// Double double1 = new Double(1./weight);
-		// double double2 = 1./atm2.getWeight();
-		return new Integer(weight).compareTo(atm2.getWeight());
-	}
+	public boolean isVisible();
 
 	/**
-	 * @return a number between 0 (bad) and 1 (good) that is calculated from the amount of translation available in the visible attributes
+	 * Set <code>false</code> if this attribute should not be shown to the
+	 * end-user.
 	 */
-	public double getQuality(List<String> languages) {
-		return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil
-				.qmTranslation(languages, getDesc()) * 1.) / 3.;
-	}
+	public void setVisible(boolean visible);
+
+	String getNoDataValuesFormatted();
+
 }