StyleBuilder (Geotools modules 10-SNAPSHOT API)

Field Summary
`static String`	`FONT_STYLE_ITALIC`
`static String`	`FONT_STYLE_NORMAL`
`static String`	`FONT_STYLE_OBLIQUE`
`static String`	`FONT_WEIGHT_BOLD`
`static String`	`FONT_WEIGHT_NORMAL`
`static String`	`LINE_CAP_BUTT`
`static String`	`LINE_CAP_ROUND`
`static String`	`LINE_CAP_SQUARE`
`static String`	`LINE_JOIN_BEVEL`
`static String`	`LINE_JOIN_MITRE`
`static String`	`LINE_JOIN_ROUND`
`static String`	`MARK_ARROW`
`static String`	`MARK_CIRCLE`
`static String`	`MARK_CROSS`
`static String`	`MARK_SQUARE`
`static String`	`MARK_STAR`
`static String`	`MARK_TRIANGLE`
`static String`	`MARK_X`

Constructor Summary
`StyleBuilder()` use the default StyleFactory and FilterFactory
`StyleBuilder(FilterFactory filterFactory)` Use the supplied FilterFactory when building styles
`StyleBuilder(StyleFactory styleFactory)` Use the supplied StyleFactory when building styles
`StyleBuilder(StyleFactory styleFactory, FilterFactory filterFactory)` Use the supplied StyleFactory and FilterFactory when building styles

