org.gvsig.remoteclient.wms

Class WMSStatus

java.lang.Object

org.gvsig.remoteclient.RemoteClientStatus

org.gvsig.remoteclient.wms.WMSStatus

public class WMSStatus
extends RemoteClientStatus

Describes the status of a WMSclient, so it adds to the Remote client status a list of layers, a list of layer styles, the extent of the map. Provides the functionality to modify these lists.

Constructor Summary

Constructors

Constructor and Description
WMSStatus()

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayerName(String _layerName) Adds a layer to the list of layers required by the WMS client
void	addStyleName(String _name) Adds a style name to the styles list required by the WMS client
Object	clone()
boolean	equals(Object obj)
Vector	getDimensions()
Rectangle2D	getExtent() Gets the extent defined by the map
Vector	getLayerNames() Retrieves the layer list required by the WMS client
String	getOnlineResource() Returns the URL that the server specified for a WMS request if any was described in its capabilities document.
Vector	getStyles() gets the styles list required by the WMS client
boolean	getTransparency()
boolean	isProjected()
boolean	isXyAxisOrder() Gets the behaviour of the WMS client with regards the axis order Returns true if the WMS parser should assume that the order of the coordinates follows the XY axis order (the first coordinate corresponds to the horizontal X axis, while the second coordinate corresponds to the vertical Y axis), regardless the protocol version and CRS in use.
boolean	removeLayerName(String _layerName) removes a layer from the layer list
boolean	removeStyleName(String _name) Removes a style from the list of styles required by the WMS client
void	setDimensions(Vector _dimensions) sets the styles list required by the WMS client
void	setExtent(Rectangle2D extent) Sets the extent defined by the map
void	setLayerNames(Vector _layers)
void	setOnlineResource(String url) Sets the string literal containing the URL of an online resource for a specific WMS request.
void	setProjected(boolean projected)
void	setStyles(Vector _styles) sets the styles list required by the WMS client
void	setTransparency(boolean wmsTransparency)
void	setXyAxisOrder(boolean assumeXY) Sets the behaviour of the WMS client with regards the axis order.

Methods inherited from class org.gvsig.remoteclient.RemoteClientStatus

getExceptionFormat, getFormat, getHeight, getInfoFormat, getProtocol, getSrs, getWidth, setExceptionFormat, setFormat, setHeight, setInfoFormat, setProtocol, setSrs, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

WMSStatus

public WMSStatus()

Method Detail

setLayerNames

public void setLayerNames(Vector _layers)

getLayerNames

public Vector getLayerNames()

Retrieves the layer list required by the WMS client

Returns:

Vector, the list of layers

addLayerName

public void addLayerName(String _layerName)

Adds a layer to the list of layers required by the WMS client

Parameters:

_layerName, - name of the layer to be added.

removeLayerName

public boolean removeLayerName(String _layerName)

removes a layer from the layer list

Parameters:

_layerName -

Returns:

true if the layer name has been deleted from the list

getStyles

public Vector getStyles()

gets the styles list required by the WMS client

Returns:

Vector with the list of layer styles

setStyles

public void setStyles(Vector _styles)

sets the styles list required by the WMS client

Parameters:

_styles, - list to be set as the required styles.

setDimensions

public void setDimensions(Vector _dimensions)

sets the styles list required by the WMS client

Parameters:

_styles, - list to be set as the required styles.

addStyleName

public void addStyleName(String _name)

Adds a style name to the styles list required by the WMS client

Parameters:

_name, - style name to be added

removeStyleName

public boolean removeStyleName(String _name)

Removes a style from the list of styles required by the WMS client

Parameters:

_name, - style name to be removed

getExtent

public Rectangle2D getExtent()

Gets the extent defined by the map

setExtent

public void setExtent(Rectangle2D extent)

Sets the extent defined by the map

getTransparency

public boolean getTransparency()

Returns:

setTransparency

public void setTransparency(boolean wmsTransparency)

Parameters:

wmsTransparency -

getDimensions

public Vector getDimensions()

Returns:

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Object clone()

Overrides:

clone in class Object

getOnlineResource

public String getOnlineResource()

Returns the URL that the server specified for a WMS request if any was described in its capabilities document.

Parameters:

operationName, - a String containing the name of the operation (case-independent)

Returns:

String containing the URL for this operationName or null if none was specified.

setOnlineResource

public void setOnlineResource(String url)

Sets the string literal containing the URL of an online resource for a specific WMS request.

Parameters:

operationName, - String telling to which request correspond the address

url, - String containing the URL for the given WMS request

isProjected

public boolean isProjected()

setProjected

public void setProjected(boolean projected)

isXyAxisOrder

public boolean isXyAxisOrder()

Gets the behaviour of the WMS client with regards the axis order

Returns true if the WMS parser should assume that the order of the coordinates follows the XY axis order (the first coordinate corresponds to the horizontal X axis, while the second coordinate corresponds to the vertical Y axis), regardless the protocol version and CRS in use.

Returns false if the WMS parser should decide the axis order based on the protocol version and the coordinate reference system (CRS) in use. In particular, if protocol version is >= 1.3.0, then the WMS parser assumes the axis order defined in the official EPSG registry for the CRS in use. For versions < 1.3.0, the XY axis order is assumed.

The default value is false

.

Returns:

See Also:

setXyAxisOrder(boolean)

setXyAxisOrder

public void setXyAxisOrder(boolean assumeXY)

Sets the behaviour of the WMS client with regards the axis order.

If set to true, then the XY axis order is assumed for all the WMS protocol versions and coordinate reference systems.

If set to false then the WMS parser will decide the axis order based on the protocol version and the coordinate reference system (CRS) in use. In particular, if protocol version is >= 1.3.0, then the WMS parser assumes the axis order defined in the official EPSG registry for the CRS in use. For versions < 1.3.0, the XY axis order is assumed.

Parameters:

assumeXY -

See Also:

isXyAxisOrder()