org.gvsig.raster.wms.io

Class WMSDataParametersImpl

java.lang.Object

org.gvsig.fmap.dal.spi.AbstractDataParameters

org.gvsig.fmap.dal.spi.AbstractDataStoreParameters

org.gvsig.raster.impl.store.AbstractRasterDataParameters

org.gvsig.raster.wms.io.WMSDataParametersImpl

All Implemented Interfaces:

RasterDataParameters, RemoteStoreParameters, DataParameters, DataStoreParameters, SupportFromJson, SupportToJson, WMSDataParameters, DynObject, Persistent, Validator

public class WMSDataParametersImpl
extends AbstractRasterDataParameters
implements WMSDataParameters

Parameters for the WMS provider

Field Summary

Fields

Modifier and Type	Field and Description
protected static DynClass	DYNCLASS
static java.lang.String	DYNFIELDNAME_AUTHENTICATION_CONFIG
static java.lang.String	FIELD_LAYERQUERY

Fields inherited from class org.gvsig.raster.impl.store.AbstractRasterDataParameters

PERSISTENT_DESCRIPTION, PERSISTENT_NAME

Fields inherited from interface org.gvsig.fmap.dal.DataParameters

CRS_PARAMTER_NAME

Fields inherited from interface org.gvsig.fmap.dal.coverage.store.parameter.RasterDataParameters

DONT_CHANGE_PROJECTION, FIELD_CRS, FIELD_RMF_FOLDER, FIELD_URI, NEW_PROJETION_TO_THE_LAYER, NOT_LOAD, ON_THE_FLY, REPROJECT_DATA, REPROJECT_VIEW

Constructor Summary

Constructors

Constructor and Description
WMSDataParametersImpl()

Method Summary

Modifier and Type	Method and Description
void	assignFields(RasterDataParameters par, RasterDataServerExplorer explorer) Assigns field from a data parameters to other
WMSDataParameters	clone() Clones this RemoteStoreParameters
void	deleteCache(boolean deleteCache) Sets the flag to delete cache
ICancellable	getCancellable()
java.lang.String	getDataStoreName() Returns the DataStore's name
protected DelegatedDynObject	getDelegatedDynObject() Returns an instance of the DynObject to delegate to.
java.lang.String	getDescription() Returns the DataStore's description
java.util.Vector<java.lang.String>	getDimensions() Gets the dimension vector that is a list of key-value pairs containing the name of the dimension and the value for it
java.lang.String	getExplorerName()
java.awt.geom.Rectangle2D	getExtent() Gets the bounding box
java.awt.Dimension	getFixedSize() Gets the value of the fixed size
java.lang.String	getFormat() Gets the format
int	getHeight() Gets the height
java.lang.String	getInfoFormat() Gets the info by point format
java.lang.String	getInfoLayerQuery()
java.lang.String	getLayerQuery()
java.lang.String	getName()
java.util.Map<java.lang.String,java.lang.String>	getOnlineResource() Gets the online resource map
java.lang.String	getOnlineResource(java.lang.String operation) Gets the URL that should be accessed for an operation performed to the server.
java.lang.String	getSRSCode() Devuelve el SRS.
java.util.List<RemoteWMSStyle>	getStyles()
int	getWidth() Gets the width
protected void	initialize()
boolean	isDeletingCache() Gets true if the cache is going to be deleted
boolean	isOverridingHost()
boolean	isQueryable() If it is true, this layer accepts GetFeatureInfo operations.
boolean	isSizeFixed() Tells whether if this layer must deal with the server with the constant-size limitations or not.
boolean	isValid() Indicates whether these parameters are valid.
boolean	isWmsTransparent()
boolean	isXyAxisOrder() Gets the behaviour of the parser 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.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
static DynStruct	registerDynClass()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setCancellable(ICancellable cancel)
void	setDimensions(java.util.Vector<java.lang.String> dimensions) Sets the dimension vector that is a list of key-value pairs containing the name of the dimension and the value for it
void	setExtent(java.awt.geom.Rectangle2D bBox) Assigns the extent.
void	setFixedSize(java.awt.Dimension sz) When a server is not fully featured and it only can serve constant map sizes this value must be set.
void	setFormat(java.lang.String format) Sets the format
void	setHeight(int h) Sets the height When a provider is initialized this will need to know what is the height before the request.
void	setInfoFormat(java.lang.String format) Sets the info by point format
void	setInfoLayerQuery(java.lang.String infoLayerQuery)
void	setLayerQuery(java.lang.String layerQuery)
void	setName(java.lang.String name)
void	setOnlineResources(java.util.Map<java.lang.String,java.lang.String> onlineResources) Sets the set of URLs that should be accessed for each operation performed to the server.
void	setOverrideHost(boolean over)
void	setQueryable(boolean b) If it is true, this layer accepts GetFeatureInfo operations.
void	setSRS(java.lang.String m_srs) Inserta el SRS.
void	setSRSID(java.lang.String srsid)
void	setStyles(java.util.List<RemoteWMSStyle> styles)
void	setWidth(int w) Sets the width When a provider is initialized this will need to know what is the width before the request.
void	setWmsTransparency(boolean wmsTransparency)
void	setXyAxisOrder(boolean assumeXY) Sets the behaviour of the parser with regards the axis order.