Method Summary
`Expression`	`attributeExpression(String attributeName)` create an attribute expression
`Style`	`buildClassifiedStyle(SimpleFeatureCollection fc, String name, String[] colors, SimpleFeatureType schema)` given a feature collection and an array of colours build a style with the given number of classes on the named column
`Expression`	`colorExpression(Color color)` convert an awt color in to a literal expression representing the color
`AnchorPoint`	`createAnchorPoint(double x, double y)` wrapper round Stylefactory Method
`AnchorPoint`	`createAnchorPoint(Expression x, Expression y)` wrapper round Stylefactory Method
`ColorMap`	`createColorMap(String[] labels, double[] quantities, Color[] colors, int type)` Creates a color map based on fixed quantities and colors.
`Displacement`	`createDisplacement(double x, double y)` wrapper round Stylefactory Method
`Displacement`	`createDisplacement(Expression x, Expression y)` wrapper round Stylefactory Method
`ExternalGraphic`	`createExternalGraphic(String uri, String format)` wrapper for stylefactory method
`ExternalGraphic`	`createExternalGraphic(URL url, String format)` wrapper for stylefactory method
`FeatureTypeStyle`	`createFeatureTypeStyle(String typeName, Rule r)` create a SimpleFeature type styler
`FeatureTypeStyle`	`createFeatureTypeStyle(String typeName, Rule[] rules)` create a SimpleFeature type styler see the SLD Spec for more details of scaleDenominators
`FeatureTypeStyle`	`createFeatureTypeStyle(String featureTypeName, Symbolizer symbolizer)` create a SimpleFeature type styler
`FeatureTypeStyle`	`createFeatureTypeStyle(String featureTypeName, Symbolizer[] symbolizers)` create a SimpleFeature type styler
`FeatureTypeStyle`	`createFeatureTypeStyle(String typeName, Symbolizer[] symbolizers, double minScaleDenominator, double maxScaleDenominator)` create a SimpleFeature type styler see the SLD Spec for more details of scaleDenominators
`FeatureTypeStyle`	`createFeatureTypeStyle(String typeName, Symbolizer symbolizer, double minScaleDenominator, double maxScaleDenominator)` create a SimpleFeature type styler see the SLD Spec for more details of scaleDenominators
`FeatureTypeStyle`	`createFeatureTypeStyle(Symbolizer symbolizer)` create a SimpleFeature type styler
`FeatureTypeStyle`	`createFeatureTypeStyle(Symbolizer[] symbolizers, double minScaleDenominator, double maxScaleDenominator)` create a SimpleFeature type styler see the SLD Spec for more details of scaleDenominators
`FeatureTypeStyle`	`createFeatureTypeStyle(Symbolizer symbolizer, double minScaleDenominator, double maxScaleDenominator)` create a SimpleFeature type styler see the SLD Spec for more details of scaleDenominators
`Fill`	`createFill()` create a default fill 50% gray
`Fill`	`createFill(Color fillColor)` create a fill of color
`Fill`	`createFill(Color color, Color backgroundColor, double opacity, Graphic fill)` create a fill with color, background color and opacity supplied and uses the graphic supplied for the fill
`Fill`	`createFill(Color fillColor, double opacity)` create a fill with the supplied color and opacity
`Fill`	`createFill(Expression fillColor)` create a fill of color
`Fill`	`createFill(Expression color, Expression opacity)` create a fill with the supplied color and opacity
`Fill`	`createFill(Expression color, Expression backgroundColor, Expression opacity, Graphic fill)` create a fill with color, background color and opacity supplied and uses the graphic supplied for the fill
`Font`	`createFont(Expression fontFamily, Expression fontStyle, Expression fontWeight, Expression fontSize)` wrapper round StyleFactory method
`Font`	`createFont(Font font)` create a geotools font object from a java font
`Font`	`createFont(String fontFamily, boolean italic, boolean bold, double fontSize)` create font of supplied family, size and weight/style
`Font`	`createFont(String fontFamily, double fontSize)` create font of supplied family and size
`Graphic`	`createGraphic()` Creates the default graphic object
`Graphic`	`createGraphic(ExternalGraphic[] externalGraphics, Mark[] marks, Symbol[] symbols, double opacity, double size, double rotation)` creates a graphic object
`Graphic`	`createGraphic(ExternalGraphic[] externalGraphics, Mark[] marks, Symbol[] symbols, Expression opacity, Expression size, Expression rotation)` creates a graphic object
`Graphic`	`createGraphic(ExternalGraphic externalGraphic, Mark mark, Symbol symbol)` creates a graphic object
`Graphic`	`createGraphic(ExternalGraphic externalGraphic, Mark mark, Symbol symbol, double opacity, double size, double rotation)` creates a graphic object
`Halo`	`createHalo()` wrapper round StyleFactory method to create default halo
`Halo`	`createHalo(Color color, double radius)` wrapper round StyleFactory method to create halo
`Halo`	`createHalo(Color color, double opacity, double radius)` wrapper round StyleFactory method to create halo
`Halo`	`createHalo(Fill fill, double radius)` wrapper round StyleFactory method to create halo
`Halo`	`createHalo(Fill fill, Expression radius)` wrapper round StyleFactory method to create halo
`LinePlacement`	`createLinePlacement(double offset)` wrapper round Stylefactory Method
`LinePlacement`	`createLinePlacement(Expression offset)` wrapper round Stylefactory Method
`LineSymbolizer`	`createLineSymbolizer()` create a default line symboliser
`LineSymbolizer`	`createLineSymbolizer(Color color)` create a LineSymbolizer
`LineSymbolizer`	`createLineSymbolizer(Color color, double width)` create a LineSymbolizer
`LineSymbolizer`	`createLineSymbolizer(Color color, double width, String geometryPropertyName)` create a LineSymbolizer
`LineSymbolizer`	`createLineSymbolizer(double width)` create a new line symbolizer
`LineSymbolizer`	`createLineSymbolizer(Stroke stroke)` create a LineSymbolizer
`LineSymbolizer`	`createLineSymbolizer(Stroke stroke, String geometryPropertyName)` create a LineSymbolizer
`Mark`	`createMark(Expression wellKnownName, Fill fill, Stroke stroke)` create a mark with the supplied fill and stroke
`Mark`	`createMark(String wellKnownName)` create the named mark
`Mark`	`createMark(String wellKnownName, Color fillColor)` create a mark of the supplied color and a default outline (black)
`Mark`	`createMark(String wellKnownName, Color fillColor, Color borderColor, double borderWidth)` create the named mark with the colors etc supplied
`Mark`	`createMark(String wellKnownName, Color borderColor, double borderWidth)` create a mark with default fill (50% gray) and the supplied outline
`Mark`	`createMark(String wellKnownName, Fill fill, Stroke stroke)` create a mark with the supplied fill and stroke
`PointPlacement`	`createPointPlacement()` wrapper round Stylefactory Method
`PointPlacement`	`createPointPlacement(AnchorPoint anchorPoint, Displacement displacement, Expression rotation)` wrapper round Stylefactory Method
`PointPlacement`	`createPointPlacement(double anchorX, double anchorY, double rotation)` wrapper round Stylefactory Method
`PointPlacement`	`createPointPlacement(double anchorX, double anchorY, double displacementX, double displacementY, double rotation)` wrapper round Stylefactory Method
`PointSymbolizer`	`createPointSymbolizer()` create a default point symbolizer
`PointSymbolizer`	`createPointSymbolizer(Graphic graphic)` create a point symbolizer
`PointSymbolizer`	`createPointSymbolizer(Graphic graphic, String geometryPropertyName)` create a point symbolizer
`PolygonSymbolizer`	`createPolygonSymbolizer()` create a default polygon symbolizer
`PolygonSymbolizer`	`createPolygonSymbolizer(Color fillColor)` create a polygon symbolizer
`PolygonSymbolizer`	`createPolygonSymbolizer(Color fillColor, Color borderColor, double borderWidth)` create a polygon symbolizer
`PolygonSymbolizer`	`createPolygonSymbolizer(Color borderColor, double borderWidth)` create a polygon symbolizer
`PolygonSymbolizer`	`createPolygonSymbolizer(Stroke stroke, Fill fill)` create a polygon symbolizer
`PolygonSymbolizer`	`createPolygonSymbolizer(Stroke stroke, Fill fill, String geometryPropertyName)` create a polygon symbolizer
`RasterSymbolizer`	`createRasterSymbolizer()` Creates the default raster symbolizer
`RasterSymbolizer`	`createRasterSymbolizer(ColorMap colorMap, double opacity)` Creates a raster symbolizer
`Rule`	`createRule(Symbolizer symbolizer)` create a simple styling rule
`Rule`	`createRule(Symbolizer[] symbolizers)` reate a simple styling rule
`Rule`	`createRule(Symbolizer[] symbolizers, double minScaleDenominator, double maxScaleDenominator)` create a simple styling rule, see the SLD Spec for more details of scaleDenominators
`Rule`	`createRule(Symbolizer symbolizer, double minScaleDenominator, double maxScaleDenominator)` create a simple styling rule, see the SLD Spec for more details of scaleDenominators
`TextSymbolizer`	`createStaticTextSymbolizer(Color color, Font[] fonts, String label)` create a textsymbolizer which doesn't change
`TextSymbolizer`	`createStaticTextSymbolizer(Color color, Font font, String label)` create a textsymbolizer which doesn't change
`Stroke`	`createStroke()` create a default Stroke
`Stroke`	`createStroke(Color color)` Create a default stroke with the supplied color
`Stroke`	`createStroke(Color color, double width)` create a stroke with the supplied width and color
`Stroke`	`createStroke(Color color, double width, double opacity)` create a stroke with color, width and opacity supplied
`Stroke`	`createStroke(Color color, double width, float[] dashArray)` create a dashed line of color and width
`Stroke`	`createStroke(Color color, double width, String lineJoin, String lineCap)` create a stroke with color, width, linejoin type and lineCap type.
`Stroke`	`createStroke(double width)` create a default stroke with the supplied width
`Stroke`	`createStroke(Expression color, Expression width)` create a stroke with the color and width supplied
`Stroke`	`createStroke(Expression color, Expression width, Expression opacity)` create a stroke with color, width and opacity supplied
`Style`	`createStyle()` create a new default style
`Style`	`createStyle(String typeName, Symbolizer symbolizer)` create a new style
`Style`	`createStyle(String typeName, Symbolizer symbolizer, double minScaleDenominator, double maxScaleDenominator)` create a new style
`Style`	`createStyle(Symbolizer symbolizer)` create a new style
`Style`	`createStyle(Symbolizer symbolizer, double minScaleDenominator, double maxScaleDenominator)` create a new style
`TextSymbolizer`	`createTextSymbolizer()` Creates a default text symbolizer.
`TextSymbolizer`	`createTextSymbolizer(Color color, Font[] fonts, String attributeName)` create a textsymbolizer
`TextSymbolizer`	`createTextSymbolizer(Color color, Font font, String attributeName)` create a textsymbolizer
`TextSymbolizer`	`createTextSymbolizer(Fill fill, Font[] fonts, Halo halo, Expression label, LabelPlacement labelPlacement, String geometryPropertyName)` create a text symbolizer
`FilterFactory2`	`getFilterFactory()` getter for filterFactory
`StyleFactory`	`getStyleFactory()` getter for StyleFactory
`String[]`	`getWellKnownMarkNames()` Returns the array of all the well known mark names
`Expression`	`literalExpression(double value)` create a literal expression representing the value
`Expression`	`literalExpression(int value)` create a literal expression representing the value
`Expression`	`literalExpression(Object value)` create a literal expression representing the value
`Expression`	`literalExpression(String value)` create a literal expression representing the value
`void`	`setFilterFactory(FilterFactory factory)` Documented setter injection, StyleBuilder uses a StyleFactory for creation.
`void`	`setStyleFactory(StyleFactory factory)` Documented setter injection, StyleBuilder uses a StyleFactory for creation.

