Package uk.ac.rdg.resc.edal.wms

Class GetMapStyleParams

java.lang.Object

uk.ac.rdg.resc.edal.wms.GetMapStyleParams

public class GetMapStyleParams
extends Object

Constructor Summary

Constructors

Constructor	Description
GetMapStyleParams(RequestParams params, WmsCatalogue catalogue)	Extract GetMap parameters from the URL, using a WmsCatalogue to determine default values.

Method Summary

Modifier and Type	Method	Description
static List<Extent<Float>>	getColorScaleRanges(RequestParams params, Extent<Float> defaultScale)	Gets the ColorScaleRange object requested by the client
MapImage	getImageGenerator(WmsCatalogue catalogue)	Gets the object used to generate the map plot with all correct styles and layers set.
String[]	getLayerNames()
int	getNumLayers()
int	getOpacity()	Return the opacity of the image as a percentage
String[]	getStyleNames()
boolean	isTransparent()
boolean	isXmlDefined()

Methods inherited from class java.lang.Object

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

Constructor Detail

GetMapStyleParams

public GetMapStyleParams(RequestParams params,
                         WmsCatalogue catalogue)
                  throws EdalException

Extract GetMap parameters from the URL, using a WmsCatalogue to determine default values.

Parameters:

params - The RequestParams object created from the URL request

catalogue - The WmsCatalogue from which to extract default values

Throws:

EdalException - If the request is not properly formed

Method Detail

getColorScaleRanges

public static List<Extent<Float>> getColorScaleRanges(RequestParams params,
                                                      Extent<Float> defaultScale)
                                               throws EdalException

Gets the ColorScaleRange object requested by the client

Throws:

EdalException

getImageGenerator

public MapImage getImageGenerator(WmsCatalogue catalogue)
                           throws EdalException

Gets the object used to generate the map plot with all correct styles and layers set.

Parameters:

catalogue - A WmsCatalogue used to get server-configured default values for each plotted layer

Returns:

A MapImage object

Throws:

EdalException - If invalid parameters have been supplied, or there are other issues with generating a MapImage object

isTransparent

public boolean isTransparent()

getOpacity

public int getOpacity()

Return the opacity of the image as a percentage

getNumLayers

public int getNumLayers()

isXmlDefined

public boolean isXmlDefined()

getLayerNames

public String[] getLayerNames()

getStyleNames

public String[] getStyleNames()