Methods inherited from class org.gvsig.raster.impl.store.AbstractRasterDataParameters

getAlphaBand, getFrame, getReprojectionOption, getRMFFolder, getSRS, getSRSID, getURI, isSourceTiled, isVisible, registerDynClass, setAlphaBand, setFrame, setReprojectionOption, setRMFFolder, setSRS, setURI, setVisible

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataStoreParameters

getSourceId, isTheSameStore

Methods inherited from class org.gvsig.fmap.dal.spi.AbstractDataParameters

clear, copyValuesTo, delegate, equals, fromByteArray, fromJson, getCause, getCopy, getDynClass, getDynValue, getMessage, getProviderName, hasDynValue, hashCode, implement, invokeDynMethod, invokeDynMethod, isValid, loadPRJ, loadWLD, setDynValue, toByteArray, toJson, toJsonBuilder, toString, toString, validate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gvsig.raster.wms.io.WMSDataParameters

getSRS, getURI, setURI

Methods inherited from interface org.gvsig.fmap.dal.coverage.store.parameter.RemoteStoreParameters

getAlphaBand, getFrame, setAlphaBand, setFrame

Methods inherited from interface org.gvsig.fmap.dal.DataStoreParameters

getProviderName, getSourceId, isTheSameStore

Methods inherited from interface org.gvsig.fmap.dal.DataParameters

clear, getCopy, toByteArray, toString, validate

Methods inherited from interface org.gvsig.tools.dynobject.DynObject

clone, delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue

Methods inherited from interface org.gvsig.json.SupportToJson

toJson, toJson, toJsonBuilder, toJsonBuilder

Methods inherited from interface org.gvsig.json.SupportFromJson

fromJson

Field Detail

FIELD_LAYERQUERY

public static final java.lang.String FIELD_LAYERQUERY

See Also:

Constant Field Values

DYNFIELDNAME_AUTHENTICATION_CONFIG

public static final java.lang.String DYNFIELDNAME_AUTHENTICATION_CONFIG

See Also:

Constant Field Values

DYNCLASS

protected static DynClass DYNCLASS

Constructor Detail

WMSDataParametersImpl

public WMSDataParametersImpl()

Method Detail

initialize

protected void initialize()

registerDynClass

public static DynStruct registerDynClass()

getFormat

public java.lang.String getFormat()

Gets the format

Specified by:

getFormat in interface WMSDataParameters

Returns:

setFormat

public void setFormat(java.lang.String format)

Sets the format

Specified by:

setFormat in interface WMSDataParameters

Parameters:

format -

getInfoFormat

public java.lang.String getInfoFormat()

Gets the info by point format

Specified by:

getInfoFormat in interface WMSDataParameters

Returns:

setInfoFormat

public void setInfoFormat(java.lang.String format)

Sets the info by point format

Specified by:

setInfoFormat in interface WMSDataParameters

getLayerQuery

public java.lang.String getLayerQuery()

Specified by:

getLayerQuery in interface WMSDataParameters

setLayerQuery

public void setLayerQuery(java.lang.String layerQuery)

Specified by:

setLayerQuery in interface WMSDataParameters

getSRSCode

public java.lang.String getSRSCode()

Devuelve el SRS.

Specified by:

getSRSCode in interface WMSDataParameters

Returns:

