ucar.unidata.data.gis

Class WmsSelection

java.lang.Object

ucar.unidata.data.gis.WmsSelection

Direct Known Subclasses:

WMSInfo

public class WmsSelection
extends java.lang.Object

Class for controlling the display of color images.

Version:

$Revision: 1.12 $

Author:

Jeff McWhirter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_BBOX xml attribute name
static java.lang.String	ATTR_CRS crs attribute
static java.lang.String	ATTR_FORMAT xml attribute name
static java.lang.String	ATTR_LAYER xml attribute name
static java.lang.String	ATTR_LEGENDURL xml tag name
static java.lang.String	ATTR_OPAQUE xml attribute name
static java.lang.String	ATTR_SERVER xml tag name
static java.lang.String	ATTR_SRS xml attribute name
static java.lang.String	ATTR_TITLE xml attribute name
static java.lang.String	ATTR_VERSION xml attribute name
static java.lang.String	TAG_BACKGROUNDWMS xml tag name
static java.lang.String	TAG_IMAGE xml tag name
static java.lang.String	TAG_WMS xml tag name

Constructor Summary

Constructors

Constructor and Description
WmsSelection() Default constructor.
WmsSelection(java.lang.String layer, java.lang.String title, java.lang.String imageFile) Create a WmsSelection from the specification
WmsSelection(java.lang.String server, java.lang.String layer, java.lang.String title, java.lang.String srs, java.lang.String format, java.lang.String version, GeoLocationInfo bounds) Constructor.

Method Summary

Modifier and Type	Method and Description
void	appendLayer(java.lang.String layerName, GeoLocationInfo thatBounds) Append the given layer to our layer name.
java.lang.String	assembleRequest(GeoLocationInfo boundsToUse, int imageWidth, int imageHeight) Create the wms request
boolean	equals(java.lang.Object o) Overwrite
boolean	getAllowSubsets() Get the AllowSubsets property.
GeoLocationInfo	getBounds() Get the Bounds property.
java.lang.String	getDescription() Get the Description property.
int	getFixedHeight() Get the FixedHeight property.
int	getFixedWidth() Get the FixedWidth property.
java.lang.String	getFormat() Get the Format property.
java.lang.String	getImageFile() Get the ImageFile property.
java.lang.String	getLayer() Get the Layer property.
java.lang.String	getLegendIcon() Get the LegendIcon property.
int	getOpaque() Get the Opaque property.
java.lang.String	getServer() Get the Server property.
java.lang.String	getSRS() Get the srs property.
java.util.List	getTimeList() Get the TimeList property.
java.lang.String	getTitle() Get the Title property.
java.lang.String	getVersion() Get the Version property.
int	hashCode() Overwrite
boolean	isFixedImage() Is this a fixed image
static java.util.List	parseWmsResources(XmlResourceCollection xrc) Process the xms xml resources
void	setAllowSubsets(boolean value) Set the AllowSubsets property.
void	setBounds(GeoLocationInfo value) Set the Bounds property.
void	setDescription(java.lang.String value) Set the Description property.
void	setFixedHeight(int value) Set the FixedHeight property.
void	setFixedWidth(int value) Set the FixedWidth property.
void	setFormat(java.lang.String value) Set the Format property.
void	setImageFile(java.lang.String value) Set the ImageFile property.
void	setLayer(java.lang.String value) Set the Layer property.
void	setLegendIcon(java.lang.String value) Set the LegendIcon property.
void	setOpaque(int value) Set the Opaque property.
void	setServer(java.lang.String value) Set the Server property.
void	setSRS(java.lang.String value) Set the srs property.
void	setTimeList(java.util.List value) Set the TimeList property.
void	setTitle(java.lang.String value) Set the Title property.
void	setVersion(java.lang.String value) Set the Version property.
java.lang.String	toString() to string

Methods inherited from class java.lang.Object

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

Field Detail

TAG_BACKGROUNDWMS

public static final java.lang.String TAG_BACKGROUNDWMS

xml tag name

See Also:

Constant Field Values

TAG_WMS

public static final java.lang.String TAG_WMS

xml tag name

See Also:

Constant Field Values

TAG_IMAGE

public static final java.lang.String TAG_IMAGE

xml tag name

See Also:

Constant Field Values

ATTR_SERVER

public static final java.lang.String ATTR_SERVER

xml tag name

See Also:

Constant Field Values

ATTR_LEGENDURL

public static final java.lang.String ATTR_LEGENDURL

xml tag name

See Also:

Constant Field Values

ATTR_LAYER

public static final java.lang.String ATTR_LAYER

xml attribute name

See Also:

Constant Field Values

ATTR_TITLE

public static final java.lang.String ATTR_TITLE

xml attribute name

See Also:

Constant Field Values

ATTR_SRS

public static final java.lang.String ATTR_SRS

xml attribute name

See Also:

Constant Field Values

ATTR_CRS

public static final java.lang.String ATTR_CRS

crs attribute

See Also:

Constant Field Values

ATTR_FORMAT

public static final java.lang.String ATTR_FORMAT

xml attribute name

See Also:

Constant Field Values

ATTR_VERSION

public static final java.lang.String ATTR_VERSION

xml attribute name

See Also:

Constant Field Values

ATTR_BBOX

public static final java.lang.String ATTR_BBOX

xml attribute name

See Also:

Constant Field Values