Methods inherited from class Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

LINE_JOIN_MITRE

public static final String LINE_JOIN_MITRE

See Also:: Constant Field Values

LINE_JOIN_ROUND

public static final String LINE_JOIN_ROUND

See Also:: Constant Field Values

LINE_JOIN_BEVEL

public static final String LINE_JOIN_BEVEL

See Also:: Constant Field Values

LINE_CAP_BUTT

public static final String LINE_CAP_BUTT

See Also:: Constant Field Values

LINE_CAP_ROUND

public static final String LINE_CAP_ROUND

See Also:: Constant Field Values

LINE_CAP_SQUARE

public static final String LINE_CAP_SQUARE

See Also:: Constant Field Values

MARK_SQUARE

public static final String MARK_SQUARE

See Also:: Constant Field Values

MARK_CIRCLE

public static final String MARK_CIRCLE

See Also:: Constant Field Values

MARK_TRIANGLE

public static final String MARK_TRIANGLE

See Also:: Constant Field Values

MARK_STAR

public static final String MARK_STAR

See Also:: Constant Field Values

MARK_CROSS

public static final String MARK_CROSS

See Also:: Constant Field Values

MARK_ARROW

public static final String MARK_ARROW

See Also:: Constant Field Values

MARK_X

public static final String MARK_X