SRS.

setSRS

public void setSRS(java.lang.String m_srs)

Inserta el SRS.

Specified by:

setSRS in interface WMSDataParameters

Parameters:

m_srs - SRS.

setSRSID

public void setSRSID(java.lang.String srsid)

Specified by:

setSRSID in interface RasterDataParameters

Overrides:

setSRSID in class AbstractRasterDataParameters

getName

public java.lang.String getName()

Specified by:

getName in interface WMSDataParameters

setName

public void setName(java.lang.String name)

Specified by:

setName in interface WMSDataParameters

isWmsTransparent

public boolean isWmsTransparent()

Specified by:

isWmsTransparent in interface WMSDataParameters

Returns:

Returns the wmsTransparency.

setWmsTransparency

public void setWmsTransparency(boolean wmsTransparency)

Specified by:

setWmsTransparency in interface WMSDataParameters

Parameters:

wmsTransparency - The wmsTransparency to set.

getInfoLayerQuery

public java.lang.String getInfoLayerQuery()

Specified by:

getInfoLayerQuery in interface WMSDataParameters

setInfoLayerQuery

public void setInfoLayerQuery(java.lang.String infoLayerQuery)

Specified by:

setInfoLayerQuery in interface WMSDataParameters

setQueryable

public void setQueryable(boolean b)

If it is true, this layer accepts GetFeatureInfo operations. This WMS operations maps to FMap's infoByPoint(p) operation.

Specified by:

setQueryable in interface WMSDataParameters

Parameters:

b -

setCancellable

public void setCancellable(ICancellable cancel)

Specified by:

setCancellable in interface WMSDataParameters

getCancellable

public ICancellable getCancellable()

Specified by:

getCancellable in interface WMSDataParameters

isQueryable

public boolean isQueryable()

Description copied from interface: WMSDataParameters

If it is true, this layer accepts GetFeatureInfo operations. This WMS operations maps to FMap's infoByPoint(p) operation.

Specified by:

isQueryable in interface WMSDataParameters

isOverridingHost

public boolean isOverridingHost()

Specified by:

isOverridingHost in interface RasterDataParameters

setOverrideHost

public void setOverrideHost(boolean over)

Specified by:

setOverrideHost in interface RasterDataParameters

Specified by:

setOverrideHost in interface WMSDataParameters

setStyles

public void setStyles(java.util.List<RemoteWMSStyle> styles)

Specified by:

setStyles in interface WMSDataParameters

getStyles

public java.util.List<RemoteWMSStyle> getStyles()

Specified by:

getStyles in interface WMSDataParameters

Parameters:

styles -

setDimensions

public void setDimensions(java.util.Vector<java.lang.String> dimensions)

Description copied from interface: WMSDataParameters

Sets the dimension vector that is a list of key-value pairs containing the name of the dimension and the value for it

Specified by:

setDimensions in interface WMSDataParameters

getDimensions

public java.util.Vector<java.lang.String> getDimensions()

Gets the dimension vector that is a list of key-value pairs containing the name of the dimension and the value for it

Specified by:

getDimensions in interface WMSDataParameters

Returns:

setOnlineResources

public void setOnlineResources(java.util.Map<java.lang.String,java.lang.String> onlineResources)

Description copied from interface: WMSDataParameters

Sets the set of URLs that should be accessed for each operation performed to the server.

Specified by:

setOnlineResources in interface WMSDataParameters

getOnlineResource

public java.lang.String getOnlineResource(java.lang.String operation)

Description copied from interface: WMSDataParameters

Gets the URL that should be accessed for an operation performed to the server.

Specified by:

getOnlineResource in interface WMSDataParameters

getOnlineResource

public java.util.Map<java.lang.String,java.lang.String> getOnlineResource()

Description copied from interface: WMSDataParameters

Gets the online resource map

Specified by:

getOnlineResource in interface WMSDataParameters

setFixedSize

public void setFixedSize(java.awt.Dimension sz)

When a server is not fully featured and it only can serve constant map sizes this value must be set. It expresses the size in pixels (width, height) that the map will be requested.

Specified by:

setFixedSize in interface WMSDataParameters

Parameters:

Dimension - sz

isSizeFixed

public boolean isSizeFixed()

Tells whether if this layer must deal with the server with the constant-size limitations or not.

