org.deegree.graphics.sld
Class Stroke

java.lang.Object
  org.deegree.graphics.sld.Drawing
      org.deegree.graphics.sld.Stroke

All Implemented Interfaces:

Marshallable

public class Stroke
extends Drawing
implements Marshallable

A Stroke allows a string of line segments (or any linear geometry) to be rendered. There are three basic types of strokes: solid Color, GraphicFill (stipple), and repeated GraphicStroke. A repeated graphic is plotted linearly and has its graphic symbol bended around the curves of the line string. The default is a solid black line (Color "#000000").

The supported CSS-Parameter names are:

• stroke (color)
• stroke-opacity
• stroke-width
• stroke-linejoin
• stroke-linecap
• stroke-dasharray
• stroke-dashoffset

  Version:

  $Revision: 24727 $ $Date: 2010-06-07 17:58:11 +0200 (Mo, 07 Jun 2010) $

  Author:

  Andreas Poth, Markus Schneider

  Field Summary

  static java.awt.Color	COLOR_DEFAULT Default color is black.
  static int	LC_BUTT Wraps the java.awt.BasicStroke.CAP_BUTT constant (why)
  static int	LC_DEFAULT default line end is butt
  static int	LC_ROUND Wraps the java.awt.BasicStroke.CAP_ROUND constant (why)
  static int	LC_SQUARE Wraps the java.awt.BasicStroke.CAP_SQUARE constant (why)
  static int	LJ_BEVEL Wraps the java.awt.BasicStroke.JOIN_BEVEL constant (why)
  static int	LJ_DEFAULT Default Line join is mitre
  static int	LJ_MITRE Wraps the java.awt.BasicStroke.JOIN_MITER constant (why)
  static int	LJ_ROUND Wraps the java.awt.BasicStroke.JOIN_ROUND constant (why)
  static double	OPACITY_DEFAULT Default opacity is 1
  static double	WIDTH_DEFAULT Default with is 1

  Fields inherited from class org.deegree.graphics.sld.Drawing

  cssParams, graphicFill

  Constructor Summary

  protected	Stroke() Constructs a new Stroke.
  	Stroke(java.util.HashMap<java.lang.String,java.lang.Object> cssParams, GraphicStroke graphicStroke, GraphicFill graphicFill) Constructs a new Stroke.

  Method Summary

  java.lang.String	exportAsXML() exports the content of the Stroke as XML formated String
  float[]	getDashArray(Feature feature) Evaluates the 'stroke-dasharray' parameter as defined in OGC 02-070.
  float	getDashOffset(Feature feature) The stroke-dashoffset CssParameter element specifies the distance as a float into the stroke-dasharray pattern at which to start drawing.
  GraphicStroke	getGraphicStroke() The GraphicStroke element both indicates that a repeated-linear-graphic stroke type will be used.
  int	getLineCap(Feature feature) Thestroke-linecap CssParameter element encode enumerated values telling how line strings should be capped (at the two ends of the line string).
  int	getLineJoin(Feature feature) The stroke-linejoin CssParameter element encode enumerated values telling how line strings should be joined (between line segments).
  double	getOpacity(Feature feature) The stroke-opacity CssParameter element specifies the level of translucency to use when rendering the stroke.
  java.awt.Color	getStroke(Feature feature) The stroke CssParameter element gives the solid color that will be used for a stroke.
  double	getWidth(Feature feature) The stroke-width CssParameter element gives the absolute width (thickness) of a stroke in pixels encoded as a float.
  void	setDashArray(float[] dashArray)
  void	setDashOffset(float dashOffset) The stroke-dashoffset CssParameter element specifies the distance as a float into the stroke-dasharray pattern at which to start drawing.
  void	setGraphicStroke(GraphicStroke graphicStroke) The GraphicStroke element both indicates that a repeated-linear-graphic stroke type will be used.
  void	setLineCap(int lineCap)
  void	setLineJoin(int lineJoin)
  void	setOpacity(double opacity)
  void	setStroke(java.awt.Color stroke)
  void	setWidth(double width)

  Methods inherited from class org.deegree.graphics.sld.Drawing

  addCssParameter, getCssParameters, getGraphicFill, removeCssParameter, setCssParameters, setGraphicFill

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Field Detail

  LJ_MITRE

  public static final int LJ_MITRE

  Wraps the java.awt.BasicStroke.JOIN_MITER constant (why)

  See Also:

  Constant Field Values

  LJ_ROUND

  public static final int LJ_ROUND

  Wraps the java.awt.BasicStroke.JOIN_ROUND constant (why)

  See Also:

  Constant Field Values

  LJ_BEVEL

  public static final int LJ_BEVEL

  Wraps the java.awt.BasicStroke.JOIN_BEVEL constant (why)

  See Also:

  Constant Field Values

  LC_BUTT

  public static final int LC_BUTT

  Wraps the java.awt.BasicStroke.CAP_BUTT constant (why)

  See Also:

  Constant Field Values

  LC_ROUND

  public static final int LC_ROUND

  Wraps the java.awt.BasicStroke.CAP_ROUND constant (why)

  See Also:

  Constant Field Values

  LC_SQUARE

  public static final int LC_SQUARE

  Wraps the java.awt.BasicStroke.CAP_SQUARE constant (why)

  See Also:

  Constant Field Values

  COLOR_DEFAULT

  public static final java.awt.Color COLOR_DEFAULT

  Default color is black.

  OPACITY_DEFAULT

  public static final double OPACITY_DEFAULT

  Default opacity is 1

  See Also:

  Constant Field Values

  WIDTH_DEFAULT

  public static final double WIDTH_DEFAULT

  Default with is 1

  See Also:

  Constant Field Values

  LJ_DEFAULT

  public static final int LJ_DEFAULT

  Default Line join is mitre

  See Also:

  Constant Field Values

  LC_DEFAULT

  public static final int LC_DEFAULT

  default line end is butt

  See Also:

  Constant Field Values

  Constructor Detail

  Stroke

  protected Stroke()

  Constructs a new Stroke.

  Stroke

  public Stroke(java.util.HashMap<java.lang.String,java.lang.Object> cssParams,
                GraphicStroke graphicStroke,
                GraphicFill graphicFill)

  Constructs a new Stroke.

  Parameters:

  cssParams - keys are Strings (see above), values are CssParameters

  graphicStroke -

  graphicFill -

  Method Detail

  getGraphicStroke

  public GraphicStroke getGraphicStroke()

  The GraphicStroke element both indicates that a repeated-linear-graphic stroke type will be used.

  Returns:

  the underlying GraphicStroke instance (may be null)

  setGraphicStroke

  public void setGraphicStroke(GraphicStroke graphicStroke)

  The GraphicStroke element both indicates that a repeated-linear-graphic stroke type will be used.

  Parameters:

  graphicStroke - the graphicStroke element

  getStroke

  public java.awt.Color getStroke(Feature feature)
                           throws FilterEvaluationException

  The stroke CssParameter element gives the solid color that will be used for a stroke. The color value is RGB-encoded using two hexadecimal digits per primary-color component, in the order Red, Green, Blue, prefixed with a hash (#) sign. The hexadecimal digits between A and F may be in either uppercase or lowercase. For example, full red is encoded as #ff0000 (with no quotation marks). The default color is defined to be black (#000000) in the context of the LineSymbolizer, if the stroke CssParameter element is absent.

  Parameters:

  feature - specifies the Feature to be used for evaluation of the underlying 'sld:ParameterValueType'

  Returns:

  the (evaluated) value of the parameter

  Throws:

  FilterEvaluationException - if the evaluation fails

  setStroke

  public void setStroke(java.awt.Color stroke)

  Parameters:

  stroke - the stroke to be set

  See Also:

  getOpacity

  public double getOpacity(Feature feature)
                    throws FilterEvaluationException

  The stroke-opacity CssParameter element specifies the level of translucency to use when rendering the stroke. The value is encoded as a floating-point value (float) between 0.0 and 1.0 with 0.0 representing completely transparent and 1.0 representing completely opaque, with a linear scale of translucency for intermediate values. For example, 0.65 would represent 65% opacity. The default value is 1.0 (opaque).

  Parameters:

  feature - specifies the Feature to be used for evaluation of the underlying 'sld:ParameterValueType'

  Returns:

  the (evaluated) value of the parameter

  Throws:

  FilterEvaluationException - if the evaluation fails

  setOpacity

  public void setOpacity(double opacity)

  Parameters:

  opacity - the opacity to be set for the stroke

  See Also:

  getWidth

  public double getWidth(Feature feature)
                  throws FilterEvaluationException

  The stroke-width CssParameter element gives the absolute width (thickness) of a stroke in pixels encoded as a float. (Arguably, more units could be provided for encoding sizes, such as millimeters or typesetter's points.) The default is 1.0. Fractional numbers are allowed (with a system-dependent interpretation) but negative numbers are not.

  Parameters:

  feature - specifies the Feature to be used for evaluation of the underlying 'sld:ParameterValueType'

  Returns:

  the (evaluated) value of the parameter

  Throws:

  FilterEvaluationException - if the evaluation fails

  setWidth

  public void setWidth(double width)

  Parameters:

  width - the width to be set for the stroke

  See Also:

  getLineJoin

  public int getLineJoin(Feature feature)
                  throws FilterEvaluationException

  The stroke-linejoin CssParameter element encode enumerated values telling how line strings should be joined (between line segments). The values are represented as content strings. The allowed values for line join are mitre, round, and bevel.

  Parameters:

  feature - specifies the Feature to be used for evaluation of the underlying 'sld:ParameterValueType'

  Returns:

  the (evaluated) value of the parameter

  Throws:

  FilterEvaluationException - if the evaluation fails

  setLineJoin

  public void setLineJoin(int lineJoin)

  Parameters:

  lineJoin - the lineJoin to be set for the stroke

  See Also:

  getLineCap

  public int getLineCap(Feature feature)
                 throws FilterEvaluationException

  Thestroke-linecap CssParameter element encode enumerated values telling how line strings should be capped (at the two ends of the line string). The values are represented as content strings. The allowed values for line cap are butt, round, and square. The default values are system-dependent.

  Parameters:

  feature - specifies the Feature to be used for evaluation of the underlying 'sld:ParameterValueType'

  Returns:

  the (evaluated) value of the parameter

  Throws:

  FilterEvaluationException - if the evaluation fails

  setLineCap

  public void setLineCap(int lineCap)

  Parameters:

  lineCap - lineCap to be set for the stroke

  See Also:

  getDashArray

  public float[] getDashArray(Feature feature)
                       throws FilterEvaluationException

  Evaluates the 'stroke-dasharray' parameter as defined in OGC 02-070. The stroke-dasharray CssParameter element encodes a dash pattern as a series of space separated floats. The first number gives the length in pixels of dash to draw, the second gives the amount of space to leave, and this pattern repeats. If an odd number of values is given, then the pattern is expanded by repeating it twice to give an even number of values. Decimal values have a system-dependent interpretation (usually depending on whether antialiasing is being used). The default is to draw an unbroken line.

  Parameters:

  feature - the encoded pattern

  Returns:

  the decoded pattern as an array of float-values (null if the parameter was not specified)

  Throws:

  FilterEvaluationException - if the eevaluation fails or the encoded pattern is erroneous

  setDashArray

  public void setDashArray(float[] dashArray)

  Parameters:

  dashArray - the dashArray to be set for the Stroke

  See Also:

  getDashOffset

  public float getDashOffset(Feature feature)
                      throws FilterEvaluationException

  The stroke-dashoffset CssParameter element specifies the distance as a float into the stroke-dasharray pattern at which to start drawing.

  Parameters:

  feature - specifies the Feature to be used for evaluation of the underlying 'sld:ParameterValueType'

  Returns:

  the (evaluated) value of the parameter

  Throws:

  FilterEvaluationException - if the evaluation fails

  setDashOffset

  public void setDashOffset(float dashOffset)

  The stroke-dashoffset CssParameter element specifies the distance as a float into the stroke-dasharray pattern at which to start drawing.

  Parameters:

  dashOffset - the dashOffset to be set for the Stroke

  exportAsXML

  public java.lang.String exportAsXML()

  exports the content of the Stroke as XML formated String

  Specified by:

  exportAsXML in interface Marshallable

  Returns:

  xml representation of the Stroke