org.deegree.services.wms.protocol
Interface WMSGetScaleBarRequest

All Superinterfaces:

OGCWebServiceRequest

All Known Implementing Classes:

WMSGetScaleBarRequest_Impl

public interface WMSGetScaleBarRequest

extends OGCWebServiceRequest

interface definition for the deegree specific WMS request: GetScaleBar

Version:

$Revision: 1.4 $

Author:

Andreas Poth

Field Summary

static int	L_NONE
static int	L_SCALE
static int	L_SIZE

Method Summary

int	getBarSize() return the size of the scale bar in pixel
java.awt.Color	getBGColor() returns the background color of the scale bar
int	getBottomLabel() get the label type that shall be displayed below the scale bar.
java.awt.Color	getColor() returns the color will be painted or null if the scale bar hasn't a unique color (depends on the style)
java.awt.Font	getFont() return the the font to be used for drawing the labels
java.lang.String	getFormat() returns the image format (MIME Type) the scale bar will be produced in.
java.awt.Color	getLabelColor() returns the color the scale bars label will be painted
double	getPixelSize() returns the pixel size in milli meter.
double	getScale()
int	getScaleDenominator()
int	getSize() returns the size of the scale bar in pixel
java.lang.String	getStyle() returns the name of the style the scale bar should be drawed. beside 'default' and 'ALTERNATE' the available styles depends on the implementation.
int	getTopLabel() get the label type that shall be displayed above the scale bar.
java.lang.String	getUnits() returns the name of the units the scale bar should use for measuring

Methods inherited from interface org.deegree.services.OGCWebServiceRequest

getId, getRequest, getRequestParameter, getService, getVendorSpecificParameter, getVendorSpecificParameters, getVersion

Field Detail

L_SCALE

public static final int L_SCALE

See Also:

Constant Field Values

L_SIZE

public static final int L_SIZE

See Also:

Constant Field Values

L_NONE

public static final int L_NONE

See Also:

Constant Field Values

Method Detail

getUnits

public java.lang.String getUnits()

returns the name of the units the scale bar should use for measuring

Returns:

name of the units

getSize

public int getSize()

returns the size of the scale bar in pixel

Returns:

size of the scale bar in pixel

getTopLabel

public int getTopLabel()

get the label type that shall be displayed above the scale bar. Possible values are L_SCALE, L_SIZE and L_NONE.

Returns:

type of label to display above the scale bar

getBottomLabel

public int getBottomLabel()

get the label type that shall be displayed below the scale bar. Possible values are L_SCALE, L_SIZE and L_NONE

Returns:

type of label to display below the scale bar

getScaleDenominator

public int getScaleDenominator()

getScale

public double getScale()

getStyle

public java.lang.String getStyle()

returns the name of the style the scale bar should be drawed. beside 'default' and 'ALTERNATE' the available styles depends on the implementation.

Returns:

style of the scale bar

getColor

public java.awt.Color getColor()

returns the color will be painted or null if the scale bar hasn't a unique color (depends on the style)

Returns:

color of the scale bar

getBGColor

public java.awt.Color getBGColor()

returns the background color of the scale bar

Returns:

background color

getLabelColor

public java.awt.Color getLabelColor()

returns the color the scale bars label will be painted

Returns:

color of the labels

getFormat

public java.lang.String getFormat()

returns the image format (MIME Type) the scale bar will be produced in.

Returns:

image format of the scale bar

getPixelSize

public double getPixelSize()

returns the pixel size in milli meter. This value is needed for calculating scale of the map. For usual the exact pixel size isn't known or different pixels size at different clients are used at the same time. So in most cases this method returns the default pixels size of 0.28 mm.

Returns:

client pixel size in milli meter

getBarSize

public int getBarSize()

return the size of the scale bar in pixel

Returns:

getFont

public java.awt.Font getFont()

return the the font to be used for drawing the labels

Returns: