org.opengis.style
Interface StyleFactory

All Known Subinterfaces:
StyleFactory, StyleFactory2
All Known Implementing Classes:
AbstractStyleFactory, StyleFactoryImpl, StyleFactoryImpl2

public interface StyleFactory

Factory used in the production of style objects.

This factory is responsible for the production of style objects; where noted these create methods are in agreement with the Symbology Encoding 1.1 specification.

Since:
GeoAPI 2.2
Author:
Open Geospatial Consortium, Johann Sorel (Geomatys)

Method Summary
 AnchorPoint anchorPoint(Expression x, Expression y)
           
 ChannelSelection channelSelection(SelectedChannelType gray)
           
 ChannelSelection channelSelection(SelectedChannelType red, SelectedChannelType green, SelectedChannelType blue)
           
 ColorMap colorMap(Expression propertyName, Expression... mapping)
          Wrap up a "Categorize" function using the provided expressions.
 ColorReplacement colorReplacement(Expression propertyName, Expression... mapping)
          Wrap up a replacement function using the provided expressions.
 ContrastEnhancement contrastEnhancement(Expression gamma, ContrastMethod method)
           
 Description description(InternationalString title, InternationalString description)
           
 Displacement displacement(Expression dx, Expression dy)
          Create Displacement
 ExtensionSymbolizer extensionSymbolizer(String name, String geometry, Description description, Unit<?> unit, String extensionName, Map<String,Expression> parameters)
          Used to represent a symbolizer intended for a vendor specific rendering process.
 ExternalGraphic externalGraphic(Icon inline, Collection<ColorReplacement> replacements)
          Create ExternalGraphic using a Java Icon.
 ExternalGraphic externalGraphic(OnLineResource resource, String format, Collection<ColorReplacement> replacements)
          Create externalGraphic
 ExternalMark externalMark(Icon inline)
           
 ExternalMark externalMark(OnLineResource resource, String format, int markIndex)
           
 FeatureTypeStyle featureTypeStyle(String name, Description description, Id definedFor, Set<Name> featureTypeNames, Set<SemanticType> types, List<Rule> rules)
           
 Fill fill(GraphicFill fill, Expression color, Expression opacity)
          Create fill.
 Font font(List<Expression> family, Expression style, Expression weight, Expression size)
          Create font entry; note this captures a list of font families in the preferred order, with the rendering engine choosing the first entry in the list available to the runtime environment.
 Graphic graphic(List<GraphicalSymbol> symbols, Expression opacity, Expression size, Expression rotation, AnchorPoint anchor, Displacement disp)
          Create a graphic.
 GraphicFill graphicFill(List<GraphicalSymbol> symbols, Expression opacity, Expression size, Expression rotation, AnchorPoint anchorPoint, Displacement displacement)
           
 GraphicLegend graphicLegend(List<GraphicalSymbol> symbols, Expression opacity, Expression size, Expression rotation, AnchorPoint anchorPoint, Displacement displacement)
           
 GraphicStroke graphicStroke(List<GraphicalSymbol> symbols, Expression opacity, Expression size, Expression rotation, AnchorPoint anchorPoint, Displacement displacement, Expression initialGap, Expression gap)
           
 Halo halo(Fill fill, Expression radius)
           
 LinePlacement linePlacement(Expression offset, Expression initialGap, Expression gap, boolean repeated, boolean aligned, boolean generalizedLine)
           
 LineSymbolizer lineSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Stroke stroke, Expression offset)
           
 Mark mark(Expression wellKnownName, Fill fill, Stroke stroke)
           
 Mark mark(ExternalMark externalMark, Fill fill, Stroke stroke)
           
 PointPlacement pointPlacement(AnchorPoint anchor, Displacement displacement, Expression rotation)
           
 PointSymbolizer pointSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Graphic graphic)
          Creation of a PointSymbolizer to describe how geometry can be rendered as a point.
 PolygonSymbolizer polygonSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Stroke stroke, Fill fill, Displacement displacement, Expression offset)
           
 RasterSymbolizer rasterSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Expression opacity, ChannelSelection channelSelection, OverlapBehavior overlapsBehaviour, ColorMap colorMap, ContrastEnhancement contrast, ShadedRelief shaded, Symbolizer outline)
           
 Rule rule(String name, Description description, GraphicLegend legend, double min, double max, List<Symbolizer> symbolizers, Filter filter)
          Create a rule from the provided definition.
 SelectedChannelType selectedChannelType(String channelName, ContrastEnhancement contrastEnhancement)
           
 ShadedRelief shadedRelief(Expression reliefFactor, boolean brightnessOnly)
           
 Stroke stroke(Expression color, Expression opacity, Expression width, Expression join, Expression cap, float[] dashes, Expression offset)
           
 Stroke stroke(GraphicFill fill, Expression color, Expression opacity, Expression width, Expression join, Expression cap, float[] dashes, Expression offset)
           
 Stroke stroke(GraphicStroke stroke, Expression color, Expression opacity, Expression width, Expression join, Expression cap, float[] dashes, Expression offset)
           
 Style style(String name, Description description, boolean isDefault, List<FeatureTypeStyle> featureTypeStyles, Symbolizer defaultSymbolizer)
           
 TextSymbolizer textSymbolizer(String name, Expression geometry, Description description, Unit<?> unit, Expression label, Font font, LabelPlacement placement, Halo halo, Fill fill)
          Creation of a TextSymbolizer defining how labels are portrayed.
 

