org.geotools.styling.ContrastMethodStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-main Show documentation

The main module contains the GeoTools public interfaces that are used by other GeoTools modules (and GeoTools applications). Where possible we make use industry standard terms as provided by OGC and ISO standards. The formal GeoTools public api consists of gt-metadata, jts and the gt-main module. The main module contains the default implementations that are available provided to other GeoTools modules using our factory system. Factories are obtained from an appropriate FactoryFinder, giving applications a chance configure the factory used using the Factory Hints facilities. FilterFactory ff = CommonFactoryFinder.getFilterFactory(); Expression expr = ff.add( expression1, expression2 ); If you find yourself using implementation specific classes chances are you doing it wrong: Expression expr = new AddImpl( expression1, expressiom2 );

The newest version!

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2015, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library 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;
 *    version 2.1 of the License.
 *
 *    This library 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
 *    Lesser General Public License for more details.
 */
package org.geotools.styling;

import java.util.Map;
import org.opengis.filter.expression.Expression;
import org.opengis.style.ContrastMethod;

/**
 * This interface defines the strategy that a ContrastEnhancement will use to execute the
 * ContrastMethod that it has defined. This allows uses to make use of VendorOptions in the SLD (&
 * CSS) to specify an algorithm to apply and named parameters to control how that algorithm
 * operates.
 *
 * @author Ian Turton.
 */
public interface ContrastMethodStrategy {
    /**
     * Add a VendorOption that controls how this strategy operates. All VendorOptions are optional
     * and the strategy will operate using default values if missing.
     *
     * @param key the name of the Vendor Option
     * @param value an expression that evaluates to the value of the option.
     */
    void addOption(String key, Expression value);

    /**
     * Return the Map of VendorOptions used by this strategy. This may be empty but should not be
     * null.
     *
     * @return the options a map of Expressions keyed by name.
     */
    Map getOptions();

    /**
     * Set the options map - do not set it to null;
     *
     * @param options the options to set
     */
    void setOptions(Map options);

    /**
     * Get the constant that defines the method that this strategy uses.
     *
     * @return the method
     */
    ContrastMethod getMethod();

    /**
     * Set the constant that defines the method that this strategy uses.
     *
     * @param method the method to set
     */
    void setMethod(ContrastMethod method);
}