See Also:: Constant Field Values

FONT_STYLE_NORMAL

public static final String FONT_STYLE_NORMAL

See Also:: Constant Field Values

FONT_STYLE_ITALIC

public static final String FONT_STYLE_ITALIC

See Also:: Constant Field Values

FONT_STYLE_OBLIQUE

public static final String FONT_STYLE_OBLIQUE

See Also:: Constant Field Values

FONT_WEIGHT_NORMAL

public static final String FONT_WEIGHT_NORMAL

See Also:: Constant Field Values

FONT_WEIGHT_BOLD

public static final String FONT_WEIGHT_BOLD

See Also:: Constant Field Values

Constructor Detail

StyleBuilder

public StyleBuilder()

use the default StyleFactory and FilterFactory

StyleBuilder

public StyleBuilder(StyleFactory styleFactory)

Use the supplied StyleFactory when building styles

Parameters:: styleFactory - the StyleFactory to use in building Styles

StyleBuilder

public StyleBuilder(FilterFactory filterFactory)

Use the supplied FilterFactory when building styles

Parameters:: filterFactory - Use this FilterFactory to build the style

StyleBuilder

public StyleBuilder(StyleFactory styleFactory,
                    FilterFactory filterFactory)

Use the supplied StyleFactory and FilterFactory when building styles

Parameters:: styleFactory - the StyleFactory to use; filterFactory - the FilterFactory to use

Method Detail

setStyleFactory

public void setStyleFactory(StyleFactory factory)

Documented setter injection, StyleBuilder uses a StyleFactory for creation.

Parameters:: factory -

getStyleFactory