Method Detail

anchorPoint

AnchorPoint anchorPoint(Expression x,
                        Expression y)
Parameters:
x -
y -
Returns:

channelSelection

ChannelSelection channelSelection(SelectedChannelType gray)
Parameters:
gray -
Returns:

channelSelection

ChannelSelection channelSelection(SelectedChannelType red,
                                  SelectedChannelType green,
                                  SelectedChannelType blue)
Parameters:
red -
green -
blue -
Returns:

colorMap

ColorMap colorMap(Expression propertyName,
                  Expression... mapping)
Wrap up a "Categorize" function using the provided expressions.

The function will be created based on:

  1. PropertyName; use "Rasterdata" to indicate this is a color map
  2. Literal: lookup value
  3. Literal: threshold 1
  4. Literal: value 1
  5. Literal: threshold 2
  6. Literal: value 2
  7. Literal: (Optional) succeeding or preceding

Parameters:
propertyName - Property name to categorize, or use "Raster"
mapping - Defined as a series of Expressions
Returns:
ColorMap wrapped around the "Cateogize" function

colorReplacement

ColorReplacement colorReplacement(Expression propertyName,
                                  Expression... mapping)
Wrap up a replacement function using the provided expressions.

Parameters:
propertyName - Property name to categorize, or use "Raster"
mapping - Defined as a series of Expressions
Returns:
ColorReplacement wrapped around a Function

contrastEnhancement

ContrastEnhancement contrastEnhancement(Expression gamma,
                                        ContrastMethod method)
Parameters:
gamma -
method -
Returns:

description

Description description(InternationalString title,
                        InternationalString description)
Parameters:
title -
description -
Returns:

displacement

Displacement displacement(Expression dx,
                          Expression dy)
Create Displacement

Parameters:
dx -
dy -
Returns:

externalGraphic

ExternalGraphic externalGraphic(OnLineResource resource,
                                String format,
                                Collection<ColorReplacement> replacements)
Create externalGraphic

Parameters:
resource -
format -
replacements -
Returns:

externalGraphic

ExternalGraphic externalGraphic(Icon inline,
                                Collection<ColorReplacement> replacements)
Create ExternalGraphic using a Java Icon.

This is used to produce high quality output by allowing you to directly draw each symbol by supplying your own Icon implementation.

Parameters:
inline -
replacements -
Returns:

externalMark

ExternalMark externalMark(OnLineResource resource,
                          String format,
                          int markIndex)
Parameters:
resource -
format -
markIndex -
Returns:

externalMark

ExternalMark externalMark(Icon inline)
Parameters:
inline -
Returns:

featureTypeStyle

FeatureTypeStyle featureTypeStyle(String name,
                                  Description description,
                                  Id definedFor,
                                  Set<Name> featureTypeNames,
                                  Set<SemanticType> types,
                                  List<Rule> rules)
Parameters:
name -
description -
definedFor -
featureTypeNames -
types -
rules - May not be null or empty
Returns:

fill

Fill fill(GraphicFill fill,
          Expression color,
          Expression opacity)
Create fill.

Parameters:
fill -
color -
opacity -
Returns:

font

