001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2008-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.style;
033    
034    import org.opengis.annotation.Extension;
035    import org.opengis.annotation.XmlElement;
036    import org.opengis.filter.expression.Function;
037    
038    
039    /**
040     * <p>The ColorMap element defines the mapping of palette-type raster colors or fixed-
041     * numeric pixel values to colors using an Interpolate or Categorize SE function
042     * </p>
043     * <p>
044     * For example, a DEM raster giving elevations in meters above sea level can be
045     * translated to a colored  image with a ColorMap.  The quantity attributes of
046     * a color-map are used for translating between numeric  matrixes and color
047     * rasters and the ColorMap entries should be in order of increasing numeric
048     * quantity so  that intermediate numeric values can be matched to a color (or
049     * be interpolated between two colors).   Labels may be used for legends or
050     * may be used in the future to match character values.   Not all systems can
051     * support opacity in colormaps.  The default opacity is 1.0 (fully opaque).
052     * Defaults for quantity and label are system-dependent.
053     * </p>
054     * @version <A HREF="http://www.opengeospatial.org/standards/symbol">Symbology Encoding Implementation Specification 1.1.0</A>
055     * @author Open Geospatial Consortium
056     * @author Johann Sorel (Geomatys)
057     * @since GeoAPI 2.2
058     */
059    @XmlElement("ColorMap")
060    public interface ColorMap {
061    
062        /**
063         *
064         * @return Interpolate or Categorize function
065         */
066        Function getFunction();
067    
068        /**
069         * calls the visit method of a StyleVisitor
070         *
071         * @param visitor the style visitor
072         */
073        @Extension
074        Object accept(StyleVisitor visitor, Object extraData);
075        
076    }