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

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

Parent Directory | Revision Log | View Patch Patch

-trunk/src/skrueger/AttributeMetaData.java
revision 2 by mojays,
Tue Feb 24 22:43:52 2009 UTC
+branches/2.0-RC2/src/skrueger/AttributeMetadata.java
revision 681 by alfonx,
Tue Feb  9 22:08:26 2010 UTC
 Line 1
- package skrueger;
+ /*******************************************************************************
+  * Copyright (c) 2009 Martin O. J. Schmitz.
- import org.apache.log4j.Logger;
+  *
+  * This file is part of the SCHMITZM library - a collection of utility
- import skrueger.geotools.StyledMapInterface;
+  * classes based on Java 1.6, focusing (not only) on Java Swing
- import skrueger.i8n.Translation;
+  * and the Geotools library.
+  *
- /**
+  * The SCHMITZM project is hosted at:
-  * This class holds meta information about an attribute/column. This
+  * http://wald.intevation.org/projects/schmitzm/
-  * information is used by {@link StyledMapInterface}.
+  *
-  *
+  * This program is free software; you can redistribute it and/or
-  * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
+  * modify it under the terms of the GNU Lesser General Public License
-  */
+  * as published by the Free Software Foundation; either version 3
- public class AttributeMetaData {
+  * of the License, or (at your option) any later version.
-         static private final Logger LOGGER = Logger
+  *
-                         .getLogger(AttributeMetaData.class);
+  * This program is distributed in the hope that it will be useful,
-         protected Translation title = new Translation();
+  * but WITHOUT ANY WARRANTY; without even the implied warranty of
-         protected Translation desc = new Translation();
+  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-         protected boolean visible = false;
+  * GNU General Public License for more details.
-         protected String unit = "";
+  *
-         protected int colIdx;
+  * 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.
-          * Creates an {@link AttributeMetaData} object with the following information
+  * or try this link: http://www.gnu.org/licenses/lgpl.html
-          * @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?
+  * Contributors:
-          * @param title {@link Translation} for Name
+  *     Martin O. J. Schmitz - initial API and implementation
-          * @param desc {@link Translation} for an attribute description
+  *     Stefan A. Krüger - additional utility classes
-          * @param unit {@link String} of the unit that the information is in
+  ******************************************************************************/
-          */
+ package skrueger;
-         public AttributeMetaData(final int colIdx, final Boolean visible,
-                         final Translation title, final Translation desc, final String unit) {
+ import java.util.HashSet;
+ import java.util.List;
-                 this.colIdx = colIdx;
+ import java.util.Set;
-                 this.title = title;
-                 this.desc = desc;
+ import org.apache.log4j.Logger;
-                 if (colIdx == 0){
+ import org.geotools.feature.NameImpl;
-                         // The first attribut is THE_GEOM and shall never be visible!
+ import org.opengis.feature.type.AttributeDescriptor;
-                         this.visible = false;
+ import org.opengis.feature.type.Name;
-                 }else
-                         this.visible = visible;
+ import skrueger.geotools.Copyable;
-                 this.unit = unit;
+ import skrueger.geotools.StyledLayerInterface;
-         }
+ import skrueger.i8n.I8NUtil;
+ import skrueger.i8n.Translation;
-         /**
-          * Creates a {@link AttributeMetaData} with default (no) values.
+ /**
-          */
+  * This class holds meta information about an attribute/column. This information
-         public AttributeMetaData(final Integer col, final String defaultName) {
+  * is used by {@link StyledLayerInterface} and many others.<br/>
-                 this(col, true, new Translation(defaultName), new Translation(""), "");
+  *
-         }
+  * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
+  */
-         public Boolean isVisible() {
+ public class AttributeMetadata implements Copyable<AttributeMetadata>,
-                 return visible;
+                 Comparable<AttributeMetadata> {
-         }
+         static private final Logger LOGGER = Logger
-         public void setVisible(final Boolean visible) {
+                         .getLogger(AttributeMetadata.class);
-                 this.visible = visible;
-         }
+         /** Translation of the attribute's description **/
+         protected Translation desc = new Translation();
-         /** @return the index of this attribute in the underlying table/dbf **/
-         public int getColIdx() {
+         /**
-                 return colIdx;
+          * For numerical attributes the value can be transformed by VALUE*X+A when
-         }
+          * presented on screen. TODO not implemented yet
+          **/
-         public Translation getTitle() {
+         protected Double functionA = 0.;
-                 return title;
-         }
+         /**
+          * For numerical attributes the value can be transformed by VALUE*X+A when
-         public void setTitle(final Translation title) {
+          * presented on screen. TODO not implemented yet
-                 this.title = title;
+          **/
-         }
+         protected Double functionX = 1.;
-         public Translation getDesc() {
+         /** The Name of the attribute **/
-                 return desc;
+         private Name name;
-         }
+         /**
-         public void setDesc(final Translation desc) {
+          * Allows to define general NODATA values for an attribute. e.g. -9999 can
-                 this.desc = desc;
+          * be set and will always be interpreted as NULL internally and will usually
-         }
+          * be ignored. This overcomes the problem, that
+          **/
-         public String getUnit() {
+         protected HashSet<Object> nodataValues = new HashSet<Object>();
-                 return unit;
-         }
+         /** Translation of the attribute's title **/
+         protected Translation title = new Translation();
-         public void setUnit(final String unit) {
-                 this.unit = unit;
+         /**
-         }
+          * The unit append to all visualizations of values of this attribute (is not
- }
+          * null)
+          **/
+         protected String unit = "";
+         /** Is the attribute visible to the user or ignored where possible **/
+         protected boolean visible = true;
+         /**
+          * When listed, the attributes are listed according to their {@link #weight}
+          * (heavier => further down)
+          *
+          * @see #compareTo(AttributeMetadata)
+          **/
+         protected int weight = 0;
+         /** Only used for {@link Copyable<AttributeMetaData>#copy()} **/
+         private AttributeMetadata() {
+         }
+         public AttributeMetadata(final AttributeDescriptor attDesc,
+                         final int weight, final List<String> langs) {
+                 this(attDesc.getName(), langs);
+                 setWeight(weight);
+         }
+         public AttributeMetadata(final AttributeDescriptor attDesc,
+                         final List<String> langs) {
+                 this(attDesc.getName(), langs);
+         }
+         /**
+          * 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;
+                 this.visible = visible;
+                 this.unit = unit;
+         }
+         /**
+          * 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 unit
+          *            {@link String} of the unit that the information is in
+          */
+         public AttributeMetadata(final Name name, final Boolean visible,
+                         final String unit) {
+                 this.setName(name);
+                 this.visible = visible;
+                 this.unit = unit;
+         }
+         /**
+          * Creates a new visible {@link AttributeMetadata}
+          */
+         public AttributeMetadata(final Name name, final List<String> langs) {
+                 this(name, true, new Translation(langs, name.getLocalPart()),
+                                 new Translation(), "");
+         }
+         /**
+          * Creates a new visible {@link AttributeMetadata}
+          */
+         public AttributeMetadata(final Name name, final String defaultTitle,
+                         final List<String> langs) {
+                 this(name, true, new Translation(langs, defaultTitle),
+                                 new Translation(), "");
+         }
+         /**
+          * 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 List<String> langs) {
+                 this(localName, true, new Translation(langs, localName),
+                                 new Translation(), "");
+         }
+         /**
+          * Creates a new visible {@link AttributeMetadata}
+          */
+         public AttributeMetadata(final String localName, final String defaultTitle,
+                         final List<String> langs) {
+                 this(localName, true, new Translation(langs, defaultTitle),
+                                 new Translation(), "");
+         }
+         /**
+          * Orders the attributes according to their {@link #weight}. Heavier =>
+          * further down.
+          */
+         @Override
+         public int compareTo(final AttributeMetadata atm2) {
+                 return new Integer(weight).compareTo(atm2.getWeight());
+         }
+         /**
+          * @see Copyable inferface
+          */
+         @Override
+         public AttributeMetadata copy() {
+                 return copyTo(new AttributeMetadata());
+         }
+         /**
+          * @see Copyable inferface
+          */
+         @Override
+         public AttributeMetadata copyTo(final AttributeMetadata amd) {
+                 getTitle().copyTo(amd.getTitle());
+                 getDesc().copyTo(amd.getDesc());
+                 amd.setUnit(getUnit());
+                 amd.setVisible(isVisible());
+                 amd.setName(new NameImpl(getName().getNamespaceURI(), getName()
+                                 .getLocalPart()));
+                 amd.setWeight(getWeight());
+                 amd.setFunctionX(getFunctionX());
+                 amd.setFunctionA(getFunctionA());
+                 amd.setNodataValues(getNodataValues());
+                 return amd;
+         }
+         // only to be used by copyTo()
+         private void setNodataValues(HashSet<Object> nodataValues2) {
+                 nodataValues = nodataValues2;
+         }
+         public Translation getDesc() {
+                 return desc;
+         }
+         public Double getFunctionA() {
+                 return functionA;
+         }
+         public Double getFunctionX() {
+                 return functionX;
+         }
+         /**
+          * The local name. E.g. the name of the DBF column as a {@link String}
+          */
+         public String getLocalName() {
+                 return getName().getLocalPart();
+         }
+         /**
+          * The fully qualified {@link Name} of the attribute, e.g.
+          * <code>org.bla.plo:blub</code>
+          */
+         public Name getName() {
+                 return name;
+         }
+         public HashSet<Object> getNodataValues() {
+                 return nodataValues;
+         }
+         /**
+          * @return a number between 0 (bad) and 1 (good) that is calculated from the
+          *         amount of translation available. If this attribute is not
+          *         {@link #visible}, it will return 1.
+          */
+         public double getQuality(final List<String> languages) {
+                 if (!isVisible())
+                         return 1.;
+                 return (I8NUtil.qmTranslation(languages, getTitle()) * 2. + I8NUtil
+                                 .qmTranslation(languages, getDesc()) * 1.) / 3.;
+         }
+         public Translation getTitle() {
+                 return title;
+         }
+         public String getUnit() {
+                 return unit;
+         }
+         public int getWeight() {
+                 return weight;
+         }
+         /**
+          * Will the end-user see this attribute?
+          */
+         public boolean isVisible() {
+                 return visible;
+         }
+         public void setDesc(final Translation desc) {
+                 this.desc = desc;
+         }
+         public void setFunctionA(final Double functionA) {
+                 this.functionA = functionA;
+         }
+         public void setFunctionX(final Double functionX) {
+                 this.functionX = functionX;
+         }
+         /**
+          * The fully qualified Name of the attribute, e.g. org.bla.plo:blub
+          */
+         public void setLocalName(final String localName) {
+                 this.name = new NameImpl(localName);
+         }
+         /**
+          * The fully qualified {@link Name} of the attribute, e.g.
+          * <code>org.bla.plo:blub</code>
+          */
+         public void setName(final Name name) {
+                 this.name = name;
+         }
+         public void addNodataValue(Object nodataValue) {
+                 this.nodataValues.add(nodataValue);
+         }
+         public void removeNodataValue(Object nodataValue) {
+                 this.nodataValues.remove(nodataValue);
+         }
+         public void setTitle(final Translation title) {
+                 this.title = title;
+         }
+         public void setUnit(final String unit) {
+                 this.unit = unit;
+         }
+         public void setVisible(final boolean visible) {
+                 this.visible = visible;
+         }
+         /**
+          * Shall the end-user see this attribute?
+          *
+          * @param visible
+          */
+         public void setVisible(final Boolean visible) {
+                 // // The THE_GEOM and shall never be visible!
+                 // if (name.getLocalPart().equalsIgnoreCase("the_geom"))
+                 // this.visible = false;
+                 // else
+                 // this.visible = visible;
+                 this.visible = visible;
+         }
+         public void setWeight(final int weight) {
+                 this.weight = weight;
+         }
+         /**
+          * For nicer debugging
+          */
+         @Override
+         public String toString() {
+                 StringBuffer sb = new StringBuffer();
+                 if (name != null)
+                         sb.append(name.toString() + " ");
+                 sb.append("weight=" + weight + " ");
+                 sb.append("title=" + getTitle().toString());
+                 return sb.toString();
+         }
+         /**
+          * 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(final Object value) {
+                 if (nodataValues.contains(value))
+                         return null;
+                 return value;
+         }
+         /**
+          * @return a nicely formatted String containing all NODATA values. Strings
+          *         are quoted fo that the empty String can be seen.
+          */
+         public String getNoDataValuesFormatted() {
+                 return formatNoDataValues(getNodataValues());
+         }
+         /**
+          * @return a nicely formatted String containing all NODATA values. Strings
+          *         are quoted fo that the empty String can be seen.
+          */
+         public static String formatNoDataValues(Set<Object> list) {
+                 String nicelyFormatted = "";
+                 if (list != null) {
+                         if (list.size() == 0)
+                                 nicelyFormatted = "";
+                         else {
+                                 for (Object ndo : list) {
+                                         if (ndo instanceof String)
+                                                 nicelyFormatted += "\"" + ndo + "\"";
+                                         else
+                                                 nicelyFormatted += ndo.toString();
+                                         nicelyFormatted += ",";
+                                 }
+                                 // Remove the extra comma
+                                 nicelyFormatted = nicelyFormatted.substring(0, nicelyFormatted
+                                                 .length() - 1);
+                         }
+                 }
+                 return nicelyFormatted;
+         }
+ }

 Legend:



Removed from v.2
 


changed lines


 
Added in v.681
 Legend:



Removed from v.2
 


changed lines


 
Added in v.681
-Removed from v.2
+Added in v.681

[email protected]	ViewVC Help
Powered by ViewVC 1.1.26