org.geomajas.command.dto
Class GetVectorTileRequest

java.lang.Object
  org.geomajas.command.LayerIdCommandRequest
      org.geomajas.command.dto.GetVectorTileRequest

All Implemented Interfaces:

Serializable, CommandRequest, CacheableObject, TileMetadata

@Api(allMethods=true)
public class GetVectorTileRequest
extends LayerIdCommandRequest
implements TileMetadata, CacheableObject

Request object for GetVectorTileCommand.

Since:

1.6.0

Author:

Joachim Van der Auwera

See Also:

Serialized Form

Field Summary

static String

COMMAND Command name for this request.

Fields inherited from interface org.geomajas.layer.tile.TileMetadata

PARAM_SVG_RENDERER, PARAM_VML_RENDERER

Constructor Summary

GetVectorTileRequest()
Constructs an empty request (GWT).

GetVectorTileRequest(TileMetadata tileMetadata)
Constructs a request with the specified TileMetadata.

Method Summary

boolean	equals(Object o) Are the two objects equal?
String	getCacheId() String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result.
TileCode	getCode() Get tile code.
String	getCrs() Get the coordinate reference space which should be used for the returned geometries.
int	getFeatureIncludes() Deprecated. features are no longer included in response
String	getFilter() Filter to apply to the tile.
Coordinate	getPanOrigin() Get pan origin.
String	getRenderer() Get renderer to use.
double	getScale() Get zoom scale.
NamedStyleInfo	getStyleInfo() Get style for rendering.
int	hashCode() Calculate object hash code.
boolean	isPaintGeometries() Should geometries be painted?
boolean	isPaintLabels() Should labels be painted?
boolean	isPartOf(GetVectorTileRequest request) Check if this request is part of the specified request.
void	setCode(TileCode code) Set tile code.
void	setCrs(String crs) Set the coordinate reference space which should be used for the returned geometries.
void	setFeatureIncludes(int featureIncludes) Deprecated. features are no longer included in response
void	setFilter(String filter) Filter to apply to the tile.
void	setPaintGeometries(boolean paintGeometries) Should geometries be painted?
void	setPaintLabels(boolean paintLabels) Should labels be painted?
void	setPanOrigin(Coordinate panOrigin) Set pan origin.
void	setRenderer(String renderer) Set renderer to use.
void	setScale(double scale) Set zoom scale.
void	setStyleInfo(NamedStyleInfo styleInfo) Set style for rendering.
String	toString()

Methods inherited from class org.geomajas.command.LayerIdCommandRequest

getLayerId, setLayerId

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.geomajas.layer.tile.TileMetadata

getLayerId, setLayerId

Field Detail

COMMAND

public static final String COMMAND

Command name for this request.

Since:

1.9.0

See Also:

Constant Field Values

Constructor Detail

GetVectorTileRequest

public GetVectorTileRequest()

Constructs an empty request (GWT).

Since:

1.10.0

GetVectorTileRequest

public GetVectorTileRequest(TileMetadata tileMetadata)

Constructs a request with the specified TileMetadata. Clones all properties, except for the style information.

Parameters:

tileMetadata - the metadata

Since:

1.10.0

Method Detail

getCode

public TileCode getCode()

Get tile code.

Specified by:

getCode in interface TileMetadata

Returns:

tile code

setCode

public void setCode(TileCode code)

Set tile code.

Specified by:

setCode in interface TileMetadata

Parameters:

code - tile code

getScale

public double getScale()

Get zoom scale.

Specified by:

getScale in interface TileMetadata

Returns:

scale

setScale

public void setScale(double scale)

Set zoom scale.

Specified by:

setScale in interface TileMetadata

Parameters:

scale - scale in pix/map unit (at map center)

getPanOrigin

public Coordinate getPanOrigin()

Get pan origin.

Specified by:

getPanOrigin in interface TileMetadata

Returns:

pan origin

setPanOrigin

public void setPanOrigin(Coordinate panOrigin)

Set pan origin.

Specified by:

setPanOrigin in interface TileMetadata

Parameters:

panOrigin - pan origin

getFilter

public String getFilter()

Filter to apply to the tile.

Specified by:

getFilter in interface TileMetadata

Returns:

filter

setFilter

public void setFilter(String filter)

Filter to apply to the tile.

Specified by:

setFilter in interface TileMetadata

Parameters:

filter - filter which needs to be applied for the tile

getCrs

public String getCrs()

Get the coordinate reference space which should be used for the returned geometries.

Specified by:

getCrs in interface TileMetadata

Returns:

crs

setCrs

public void setCrs(String crs)

Set the coordinate reference space which should be used for the returned geometries.

Specified by:

setCrs in interface TileMetadata

Parameters:

crs - crs

getStyleInfo

public NamedStyleInfo getStyleInfo()

Get style for rendering.

Specified by:

getStyleInfo in interface TileMetadata

Returns:

style

setStyleInfo

public void setStyleInfo(NamedStyleInfo styleInfo)

Set style for rendering.

Specified by:

setStyleInfo in interface TileMetadata

Parameters:

styleInfo - style info for rendering the tile

getRenderer

public String getRenderer()

Get renderer to use.

Specified by:

getRenderer in interface TileMetadata

Returns:

renderer

setRenderer

public void setRenderer(String renderer)

Set renderer to use.

Specified by:

setRenderer in interface TileMetadata

Parameters:

renderer - renderer type

isPaintGeometries

public boolean isPaintGeometries()

Should geometries be painted?

Specified by:

isPaintGeometries in interface TileMetadata

Returns:

true when labels need to be renderer

setPaintGeometries

public void setPaintGeometries(boolean paintGeometries)

Should geometries be painted?

Specified by:

setPaintGeometries in interface TileMetadata

Parameters:

paintGeometries - include geometries when rendering?

isPaintLabels

public boolean isPaintLabels()

Should labels be painted?

Specified by:

isPaintLabels in interface TileMetadata

Returns:

true when labels need to be rendered

setPaintLabels

public void setPaintLabels(boolean paintLabels)

Should labels be painted?

Specified by:

setPaintLabels in interface TileMetadata

Parameters:

paintLabels - include labels when rendering?

getFeatureIncludes

@Deprecated
public int getFeatureIncludes()

Deprecated. features are no longer included in response

Get which data should be included in the features. For possible values, see VectorLayerService.

Specified by:

getFeatureIncludes in interface TileMetadata

Returns:

what to include

setFeatureIncludes

@Deprecated
public void setFeatureIncludes(int featureIncludes)

Deprecated. features are no longer included in response

Set the data to include in the features which are returned. For possible values, see VectorLayerService.

Specified by:

setFeatureIncludes in interface TileMetadata

Parameters:

featureIncludes - what the include

getCacheId

public String getCacheId()

String identifier which is guaranteed to include sufficient information to assure to be different for two instances which could produce different result. It is typically used as basis for calculation of hash codes (like MD5, SHA1, SHA2 etc) of (collections of) objects.

Specified by:

getCacheId in interface CacheableObject

Returns:

cacheId

Since:

1.8.0

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Are the two objects equal?

Overrides:

equals in class Object

Parameters:

o - object to compare

Returns:

true when objects are equal

Since:

1.8.0

isPartOf

public boolean isPartOf(GetVectorTileRequest request)

Check if this request is part of the specified request. This is the case if both requests have equal properties and the specified request is asking for the same or more paint operations than this one.

Parameters:

request - another request

Returns:

true if the current request is contained in the specified request

Since:

1.10.0

hashCode

public int hashCode()

Calculate object hash code.

Overrides:

hashCode in class Object

Returns:

hash code

Since:

1.8.0