org.geomajas.service.legend

Class DefaultLegendGraphicMetadata

java.lang.Object

org.geomajas.service.legend.DefaultLegendGraphicMetadata

All Implemented Interfaces:

LegendGraphicMetadata

@Api(allMethods=true)
public class DefaultLegendGraphicMetadata
extends Object
implements LegendGraphicMetadata

Default implementation of LegendGraphicMetadata metadata object.

Since:

1.10.0

Author:

Jan De Moerloose

Field Summary

Fields inherited from interface org.geomajas.service.legend.LegendGraphicMetadata

DEFAULT_HEIGHT, DEFAULT_WIDTH

Constructor Summary

Constructors

Constructor and Description
DefaultLegendGraphicMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
int	getHeight() Get the suggested height of the graphic, optional.
String	getLayerId() Get layer id, optional.
org.geomajas.sld.NamedStyleInfo	getNamedStyle() Get the named style, optional.
org.geomajas.sld.RuleInfo	getRule() Get the rule, optional.
double	getScale() Get the scale, optional.
org.geomajas.sld.UserStyleInfo	getUserStyle() Get the user style, optional.
int	getWidth() Get the suggested width of the graphic, optional.
void	setHeight(int height) Set the legend graphic height.
void	setLayerId(String layerId) Set the layer for the legend graphic.
void	setNamedStyle(org.geomajas.sld.NamedStyleInfo namedStyle) Set the named style for the legend graphic.
void	setRuleInfo(org.geomajas.sld.RuleInfo rule) Set the SLD rule for the legend graphic.
void	setScale(double scale) Set the scale for the legend graphic (can be used to determine the rule).
void	setUserStyle(org.geomajas.sld.UserStyleInfo userStyle) Set the user style for the legend graphic.
void	setWidth(int width) Set the legend graphic width.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLegendGraphicMetadata

public DefaultLegendGraphicMetadata()

Method Detail

getLayerId

public String getLayerId()

Description copied from interface: LegendGraphicMetadata

Get layer id, optional.

Specified by:

getLayerId in interface LegendGraphicMetadata

Returns:

layer id

setLayerId

public void setLayerId(String layerId)

Set the layer for the legend graphic.

Parameters:

layerId - layer id

getUserStyle

public org.geomajas.sld.UserStyleInfo getUserStyle()

Description copied from interface: LegendGraphicMetadata

Get the user style, optional.

Specified by:

getUserStyle in interface LegendGraphicMetadata

Returns:

user style

setUserStyle

public void setUserStyle(org.geomajas.sld.UserStyleInfo userStyle)

Set the user style for the legend graphic.

Parameters:

userStyle - user style or null

getNamedStyle

public org.geomajas.sld.NamedStyleInfo getNamedStyle()

Description copied from interface: LegendGraphicMetadata

Get the named style, optional.

Specified by:

getNamedStyle in interface LegendGraphicMetadata

Returns:

named style

setNamedStyle

public void setNamedStyle(org.geomajas.sld.NamedStyleInfo namedStyle)

Set the named style for the legend graphic.

Parameters:

namedStyle - named style or null

getRule

public org.geomajas.sld.RuleInfo getRule()

Description copied from interface: LegendGraphicMetadata

Get the rule, optional.

Specified by:

getRule in interface LegendGraphicMetadata

Returns:

the rule

setRuleInfo

public void setRuleInfo(org.geomajas.sld.RuleInfo rule)

Set the SLD rule for the legend graphic.

Parameters:

rule - SLD rule

getScale

public double getScale()

Description copied from interface: LegendGraphicMetadata

Get the scale, optional. This scale will be used to determine the applicable rules.

Specified by:

getScale in interface LegendGraphicMetadata

Returns:

the scale

setScale

public void setScale(double scale)

Set the scale for the legend graphic (can be used to determine the rule).

Parameters:

scale - scale

getWidth

public int getWidth()

Description copied from interface: LegendGraphicMetadata

Get the suggested width of the graphic, optional.

Specified by:

getWidth in interface LegendGraphicMetadata

Returns:

the width

setWidth

public void setWidth(int width)

Set the legend graphic width.

Parameters:

width - width in pixels

getHeight

public int getHeight()

Description copied from interface: LegendGraphicMetadata

Get the suggested height of the graphic, optional.

Specified by:

getHeight in interface LegendGraphicMetadata

Returns:

the height

setHeight

public void setHeight(int height)

Set the legend graphic height.

Parameters:

height - height in pixels