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

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

Parent Directory | Revision Log | View Patch Patch

-revision 2 by mojays,
Tue Feb 24 22:43:52 2009 UTC
+revision 685 by alfonx,
Wed Feb 10 15:04:02 2010 UTC
 Line 1
- package skrueger;
+ /*******************************************************************************
- import java.util.Arrays;
+  * Copyright (c) 2009 Martin O. J. Schmitz.
- import java.util.HashMap;
+  *
- import java.util.LinkedList;
+  * This file is part of the SCHMITZM library - a collection of utility
- import java.util.List;
+  * classes based on Java 1.6, focusing (not only) on Java Swing
+  * and the Geotools library.
- import org.apache.log4j.Logger;
+  *
+  * The SCHMITZM project is hosted at:
- import skrueger.i8n.Translation;
+  * http://wald.intevation.org/projects/schmitzm/
+  *
- /**
+  * This program is free software; you can redistribute it and/or
-  * Holds all the additional information needed to paint a Legend for a RasterLayer.
+  * modify it under the terms of the GNU Lesser General Public License
-  * So far, only Legends for one-band raster layers are supported.
+  * as published by the Free Software Foundation; either version 3
-  *
+  * of the License, or (at your option) any later version.
-  * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
+  *
-  *
+  * This program is distributed in the hope that it will be useful,
-  */
+  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- public class RasterLegendData extends HashMap<Double, Translation> {
+  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-         static private final Logger LOGGER = Logger.getLogger(RasterLegendData.class);
+  * GNU General Public License for more details.
-         private Boolean paintGaps = false;
+  *
+  * You should have received a copy of the GNU Lesser General Public License (license.txt)
-         public Boolean isPaintGaps() {
+  * along with this program; if not, write to the Free Software
-                 return paintGaps;
+  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-         }
+  * or try this link: http://www.gnu.org/licenses/lgpl.html
+  *
-         public void setPaintGaps(boolean paintPaps) {
+  * Contributors:
-                 this.paintGaps = paintPaps;
+  *     Martin O. J. Schmitz - initial API and implementation
-         }
+  *     Stefan A. Krüger - additional utility classes
+  ******************************************************************************/
-         /**
+ package skrueger;
-          * {@link #paintGaps} defines, if gaps should be painted between the legends colors,
-          * indicating nominal values in the raster (e.g. classifications)
+ import java.util.Arrays;
-          */
+ import java.util.HashMap;
-         public RasterLegendData(boolean paintGaps) {
+ import java.util.LinkedList;
-                 super();
+ import java.util.List;
-                 this.paintGaps = paintGaps;
+ import java.util.Map;
-         }
+ import java.util.TreeMap;
-         public boolean getPaintGaps() {
+ import org.apache.log4j.Logger;
-                 return paintGaps ;
+ import org.geotools.coverage.grid.GridCoverage2D;
-         }
+ import org.geotools.geometry.Envelope2D;
+ import org.geotools.renderer.lite.gridcoverage2d.GridCoverageRenderer;
-         public List<Double> getSortedKeys(){
-                 Object[] array = keySet().toArray();
+ import schmitzm.geotools.GTUtil;
+ import schmitzm.geotools.grid.GridUtil;
-                 Arrays.sort(array);
+ import skrueger.geotools.Copyable;
+ import skrueger.i8n.Translation;
-                 final LinkedList<Double> linkedList = new LinkedList<Double>();
-                 for (Object o : array){
+ /**
-                         linkedList.add( (Double)o);
+  * Holds all the additional information needed to paint a Legend for a
-                 }
+  * RasterLayer. So far, only Legends for one-band raster layers are supported.
+  *
-                 return linkedList;
+  * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
+  *
-         }
+  *         TODO implements {@link Copyable}
- }
+  */
+ public class RasterLegendData extends TreeMap<Double, Translation> implements
+                 Copyable<RasterLegendData> {
+         static private final Logger LOGGER = Logger
+                         .getLogger(RasterLegendData.class);
+         private Boolean paintGaps = false;
+         /**
+          * Shall bigger gaps be painted between the raster images
+          */
+         public Boolean isPaintGaps() {
+                 return paintGaps;
+         }
+         public void setPaintGaps(boolean paintPaps) {
+                 this.paintGaps = paintPaps;
+         }
+         /**
+          * {@link #paintGaps} defines, if gaps should be painted between the legends
+          * colors, indicating nominal values in the raster (e.g. classifications)
+          */
+         public RasterLegendData(boolean paintGaps) {
+                 this.paintGaps = paintGaps;
+         }
+         /**
+          * Returns a new list containing all {@link Double} values that shall apear
+          * in the legend.
+          */
+         public List<Double> getSortedKeys() {
+                 Double[] array = keySet().toArray(new Double[] {});
+                 Arrays.sort(array);
+                 final LinkedList<Double> linkedList = new LinkedList<Double>();
+                 for (Double o : array) {
+                         linkedList.add(o);
+                 }
+                 return linkedList;
+         }
+         /**
+          * Creates a sample {@link GridCoverage2D} (size 1x1, WGS84) for each legend
+          * value. These rasters can be used to do visualize the legend item in the
+          * corresponding color via {@link GridCoverageRenderer}.
+          */
+         public Map<Double, GridCoverage2D> createSampleRasters() {
+                 Map<Double, GridCoverage2D> sampleRaster = new HashMap<Double, GridCoverage2D>();
+                 for (Double rasterValue : keySet()) {
+                         GridCoverage2D grid = GridUtil.GRID_FAC.create("Legend_"
+                                         + rasterValue,
+                                         new float[][] { { rasterValue.floatValue() } },
+                                         new Envelope2D(GTUtil.WGS84, 0, 0, 1, 1));
+                         sampleRaster.put(rasterValue, grid);
+                 }
+                 return sampleRaster;
+         }
+         /**
+          * Creates a new {@link RasterLegendData} object with identical values
+          */
+         @Override
+         public RasterLegendData copy() {
+                 RasterLegendData copy = (RasterLegendData) super.clone();
+                 return copyTo(copy);
+         }
+         /**
+          * Deep-copies all values of this {@link RasterLegendData} to another
+          * {@link RasterLegendData}
+          */
+         @Override
+         public RasterLegendData copyTo(RasterLegendData target) {
+                 target.clear();
+                 target.setPaintGaps(isPaintGaps());
+                 for (Double o : keySet()) {
+                         target.put(new Double(o), get(o).copy());
+                 }
+                 return target;
+         }
+ }

 Legend:



Removed from v.2
 


changed lines


 
Added in v.685
 Legend:



Removed from v.2
 


changed lines


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

[email protected]	ViewVC Help
Powered by ViewVC 1.1.26