src/skrueger/RasterLegendData.java

/*******************************************************************************
 * 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.Arrays;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.apache.log4j.Logger;
import org.geotools.coverage.grid.GridCoverage2D;
import org.geotools.geometry.Envelope2D;
import org.geotools.renderer.lite.gridcoverage2d.GridCoverageRenderer;

import schmitzm.geotools.GTUtil;
import schmitzm.geotools.grid.GridUtil;
import skrueger.geotools.Copyable;
import skrueger.i8n.Translation;

/**
 * Holds all the additional information needed to paint a Legend for a RasterLayer.
 * So far, only Legends for one-band raster layers are supported.
 *
 * @author <a href="mailto:[email protected]">Stefan Alfons Kr&uuml;ger</a>
 *
 * TODO implements {@link Copyable}
 */
public class RasterLegendData extends HashMap<Double, Translation> {
        static private final Logger LOGGER = Logger.getLogger(RasterLegendData.class);
        private Boolean paintGaps = false;

        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;
        }

        public boolean getPaintGaps() {
                return paintGaps ;
        }

        public List<Double> getSortedKeys(){
                Object[] array = keySet().toArray();

                Arrays.sort(array);

                final LinkedList<Double> linkedList = new LinkedList<Double>();
                for (Object o : array){
                        linkedList.add( (Double)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;
    }
}
1	alfonx	244	/*******************************************************************************
2			* Copyright (c) 2009 Martin O. J. Schmitz.
3			*
4			* This file is part of the SCHMITZM library - a collection of utility
5	alfonx	256	* classes based on Java 1.6, focusing (not only) on Java Swing
6	alfonx	244	* and the Geotools library.
7			*
8			* The SCHMITZM project is hosted at:
9			* http://wald.intevation.org/projects/schmitzm/
10			*
11			* This program is free software; you can redistribute it and/or
12			* modify it under the terms of the GNU Lesser General Public License
13			* as published by the Free Software Foundation; either version 3
14			* of the License, or (at your option) any later version.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU General Public License for more details.
20			*
21			* 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			* or try this link: http://www.gnu.org/licenses/lgpl.html
25			*
26			* Contributors:
27			* Martin O. J. Schmitz - initial API and implementation
28			* Stefan A. Krüger - additional utility classes
29			******************************************************************************/
30			package skrueger;
31			import java.util.Arrays;
32			import java.util.HashMap;
33			import java.util.LinkedList;
34			import java.util.List;
35	mojays	395	import java.util.Map;
36	alfonx	244
37			import org.apache.log4j.Logger;
38	mojays	395	import org.geotools.coverage.grid.GridCoverage2D;
39			import org.geotools.geometry.Envelope2D;
40			import org.geotools.renderer.lite.gridcoverage2d.GridCoverageRenderer;
41	alfonx	244
42	mojays	395	import schmitzm.geotools.GTUtil;
43			import schmitzm.geotools.grid.GridUtil;
44	alfonx	514	import skrueger.geotools.Copyable;
45	alfonx	244	import skrueger.i8n.Translation;
46
47			/**
48			* Holds all the additional information needed to paint a Legend for a RasterLayer.
49			* So far, only Legends for one-band raster layers are supported.
50			*
51			* @author <a href="mailto:[email protected]">Stefan Alfons Krüger</a>
52			*
53	alfonx	514	* TODO implements {@link Copyable}
54	alfonx	244	*/
55	mojays	399	public class RasterLegendData extends HashMap<Double, Translation> {
56	alfonx	244	static private final Logger LOGGER = Logger.getLogger(RasterLegendData.class);
57			private Boolean paintGaps = false;
58
59			public Boolean isPaintGaps() {
60			return paintGaps;
61			}
62
63			public void setPaintGaps(boolean paintPaps) {
64			this.paintGaps = paintPaps;
65			}
66
67			/**
68			* {@link #paintGaps} defines, if gaps should be painted between the legends colors,
69			* indicating nominal values in the raster (e.g. classifications)
70			*/
71			public RasterLegendData(boolean paintGaps) {
72			this.paintGaps = paintGaps;
73			}
74
75			public boolean getPaintGaps() {
76			return paintGaps ;
77			}
78
79	mojays	399	public List<Double> getSortedKeys(){
80			Object[] array = keySet().toArray();
81	alfonx	244
82	mojays	399	Arrays.sort(array);
83
84			final LinkedList<Double> linkedList = new LinkedList<Double>();
85			for (Object o : array){
86			linkedList.add( (Double)o);
87			}
88
89			return linkedList;
90
91			}
92
93	mojays	395	/**
94			* Creates a sample {@link GridCoverage2D} (size 1x1, WGS84) for each
95			* legend value. These rasters can be used to do visualize the
96			* legend item in the corresponding color via {@link GridCoverageRenderer}.
97			*/
98	mojays	399	public Map<Double, GridCoverage2D> createSampleRasters() {
99			Map<Double, GridCoverage2D> sampleRaster = new HashMap<Double, GridCoverage2D>();
100	mojays	395
101			for (Double rasterValue : keySet()) {
102			GridCoverage2D grid = GridUtil.GRID_FAC.create(
103			"Legend_"+rasterValue,
104			new float[][] { { rasterValue.floatValue() } },
105			new Envelope2D(GTUtil.WGS84, 0,0,1,1)
106			);
107			sampleRaster.put(rasterValue, grid);
108			}
109
110
111			return sampleRaster;
112			}
113	alfonx	244	}