Specified by:

isSizeFixed in interface RemoteStoreParameters

Returns:

boolean.

getFixedSize

public java.awt.Dimension getFixedSize()

Gets the value of the fixed size

Specified by:

getFixedSize in interface WMSDataParameters

Returns:

setExtent

public void setExtent(java.awt.geom.Rectangle2D bBox)

Assigns the extent. When a provider is initialized this will need to know what is the extent before the request.

Specified by:

setExtent in interface WMSDataParameters

Parameters:

bBox -

setWidth

public void setWidth(int w)

Description copied from interface: RemoteStoreParameters

Sets the width When a provider is initialized this will need to know what is the width before the request.

Specified by:

setWidth in interface RemoteStoreParameters

setHeight

public void setHeight(int h)

Description copied from interface: RemoteStoreParameters

Sets the height When a provider is initialized this will need to know what is the height before the request.

Specified by:

setHeight in interface RemoteStoreParameters

getExtent

public java.awt.geom.Rectangle2D getExtent()

Gets the bounding box

Specified by:

getExtent in interface WMSDataParameters

Returns:

getWidth

public int getWidth()

Gets the width

Specified by:

getWidth in interface WMSDataParameters

Returns:

getHeight

public int getHeight()

Gets the height

Specified by:

getHeight in interface WMSDataParameters

Returns:

getDataStoreName

public java.lang.String getDataStoreName()

Description copied from interface: DataStoreParameters

Returns the DataStore's name

Specified by:

getDataStoreName in interface DataStoreParameters

Overrides:

getDataStoreName in class AbstractDataParameters

Returns:

a String containing the DataStore's name

getDescription

public java.lang.String getDescription()

Description copied from interface: DataStoreParameters

Returns the DataStore's description

Specified by:

getDescription in interface DataStoreParameters

Overrides:

getDescription in class AbstractDataParameters

Returns:

a String containing the DataStore's description

getExplorerName

public java.lang.String getExplorerName()

isValid

public boolean isValid()

Description copied from interface: DataStoreParameters

Indicates whether these parameters are valid.

Specified by:

isValid in interface RasterDataParameters

Specified by:

isValid in interface DataStoreParameters

Overrides:

isValid in class AbstractRasterDataParameters

Returns:

true if these parameters are valid, false if not.

getDelegatedDynObject

protected DelegatedDynObject getDelegatedDynObject()

Description copied from class: AbstractDataParameters

Returns an instance of the DynObject to delegate to.

Specified by:

getDelegatedDynObject in class AbstractDataParameters

Returns:

the delegate DynObject

deleteCache

public void deleteCache(boolean deleteCache)

Description copied from interface: RemoteStoreParameters

Sets the flag to delete cache

Specified by:

deleteCache in interface RemoteStoreParameters

isDeletingCache

public boolean isDeletingCache()

Description copied from interface: RemoteStoreParameters

Gets true if the cache is going to be deleted

Specified by:

isDeletingCache in interface RemoteStoreParameters

Returns:

clone

public WMSDataParameters clone()

Description copied from interface: RemoteStoreParameters

Clones this RemoteStoreParameters

Specified by:

clone in interface RemoteStoreParameters

Overrides:

clone in class java.lang.Object

Returns:

assignFields

public void assignFields(RasterDataParameters par,
                         RasterDataServerExplorer explorer)

Description copied from interface: RasterDataParameters

Assigns field from a data parameters to other

Specified by:

assignFields in interface RasterDataParameters

Overrides:

assignFields in class AbstractRasterDataParameters

isXyAxisOrder

public boolean isXyAxisOrder()

Description copied from interface: WMSDataParameters

Gets the behaviour of the parser 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

.

Specified by:

isXyAxisOrder in interface WMSDataParameters

Returns:

See Also:

WMSDataParameters.setXyAxisOrder(boolean)

setXyAxisOrder

public void setXyAxisOrder(boolean assumeXY)

Description copied from interface: WMSDataParameters

Sets the behaviour of the parser 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.

Specified by:

setXyAxisOrder in interface WMSDataParameters

See Also:

WMSDataParameters.isXyAxisOrder()

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Overrides:

saveToState in class AbstractDataParameters

Throws:

PersistenceException

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Overrides:

loadFromState in class AbstractDataParameters

Throws:

PersistenceException