public StyleFactory getStyleFactory()

getter for StyleFactory

Returns:: the StyleFactory being used

setFilterFactory

public void setFilterFactory(FilterFactory factory)

Documented setter injection, StyleBuilder uses a StyleFactory for creation.

Parameters:: factory -

getFilterFactory

public FilterFactory2 getFilterFactory()

getter for filterFactory

Returns:: the FilterFactory being used

createStroke

public Stroke createStroke()

create a default Stroke

Returns:: the Stroke created

createStroke

public Stroke createStroke(double width)

create a default stroke with the supplied width

Parameters:: width - the width of the line
Returns:: the stroke created

createStroke

public Stroke createStroke(Color color)

Create a default stroke with the supplied color

Parameters:: color - the color of the line
Returns:: the created stroke

createStroke

public Stroke createStroke(Color color,
                           double width)

create a stroke with the supplied width and color

Parameters:: color - the color of the line; width - the width of the line
Returns:: the created stroke

createStroke

public Stroke createStroke(Color color,
                           double width,
                           String lineJoin,
                           String lineCap)

create a stroke with color, width, linejoin type and lineCap type.

Parameters:: color - the color of the line; width - the width of the line; lineJoin - the type of join to be used at points along the line; lineCap - the type of cap to be used at the end of the line
Returns:: the stroke created

createStroke

public Stroke createStroke(Color color,
                           double width,
                           float[] dashArray)

create a dashed line of color and width

Parameters:: color - the color of the line; width - the width of the line; dashArray - an array of floats describing the length of line and spaces
Returns:: the stroke created

createStroke

public Stroke createStroke(Expression color,
                           Expression width)

create a stroke with the color and width supplied

Parameters:: color - an Expression representing the color of the line; width - an Expression representing the width of the line
Returns:: the Stroke created

createStroke

public Stroke createStroke(Color color,
                           double width,
                           double opacity)

create a stroke with color, width and opacity supplied

Parameters:: color - the color of the line; width - the width of the line; opacity - the opacity or see throughness of the line, 0 - is transparent, 1 is completely drawn
Returns:: the stroke created

createStroke

public Stroke createStroke(Expression color,
                           Expression width,
                           Expression opacity)

create a stroke with color, width and opacity supplied

Parameters:: color - an Expression representing the color of the line; width - an Expression representing the width of the line; opacity - an Expression representing opacity the opacity or see throughness of the line, 0 - is transparent, 1 is completely drawn
Returns:: the stroke created

createFill

public Fill createFill()

create a default fill 50% gray

Returns:: the fill created

createFill

public Fill createFill(Color fillColor)

create a fill of color

Parameters:: fillColor - the color of the fill
Returns:: the fill created

createFill

public Fill createFill(Expression fillColor)

create a fill of color

Parameters:: fillColor - an Expression representing the color of the fill
Returns:: the fill constructed

createFill

public Fill createFill(Color fillColor,
                       double opacity)

create a fill with the supplied color and opacity

Parameters:: fillColor - the color to fill with; opacity - the opacity of the fill 0 - transparent, 1 - completly filled
Returns:: the fill created

createFill

public Fill createFill(Expression color,
                       Expression opacity)

create a fill with the supplied color and opacity

Parameters:: color - an expression representing the color to fill with; opacity - an expression representing the opacity of the fill 0 - transparent, 1 - completly filled
Returns:: the fill created

createFill

public Fill createFill(Color color,
                       Color backgroundColor,
                       double opacity,
                       Graphic fill)

create a fill with color, background color and opacity supplied and uses the graphic supplied for the fill

Parameters:: color - the foreground color; backgroundColor - the background color; opacity - the opacity of the fill; fill - the graphic object to use to fill the fill
Returns:: the fill created

createFill

public Fill createFill(Expression color,
                       Expression backgroundColor,
                       Expression opacity,
                       Graphic fill)

create a fill with color, background color and opacity supplied and uses the graphic supplied for the fill

Parameters:: color - an Expression representing the foreground color; backgroundColor - an Expression representing the background color; opacity - an Expression representing the opacity of the fill; fill - the graphic object to use to fill the fill
Returns:: the fill created

