org.deegree_impl.graphics.sld
Class Stroke_Impl

java.lang.Object
  org.deegree_impl.graphics.sld.Drawing_Impl
      org.deegree_impl.graphics.sld.Stroke_Impl

All Implemented Interfaces:

Drawing, Marshallable, Stroke

public class Stroke_Impl

extends Drawing_Impl

implements Stroke, 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: 1.12 $ $Date: 2004/03/08 07:27:26 $

  Author:

  Andreas Poth, Markus Schneider

  Field Summary

  private java.awt.Color	color
  private GraphicStroke	graphicStroke
  private float[]	smplDashArray
  private float	smplDashOffset
  private int	smplLineCap
  private int	smplLineJoin
  private double	smplOpacity
  private double	smplWidth

  Fields inherited from class org.deegree_impl.graphics.sld.Drawing_Impl

  cssParams, graphicFill

  Fields inherited from interface org.deegree.graphics.sld.Stroke

  COLOR_DEFAULT, LC_BUTT, LC_DEFAULT, LC_ROUND, LC_SQUARE, LJ_BEVEL, LJ_DEFAULT, LJ_MITRE, LJ_ROUND, OPACITY_DEFAULT, WIDTH_DEFAULT

  Constructor Summary

  protected	Stroke_Impl() Constructs a new Stroke_Impl.
  protected	Stroke_Impl(java.util.HashMap cssParams, GraphicStroke graphicStroke, GraphicFill graphicFill) Constructs a new Stroke_Impl.

  Method Summary

  java.lang.String	exportAsXML() exports the content of the Stroke as XML formated String
  private void	extractSimpleColor() extracts the color of the stroke if it is simple (nor Expression) to avoid new calculation for each call of getStroke(Feature feature)
  private void	extractSimpleDasharray() extracts the dasharray of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)
  private void	extractSimpleDashOffset() extracts the dash offset of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)
  private void	extractSimpleLineCap() extracts the line cap of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)
  private void	extractSimpleLineJoin() extracts the line join of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)
  private void	extractSimpleOpacity() extracts the opacity of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)
  private void	extractSimpleWidth() extracts the width of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)
  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.
  private boolean	isSimple(CssParameter cssParam) returns true if the passed CssParameter contain a simple value
  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_impl.graphics.sld.Drawing_Impl

  addCssParameter, getCssParameters, getGraphicFill, removeCssParameter, setCssParameters, setGraphicFill

  Methods inherited from class java.lang.Object

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

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

  addCssParameter, getCssParameters, getGraphicFill, removeCssParameter, setCssParameters, setGraphicFill

  Field Detail

  graphicStroke

  private GraphicStroke graphicStroke

  color

  private java.awt.Color color

  smplOpacity

  private double smplOpacity

  smplWidth

  private double smplWidth

  smplLineJoin

  private int smplLineJoin

  smplLineCap

  private int smplLineCap

  smplDashArray

  private float[] smplDashArray

  smplDashOffset

  private float smplDashOffset

  Constructor Detail

  Stroke_Impl

  protected Stroke_Impl()

  Constructs a new Stroke_Impl.

  Stroke_Impl

  protected Stroke_Impl(java.util.HashMap cssParams,
                        GraphicStroke graphicStroke,
                        GraphicFill graphicFill)

  Constructs a new Stroke_Impl.

  Parameters:

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

  Method Detail

  extractSimpleColor

  private void extractSimpleColor()
                           throws FilterEvaluationException

  extracts the color of the stroke if it is simple (nor Expression) to avoid new calculation for each call of getStroke(Feature feature)

  Throws:

  FilterEvaluationException

  isSimple

  private boolean isSimple(CssParameter cssParam)

  returns true if the passed CssParameter contain a simple value

  extractSimpleOpacity

  private void extractSimpleOpacity()
                             throws FilterEvaluationException

  extracts the opacity of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)

  Throws:

  FilterEvaluationException

  extractSimpleWidth

  private void extractSimpleWidth()
                           throws FilterEvaluationException

  extracts the width of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)

  Throws:

  FilterEvaluationException

  extractSimpleLineJoin

  private void extractSimpleLineJoin()
                              throws FilterEvaluationException

  extracts the line join of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)

  Throws:

  FilterEvaluationException

  extractSimpleLineCap

  private void extractSimpleLineCap()
                             throws FilterEvaluationException

  extracts the line cap of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)

  Throws:

  FilterEvaluationException

  extractSimpleDasharray

  private void extractSimpleDasharray()
                               throws FilterEvaluationException

  extracts the dasharray of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)

  Throws:

  FilterEvaluationException

  extractSimpleDashOffset

  private void extractSimpleDashOffset()
                                throws FilterEvaluationException

  extracts the dash offset of the stroke if it is simple (no Expression) to avoid new calculation for each call of getStroke(Feature feature)

  Throws:

  FilterEvaluationException

  getGraphicStroke

  public GraphicStroke getGraphicStroke()

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

  Specified by:

  getGraphicStroke in interface Stroke

  setGraphicStroke

  public void setGraphicStroke(GraphicStroke graphicStroke)

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

  Specified by:

  setGraphicStroke in interface Stroke

  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.

  Specified by:

  getStroke in interface Stroke

  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)

  Specified by:

  setStroke in interface 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).

  Specified by:

  getOpacity in interface Stroke

  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)

  Specified by:

  setOpacity in interface Stroke

  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.

  Specified by:

  getWidth in interface Stroke

  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)

  Specified by:

  setWidth in interface Stroke

  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.

  Specified by:

  getLineJoin in interface Stroke

  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)

  Specified by:

  setLineJoin in interface Stroke

  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.

  Specified by:

  getLineCap in interface Stroke

  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)

  Specified by:

  setLineCap in interface Stroke

  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.

  Specified by:

  getDashArray in interface Stroke

  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)

  Specified by:

  setDashArray in interface Stroke

  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.

  Specified by:

  getDashOffset in interface Stroke

  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.

  Specified by:

  setDashOffset in interface Stroke

  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