Font font(List<Expression> family,
          Expression style,
          Expression weight,
          Expression size)
Create font entry; note this captures a list of font families in the preferred order, with the rendering engine choosing the first entry in the list available to the runtime environment.

If fonts are not showing up as you expect please review the list of fonts installed into your JRE.

Parameters:
family -
style -
weight -
size -
Returns:
Font

graphic

Graphic graphic(List<GraphicalSymbol> symbols,
                Expression opacity,
                Expression size,
                Expression rotation,
                AnchorPoint anchor,
                Displacement disp)
Create a graphic.

Parameters:
symbols -
opacity -
size -
rotation -
anchor -
disp -
Returns:

graphicFill

GraphicFill graphicFill(List<GraphicalSymbol> symbols,
                        Expression opacity,
                        Expression size,
                        Expression rotation,
                        AnchorPoint anchorPoint,
                        Displacement displacement)
Parameters:
symbols -
opacity -
size -
anchorPoint -
displacement -
Returns:

graphicLegend

GraphicLegend graphicLegend(List<GraphicalSymbol> symbols,
                            Expression opacity,
                            Expression size,
                            Expression rotation,
                            AnchorPoint anchorPoint,
                            Displacement displacement)
Parameters:
symbols -
opacity -
size -
anchorPoint -
displacement -
Returns:

graphicStroke

GraphicStroke graphicStroke(List<GraphicalSymbol> symbols,
                            Expression opacity,
                            Expression size,
                            Expression rotation,
                            AnchorPoint anchorPoint,
                            Displacement displacement,
                            Expression initialGap,
                            Expression gap)
Parameters:
symbols -
opacity -
size -
anchorPoint -
displacement -
initialGap -
gap -
Returns:

halo

Halo halo(Fill fill,
          Expression radius)
Parameters:
fill -
radius -
Returns:

linePlacement

LinePlacement linePlacement(Expression offset,
                            Expression initialGap,
                            Expression gap,
                            boolean repeated,
                            boolean aligned,
                            boolean generalizedLine)
Parameters:
offset -
initialGap -
gap -
repeated -
aligned -
generalizedLine -
Returns:

lineSymbolizer

LineSymbolizer lineSymbolizer(String name,
                              Expression geometry,
                              Description description,
                              Unit<?> unit,
                              Stroke stroke,
                              Expression offset)
Parameters:
name - handle used to refer to this symbolizer (machine readible)
geometry - Expression used to produce the Geometry to renderer; often a PropertyName
description -
unit - Unit of measure used to define this symbolizer
stroke - Definition of how to stroke linework
offset - Offset used to position line relative to origional
Returns:
Newly created Line Symbolizer

mark

Mark mark(Expression wellKnownName,
          Fill fill,
          Stroke stroke)
Parameters:
wellKnownName -
fill -
stroke -
Returns:

mark

Mark mark(ExternalMark externalMark,
          Fill fill,
          Stroke stroke)
Parameters:
externalMark -
fill -
stroke -
Returns:

pointPlacement

PointPlacement pointPlacement(AnchorPoint anchor,
                              Displacement displacement,
                              Expression rotation)
Parameters:
anchor -
displacement -
rotation -
Returns:

pointSymbolizer

PointSymbolizer pointSymbolizer(String name,
                                Expression geometry,
                                Description description,
                                Unit<?> unit,
                                Graphic graphic)
Creation of a PointSymbolizer to describe how geometry can be rendered as a point.

Parameters:
name - handle used to refer to this symbolizer (machine readable)
geometry - Expression used to extract the Geometry rendered; usually a PropertyName
description - Human readable description of symboizer
unit - Unit of Measure used to interpret symbolizer distances
graphic - Graphic used to represent the geometry when rendering
Returns:
Newly created PointSymbolizer

polygonSymbolizer

PolygonSymbolizer polygonSymbolizer(String name,
                                    Expression geometry,
                                    Description description,
                                    Unit<?> unit,
                                    Stroke stroke,
                                    Fill fill,
                                    Displacement displacement,
                                    Expression offset)
Parameters:
name - handle used to refer to this symbolizer (machine readable)
geometry - Expression used to extract the Geometry rendered; usually a PropertyName
description - Human readable description of symboizer
unit - Unit of Measure used to interpret symbolizer distances
stroke -
fill -
displacement -
offset -
Returns:

