Package org.geotools.api.style
Interface ContrastMethodStrategy
-
- All Known Implementing Classes:
AbstractContrastMethodStrategy
,ExponentialContrastMethodStrategy
,HistogramContrastMethodStrategy
,LogarithmicContrastMethodStrategy
,NormalizeContrastMethodStrategy
public interface ContrastMethodStrategy
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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addOption(String key, Expression value)
Add a VendorOption that controls how this strategy operates.ContrastMethod
getMethod()
Get the constant that defines the method that this strategy uses.Map<String,Expression>
getOptions()
Return the Map of VendorOptions used by this strategy.void
setMethod(ContrastMethod method)
Set the constant that defines the method that this strategy uses.void
setOptions(Map<String,Expression> options)
Set the options map - do not set it to null;
-
-
-
Method Detail
-
addOption
void addOption(String key, Expression value)
Add a VendorOption that controls how this strategy operates. All VendorOptions are optional and the strategy will operate using default values if missing.- Parameters:
key
- the name of the Vendor Optionvalue
- an expression that evaluates to the value of the option.
-
getOptions
Map<String,Expression> getOptions()
Return the Map of VendorOptions used by this strategy. This may be empty but should not be null.- Returns:
- the options a map of Expressions keyed by name.
-
setOptions
void setOptions(Map<String,Expression> options)
Set the options map - do not set it to null;- Parameters:
options
- the options to set
-
getMethod
ContrastMethod getMethod()
Get the constant that defines the method that this strategy uses.- Returns:
- the method
-
setMethod
void setMethod(ContrastMethod method)
Set the constant that defines the method that this strategy uses.- Parameters:
method
- the method to set
-
-