skrueger/geotools/StyledLayerStyle.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.geotools;

import org.geotools.styling.Style;

/**
 * This class combines a Geotools visualisation {@link Style} with additional
 * meta data needed for visualisation (for example legend data).
 * The class {@code E} defines the type of the meta data.
 * @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
 * @version 1.0
 */
public class StyledLayerStyle<E> {
  /** Holds the Geotools {@link Style} for the geo object visualisation. */
  protected Style geoObjectStyle = null;
  /** Holds the additional meta data for object visualisation (for example
   *  legend information). */
  protected E metaData = null;

  /**
   * Creates a new style for a {@link StyledLayerInterface}.
   * @param style Style
   * @param metaData E
   */
  public StyledLayerStyle(Style style, E metaData) {
    setGeoObjectStyle(style);
    setMetaData(metaData);
  }

  /**
   * Returns the additional meta data needed for object visualisation.
   */
  public E getMetaData() {
    return metaData;
  }

  /**
   * Sets the additional meta data needed for object visualisation.
   * @param metaData the meta data
   */
  public void setMetaData(E metaData) {
    this.metaData = metaData;
  }

  /**
   * Returns the Geotools style for the object visualisation.
   */
  public Style getGeoObjectStyle() {
    return geoObjectStyle;
  }

  /**
   * Sets the Geotools style for the object visualisation.
   * @param style a Geotools visualisation style
   */
  public void setGeoObjectStyle(Style style) {
    this.geoObjectStyle = style;
  }
}
1	/*******************************************************************************
2	* Copyright (c) 2009 Martin O. J. Schmitz.
3	*
4	* This file is part of the SCHMITZM library - a collection of utility
5	* classes based on Java 1.6, focusing (not only) on Java Swing
6	* 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.geotools;
31
32	import org.geotools.styling.Style;
33
34	/**
35	* This class combines a Geotools visualisation {@link Style} with additional
36	* meta data needed for visualisation (for example legend data).
37	* The class {@code E} defines the type of the meta data.
38	* @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
39	* @version 1.0
40	*/
41	public class StyledLayerStyle<E> {
42	/** Holds the Geotools {@link Style} for the geo object visualisation. */
43	protected Style geoObjectStyle = null;
44	/** Holds the additional meta data for object visualisation (for example
45	* legend information). */
46	protected E metaData = null;
47
48	/**
49	* Creates a new style for a {@link StyledLayerInterface}.
50	* @param style Style
51	* @param metaData E
52	*/
53	public StyledLayerStyle(Style style, E metaData) {
54	setGeoObjectStyle(style);
55	setMetaData(metaData);
56	}
57
58	/**
59	* Returns the additional meta data needed for object visualisation.
60	*/
61	public E getMetaData() {
62	return metaData;
63	}
64
65	/**
66	* Sets the additional meta data needed for object visualisation.
67	* @param metaData the meta data
68	*/
69	public void setMetaData(E metaData) {
70	this.metaData = metaData;
71	}
72
73	/**
74	* Returns the Geotools style for the object visualisation.
75	*/
76	public Style getGeoObjectStyle() {
77	return geoObjectStyle;
78	}
79
80	/**
81	* Sets the Geotools style for the object visualisation.
82	* @param style a Geotools visualisation style
83	*/
84	public void setGeoObjectStyle(Style style) {
85	this.geoObjectStyle = style;
86	}
87	}