ATTR_OPAQUE

public static final java.lang.String ATTR_OPAQUE

xml attribute name

See Also:

Constant Field Values

Constructor Detail

WmsSelection

public WmsSelection()

Default constructor.

WmsSelection

public WmsSelection(java.lang.String layer,
                    java.lang.String title,
                    java.lang.String imageFile)

Create a WmsSelection from the specification

Parameters:

layer - the layer

title - the title

imageFile - the image file

WmsSelection

public WmsSelection(java.lang.String server,
                    java.lang.String layer,
                    java.lang.String title,
                    java.lang.String srs,
                    java.lang.String format,
                    java.lang.String version,
                    GeoLocationInfo bounds)

Constructor.

Parameters:

server - The server

layer - The layer

title - The title

srs - The srs

format - The format

version - The version

bounds - The bounds

Method Detail

appendLayer

public void appendLayer(java.lang.String layerName,
                        GeoLocationInfo thatBounds)

Append the given layer to our layer name. Union the bounds

Parameters:

layerName - layer name to append

thatBounds - its bounds

isFixedImage

public boolean isFixedImage()

Is this a fixed image

Returns:

true if fixed image

assembleRequest

public java.lang.String assembleRequest(GeoLocationInfo boundsToUse,
                                        int imageWidth,
                                        int imageHeight)

Create the wms request

Parameters:

boundsToUse - The bounds to use

imageWidth - The width

imageHeight - The height

Returns:

The request url

setServer

public void setServer(java.lang.String value)

Set the Server property.

Parameters:

value - The new value for Server

getServer

public java.lang.String getServer()

Get the Server property.

Returns:

The Server

setSRS

public void setSRS(java.lang.String value)

Set the srs property.

Parameters:

value - The new value for srs

getSRS

public java.lang.String getSRS()

Get the srs property.

Returns:

The srs

setLayer

public void setLayer(java.lang.String value)

Set the Layer property.

Parameters:

value - The new value for Layer

getLayer

public java.lang.String getLayer()

Get the Layer property.

Returns:

The Layer

setBounds

public void setBounds(GeoLocationInfo value)

Set the Bounds property.

Parameters:

value - The new value for Bounds

getBounds

public GeoLocationInfo getBounds()

Get the Bounds property.

Returns:

The Bounds

setFormat

public void setFormat(java.lang.String value)

Set the Format property.

Parameters:

value - The new value for Format

getFormat

public java.lang.String getFormat()

Get the Format property.

Returns:

The Format

setTitle

public void setTitle(java.lang.String value)

Set the Title property.

Parameters:

value - The new value for Title

getTitle

public java.lang.String getTitle()

Get the Title property.

Returns:

The Title

setVersion

public void setVersion(java.lang.String value)

Set the Version property.

Parameters:

value - The new value for Version

getVersion

public java.lang.String getVersion()

Get the Version property.

Returns:

The Version

toString

public java.lang.String toString()

to string

Overrides:

toString in class java.lang.Object

Returns:

the title

parseWmsResources

public static java.util.List parseWmsResources(XmlResourceCollection xrc)

Process the xms xml resources

Parameters:

xrc - The resources

Returns:

List of WmsSelection objects defined by the xml resources

setFixedWidth

public void setFixedWidth(int value)

Set the FixedWidth property.

Parameters:

value - The new value for FixedWidth

getFixedWidth

public int getFixedWidth()

Get the FixedWidth property.

Returns:

The FixedWidth

setOpaque

public void setOpaque(int value)

Set the Opaque property.

Parameters:

value - The new value for FixedWidth

getOpaque

public int getOpaque()

Get the Opaque property.

Returns:

The Opaque

setFixedHeight

public void setFixedHeight(int value)

Set the FixedHeight property.

Parameters:

value - The new value for FixedHeight

getFixedHeight

public int getFixedHeight()

Get the FixedHeight property.

Returns:

The FixedHeight

setAllowSubsets

public void setAllowSubsets(boolean value)

Set the AllowSubsets property.

Parameters:

value - The new value for AllowSubsets

getAllowSubsets

public boolean getAllowSubsets()

Get the AllowSubsets property.

Returns:

The AllowSubsets

setDescription

public void setDescription(java.lang.String value)

Set the Description property.

Parameters:

value - The new value for Description

getDescription

public java.lang.String getDescription()

Get the Description property.

Returns:

The Description

setLegendIcon

public void setLegendIcon(java.lang.String value)

Set the LegendIcon property.

Parameters:

value - The new value for LegendIcon

getLegendIcon

public java.lang.String getLegendIcon()

Get the LegendIcon property.

Returns:

The LegendIcon

setTimeList

public void setTimeList(java.util.List value)

Set the TimeList property.

Parameters:

value - The new value for TimeList

getTimeList

public java.util.List getTimeList()

Get the TimeList property.

Returns:

The TimeList

hashCode

public int hashCode()

Overwrite

Overrides:

hashCode in class java.lang.Object

Returns:

hashcode

setImageFile

public void setImageFile(java.lang.String value)

Set the ImageFile property.

Parameters:

value - The new value for ImageFile

getImageFile

public java.lang.String getImageFile()

Get the ImageFile property.

Returns:

The ImageFile

equals

public boolean equals(java.lang.Object o)

Overwrite

Overrides:

equals in class java.lang.Object

Parameters:

o - the object

Returns:

is equals