rasterSymbolizer

RasterSymbolizer rasterSymbolizer(String name,
                                  Expression geometry,
                                  Description description,
                                  Unit<?> unit,
                                  Expression opacity,
                                  ChannelSelection channelSelection,
                                  OverlapBehavior overlapsBehaviour,
                                  ColorMap colorMap,
                                  ContrastEnhancement contrast,
                                  ShadedRelief shaded,
                                  Symbolizer outline)
Parameters:
name - handle used to refer to this symbolizer (machine readable)
geometry - Expression used to extract the Geometry rendered; usually a PropertyName
description - Human readable description of symboizer
unit - Unit of Measure used to interpret symbolizer distances
opacity -
channelSelection -
overlapsBehaviour -
colorMap -
contrast -
shaded -
outline -
Returns:
RasterSymbolizer

extensionSymbolizer

ExtensionSymbolizer extensionSymbolizer(String name,
                                        String geometry,
                                        Description description,
                                        Unit<?> unit,
                                        String extensionName,
                                        Map<String,Expression> parameters)
Used to represent a symbolizer intended for a vendor specific rendering process. This facility should be used to control subject matter that is beyond the scope of the traditional symbology encoding data structure (subject matter like wind barbs or extra deegrees of freedom like temporal symbolizers are good examples of the use of this facility).

Parameters:
name - handle used to refer to this symbolizer (machine readible)
geometry - Geometry expression to renderer; formally a PropertyName
description - Description of this symbolizer; human readable
unit - Unit of measure to use when interpretting this symbolizer
extensionName - Extension name used to identify the vendor specific extension being controlled
parameters - Named expressions used to configure the vendor specific rendering process
Returns:
newly created ExtensionSymbolizer

rule

Rule rule(String name,
          Description description,
          GraphicLegend legend,
          double min,
          double max,
          List<Symbolizer> symbolizers,
          Filter filter)
Create a rule from the provided definition.

Parameters:
name - handle used to refer to this rule (machine readable)
description - Human readable description of this rule
legend - Graphic used to indicate this rule in a legend or user interface
min - minimum scale denominator used to control when this rule is applied
max - maximum scale denominator used to control when this rule is applied
symbolizers -
filter -
Returns:
Newly created Rule

selectedChannelType

SelectedChannelType selectedChannelType(String channelName,
                                        ContrastEnhancement contrastEnhancement)
Parameters:
channelName -
contrastEnhancement -
Returns:
SelectedChannelType

shadedRelief

ShadedRelief shadedRelief(Expression reliefFactor,
                          boolean brightnessOnly)
Parameters:
reliefFactor -
brightnessOnly -
Returns:
ShadedRelief

stroke

Stroke stroke(Expression color,
              Expression opacity,
              Expression width,
              Expression join,
              Expression cap,
              float[] dashes,
              Expression offset)

stroke

Stroke stroke(GraphicFill fill,
              Expression color,
              Expression opacity,
              Expression width,
              Expression join,
              Expression cap,
              float[] dashes,
              Expression offset)

stroke

Stroke stroke(GraphicStroke stroke,
              Expression color,
              Expression opacity,
              Expression width,
              Expression join,
              Expression cap,
              float[] dashes,
              Expression offset)

style

Style style(String name,
            Description description,
            boolean isDefault,
            List<FeatureTypeStyle> featureTypeStyles,
            Symbolizer defaultSymbolizer)
Parameters:
name -
description -
isDefault -
featureTypeStyles -
defaultSymbolizer -
Returns:

textSymbolizer

TextSymbolizer textSymbolizer(String name,
                              Expression geometry,
                              Description description,
                              Unit<?> unit,
                              Expression label,
                              Font font,
                              LabelPlacement placement,
                              Halo halo,
                              Fill fill)
Creation of a TextSymbolizer defining how labels are portrayed.

Parameters:
name - Handle used to refer to this symbolizer (machine readable)
geometry - Geometry to be rendered
description - Human readable description
unit - Unit of measure used to interpret symbolizer sizes
label - Text displayed for this symbolizer
font - Font selected to renderer this symbolizer
placement - Placement information relative to orgiginal geometry
halo - definition of a halo or outline surrounding the symbolizer
fill - definition of fill used
Returns:
newly created TextSymbolizer


Copyright © 1996-2014 Geotools. All Rights Reserved.