getWellKnownMarkNames

public String[] getWellKnownMarkNames()

Returns the array of all the well known mark names

Returns:: DOCUMENT ME!

createMark

public Mark createMark(String wellKnownName)

create the named mark

Parameters:: wellKnownName - the wellknown name of the mark
Returns:: the mark created

createMark

public Mark createMark(String wellKnownName,
                       Color fillColor,
                       Color borderColor,
                       double borderWidth)

create the named mark with the colors etc supplied

Parameters:: wellKnownName - the well known name of the mark; fillColor - the color of the mark; borderColor - the outline color of the mark; borderWidth - the width of the outline
Returns:: the mark created

createMark

public Mark createMark(String wellKnownName,
                       Color borderColor,
                       double borderWidth)

create a mark with default fill (50% gray) and the supplied outline

Parameters:: wellKnownName - the well known name of the mark; borderColor - the outline color; borderWidth - the outline width
Returns:: the mark created

createMark

public Mark createMark(String wellKnownName,
                       Color fillColor)

create a mark of the supplied color and a default outline (black)

Parameters:: wellKnownName - the well known name of the mark; fillColor - the color of the mark
Returns:: the created mark

createMark

public Mark createMark(String wellKnownName,
                       Fill fill,
                       Stroke stroke)

create a mark with the supplied fill and stroke

Parameters:: wellKnownName - the well known name of the mark; fill - the fill to use; stroke - the stroke to use
Returns:: the mark created

createMark

public Mark createMark(Expression wellKnownName,
                       Fill fill,
                       Stroke stroke)

create a mark with the supplied fill and stroke

Parameters:: wellKnownName - an Expression representing the well known name of the mark; fill - the fill to use; stroke - the stroke to use
Returns:: the mark created

createExternalGraphic

public ExternalGraphic createExternalGraphic(String uri,
                                             String format)

wrapper for stylefactory method

Parameters:: uri - the uri of the image; format - mime type of the image
Returns:: the external graphic

createExternalGraphic

public ExternalGraphic createExternalGraphic(URL url,
                                             String format)

wrapper for stylefactory method

Parameters:: url - the url of the image; format - mime type of the image
Returns:: the external graphic

createGraphic

public Graphic createGraphic()

Creates the default graphic object

Returns:: the graphic object

createGraphic

public Graphic createGraphic(ExternalGraphic externalGraphic,
                             Mark mark,
                             Symbol symbol)

creates a graphic object

Parameters:: externalGraphic - an external graphic to use if displayable; mark - a mark to use; symbol - a symbol to use
Returns:: the graphic object

createGraphic

public Graphic createGraphic(ExternalGraphic externalGraphic,
                             Mark mark,
                             Symbol symbol,
                             double opacity,
                             double size,
                             double rotation)

creates a graphic object

Parameters:: externalGraphic - an external graphic to use if displayable; mark - a mark to use; symbol - a symbol to use; opacity - - the opacity of the graphic; size - - the size of the graphic; rotation - - the rotation from the top of the page of the graphic
Returns:: the graphic created

createGraphic

public Graphic createGraphic(ExternalGraphic[] externalGraphics,
                             Mark[] marks,
                             Symbol[] symbols,
                             double opacity,
                             double size,
                             double rotation)

creates a graphic object

Parameters:: externalGraphics - an array of external graphics to use if displayable; marks - an array of marks to use; symbols - an array of symbols to use; opacity - - the opacity of the graphic; size - - the size of the graphic; rotation - - the rotation from the top of the page of the graphic
Returns:: the graphic created

createGraphic

public Graphic createGraphic(ExternalGraphic[] externalGraphics,
                             Mark[] marks,
                             Symbol[] symbols,
                             Expression opacity,
                             Expression size,
                             Expression rotation)

creates a graphic object

Parameters:: externalGraphics - an array of external graphics to use if displayable; marks - an array of marks to use; symbols - an array of symbols to use; opacity - - an Expression representing the opacity of the graphic; size - - an Expression representing the size of the graphic; rotation - - an Expression representing the rotation from the top of the page of the graphic
Returns:: the graphic created