Symbolizer (Groovy Documentation)

geoscript.style.Symbolizer

All Implemented Interfaces and Traits:: Style, java.lang.Cloneable

class Symbolizer
extends java.lang.Object
implements Style, java.lang.Cloneable

A Base class for all Symbolizers. All Symbolizers can have a Filter, min and max scales, and a z-index.

 Symbolizer sym = new Fill("white")
 sym.where(new Filter("name='Washington'"))
 sym.range(100, 500)
 sym.zindex(5)

Authors:: Jared Erickson

Field Summary

Fields
Modifiers	Name	Description
`protected static FilterFactory`	`filterFactory`	The GeoTools FilterFactory
`protected static StyleBuilder`	`styleBuilder`	The GeoTools StyleBuilder
`protected static StyleFactoryImpl`	`styleFactory`	The GeoTools StyleFactory
`protected Map`	`styleOptions`	A Map of FeatureTypeStyle options

Properties Summary

Properties
Type	Name and description
`Filter`	`filter` The Filter
`Map`	`options` A Map of Symbolizer options
`Symbolizer.Scale`	`scale` A List of min and max scales
`int`	`z` The z index

Constructor Summary

Constructors
Constructor and description
`Symbolizer ()` Create a new Symbolizer

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Composite`	`and(Symbolizer other)` Combine this Symbolizer with another.
	`protected void`	`apply(Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
	`void`	`asSLD(java.io.OutputStream out)` Write this Symbolizer to an SLD document
	`void`	`asSLD(java.io.File file)` Write this Symbolizer to a SLD File
	`protected java.lang.String`	`buildString(java.lang.String name, Map properties)` Build a string representation of the Symbolizer
	`Symbolizer`	`composite(Map params, java.lang.String composite)` Set composite (copy, destination, source-over, destination-over, source-in, destination-in, source-out, destination-out, source-atop, destination-atop, xor) or blending (multiply, screen, overlay, darken, lighten, color-dodge, color-burn, hard-light, soft-light, difference, exclusion)
	`protected static Symbolizer`	`createGeoToolsSymbolizer(java.lang.Class clazz)` Create a GeoTools Symbolizer of the given Class
	`static Symbolizer`	`getDefault(java.lang.String geometryType, java.lang.Object color)` Get a default Symbolizer for the given geometry type
	`static Symbolizer`	`getDefault(Map options, java.lang.String geometryType)` Get a default Symbolizer for the given geometry type.
	`protected static java.util.List<GtSymbolizer>`	`getGeoToolsSymbolizers(Rule rule, java.lang.Class clazz)` Get a List of GeoTools Symbolizers from the Rule of the given Class.
	`Style`	`getGtStyle()` Get the GeoTools Style from this Symbolizer
	`java.lang.String`	`getSld()` Get this Symbolizer as an SLD String
	`Composite`	`plus(Symbolizer other)` Combine this Symbolizer with another.
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer.
	`protected void`	`prepare(FeatureTypeStyle fts, Rule rule)` Prepare the GeoTools FeatureTypeStyle and Rule by applying this Symbolizer.
	`Symbolizer`	`range(double min, double max)` Apply min/max scale denominator
	`Symbolizer`	`range(Map minMax)` Apply min/max scale denominator using keywords.
	`Symbolizer`	`sortBy(java.util.List fields)` Set single layer z-ordering
	`Symbolizer`	`sortBy(java.lang.String group, java.util.List fields)` Set cross layer z-ordering
	`Symbolizer`	`where(java.lang.Object filter)` Apply a filter to the symbolizer.
	`Symbolizer`	`zindex(int z)` Apply a z-index.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected static FilterFactory filterFactory
    
    The GeoTools FilterFactory
  - protected static StyleBuilder styleBuilder
    
    The GeoTools StyleBuilder
  - protected static StyleFactoryImpl styleFactory
    
    The GeoTools StyleFactory
  - protected Map styleOptions
    
    A Map of FeatureTypeStyle options
- Property Detail
  - Filter filter
    
    The Filter
  - Map options
    
    A Map of Symbolizer options
  - Symbolizer.Scale scale
    
    A List of min and max scales
  - int z
    
    The z index
- Constructor Detail
  - Symbolizer()
    
    Create a new Symbolizer
- Method Detail
  - Composite and(Symbolizer other)
    
    Combine this Symbolizer with another.
    Parameters:
    other - The other Symbolizer
    Returns:
    A new Composite Symbolizer
  - protected void apply(Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - void asSLD(java.io.OutputStream out)
    
    Write this Symbolizer to an SLD document
    Parameters:
    out - The OutputStream
  - void asSLD(java.io.File file)
    
    Write this Symbolizer to a SLD File
    Parameters:
    file - The SLD File
  - protected java.lang.String buildString(java.lang.String name, Map properties)
    
    Build a string representation of the Symbolizer
    Parameters:
    name - The name of the Symbolizer (Fill, Hatch, Halo, ect...)
    properties - A Map of properties
    Returns:
    A String
  - Symbolizer composite(Map params, java.lang.String composite)
    
    Set composite (copy, destination, source-over, destination-over, source-in, destination-in, source-out, destination-out, source-atop, destination-atop, xor) or blending (multiply, screen, overlay, darken, lighten, color-dodge, color-burn, hard-light, soft-light, difference, exclusion)
    Parameters:
    params - The optional named parameters:
    
    opacity = The opacity value between 0 and 1. It defaults to 1.
    
    base = The flag that indicates whether this composite should be used as base or not. Defaults to false.
    
    symbolizer = The flag that indicates whether the composite should be applied to this symbolizer (true) or all grouped symbolizers / at the featuretype style (false). Defaults to true.
    composite - The composite of blending value
    Returns:
    The Symbolizer
  - protected static Symbolizer createGeoToolsSymbolizer(java.lang.Class clazz)
    
    Create a GeoTools Symbolizer of the given Class
    Parameters:
    clazz - The GeoTools Symbolizer Class
    Returns:
    A GeoTools Symbolizer or null
  - static Symbolizer getDefault(java.lang.String geometryType, java.lang.Object color)
    
    Get a default Symbolizer for the given geometry type
    Parameters:
    geometryType - The geometry type
    Returns:
    A Symbolizer
  - static Symbolizer getDefault(Map options, java.lang.String geometryType)
    
    Get a default Symbolizer for the given geometry type.
    Parameters:
    options - Optional named parameters:
    
    color = The Color (#f2f2f2)
    
    opacity = The opacity (1.0)
    
    size = The shape size (6)
    
    type = The shape type (circle)
    geometryType - The geometry type
    Returns:
    A Symbolizer
  - protected static java.util.List<GtSymbolizer> getGeoToolsSymbolizers(Rule rule, java.lang.Class clazz)
    
    Get a List of GeoTools Symbolizers from the Rule of the given Class. If no Symbolizers of the given Class exist in the Rule, one is created.
    Parameters:
    rule - The GeoTools Rule
    clazz - The GeoTools Symbolizer Class
    Returns:
    A List of GeoTools Symbolizers
  - Style getGtStyle()
    
    Get the GeoTools Style from this Symbolizer
    Returns:
    The GeoTools Style
  - java.lang.String getSld()
    
    Get this Symbolizer as an SLD String
    Returns:
    An SLD String
  - Composite plus(Symbolizer other)
    
    Combine this Symbolizer with another.
    Parameters:
    other - The other Symbolizer
    Returns:
    A new Composite Symbolizer
  - protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer.
    Parameters:
    rule - The GeoTools Rule
  - protected void prepare(FeatureTypeStyle fts, Rule rule)
    
    Prepare the GeoTools FeatureTypeStyle and Rule by applying this Symbolizer.
    Parameters:
    fts - The GeoTools FeatureTypeStyle
    rule - The GeoTools Rule
  - Symbolizer range(double min, double max)
    
    Apply min/max scale denominator
    Parameters:
    min - The min scale (defaults to -1)
    max - The max scale (defaults to -1)
    Returns:
    The Symbolizer
  - Symbolizer range(Map minMax)
    
    Apply min/max scale denominator using keywords.
```
 new Fill('black').range(min: '100', max: '2000')
 new Stroke('teal').range(min: '1000')
 
 
```
    Parameters:
    minMax - A Map of named parameters (min, max)
    Returns:
    The Symbolizer
  - Symbolizer sortBy(java.util.List fields)
    
    Set single layer z-ordering @return
    Parameters:
    fields - The List of Fields. The items in the List an be a Field, a Map with field and direction (A or D) keys, or just String with field name and direction.
  - Symbolizer sortBy(java.lang.String group, java.util.List fields)
    
    Set cross layer z-ordering
    Parameters:
    group - The group name
    fields - The List of Fields. The items in the List an be a Field, a Map with field and direction (A or D) keys, or just String with field name and direction.
    Returns:
    This Symbolizer
  - Symbolizer where(java.lang.Object filter)
    
    Apply a filter to the symbolizer. The Filter can be a CQL string or a geoScript.filter.Filter
    Parameters:
    filter - A CQL String or a Filter
    Returns:
    The Symbolizer
  - Symbolizer zindex(int z)
    
    Apply a z-index. Symbolizers with higher z-index are drawn on the top of those with smaller z-index
    Parameters:
    z - The z-index
    Returns:
    The Symbolizer

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Symbolizer

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static FilterFactory filterFactory

protected static StyleBuilder styleBuilder

protected static StyleFactoryImpl styleFactory

protected Map styleOptions

Property Detail

Filter filter

Map options

Symbolizer.Scale scale

int z

Constructor Detail

Symbolizer()

Method Detail

Composite and(Symbolizer other)

protected void apply(Symbolizer sym)

void asSLD(java.io.OutputStream out)

void asSLD(java.io.File file)

protected java.lang.String buildString(java.lang.String name, Map properties)

Symbolizer composite(Map params, java.lang.String composite)

protected static Symbolizer createGeoToolsSymbolizer(java.lang.Class clazz)

static Symbolizer getDefault(java.lang.String geometryType, java.lang.Object color)

static Symbolizer getDefault(Map options, java.lang.String geometryType)

protected static java.util.List<GtSymbolizer> getGeoToolsSymbolizers(Rule rule, java.lang.Class clazz)

Style getGtStyle()

java.lang.String getSld()

Composite plus(Symbolizer other)

protected void prepare(Rule rule)

protected void prepare(FeatureTypeStyle fts, Rule rule)

Symbolizer range(double min, double max)

Symbolizer range(Map minMax)

Symbolizer sortBy(java.util.List fields)

Symbolizer sortBy(java.lang.String group, java.util.List fields)

Symbolizer where(java.lang.Object filter)

Symbolizer zindex(int z)