gistoolkit.server
Class MapRequest

java.lang.Object
  extended bygistoolkit.server.MapRequest

public class MapRequest
extends java.lang.Object

Holds the parameters for an OGIS complient Map Request.


Field Summary
static java.lang.String FORMAT_GIF
          Constant to use when requesting a GIF format.
static java.lang.String FORMAT_JPG
          Constant to use when requesting a JPG format.
static java.lang.String FORMAT_PNG
          Constant to use when requesting a PNG format.
static java.lang.String REQUEST_GET_CAPABILITIES
          Constant to use when requesting the capabilities XML.
static java.lang.String REQUEST_GET_FEATURE_INFO
          Constant to use when requesting information about a feature in a map.
static java.lang.String REQUEST_GET_MAP
          Constant to use when requesting a map.
 
Constructor Summary
MapRequest()
          Creates new MapRequest
MapRequest(java.lang.String inRequest)
          Creates new MapRequest of the given type
 
Method Summary
 java.awt.Color getBackgroundColor()
          Get the background color of the image.
 java.lang.String getCalledURL()
          Get the URL that was used to call this request.
 int getFeatureCount()
          Get the numbe of features to return information about.
 FilterInfo[] getFilters()
          Get the filters to apply to the layers.
 java.lang.String getFormat()
          Get the format of the output image.
 int getHeight()
          Get the heigth of the request result.
 java.lang.String[] getLayers()
          Get the layers to be included in the map, in the order in which they are to be included.
 double getMaxX()
          Get the maximum X coordinate.
 double getMaxY()
          Get the maximum Y coordinate.
 double getMinX()
          Get the minimum X coordinate.
 double getMinY()
          Get the minimumv Y coordinate.
 java.lang.String getRequest()
          Get the name of the request.
 java.lang.String getServiceName()
          Get the name of the service to which this request is addressed.
 java.lang.String getSRS()
          Get the Spatial Reference System Identifier.
 double getSRSLatitude()
          Get the SRSLatitude value for auto SRS's
 double getSRSLongitude()
          Get the SRSLongitude value for auto SRS's
 java.lang.String[] getStyles()
          Get the list of styles to apply to the layers.
 boolean getTransparent()
          Get the transparent value.
 int getWidth()
          Get the width of the requested result.
 int getXPoint()
          Get the X coordinate of the pixel of interest for a getInfo request.
 int getYPoint()
          Get the Y coordinate of the pixel of interest for a getInfo request.
 boolean isSRSAuto()
          Returns true is there is a latitude and longitude available.
 void setBackgroundColor(java.awt.Color inColor)
          Sets the background color of the image.
 void setCalledURL(java.lang.String inCalledURL)
          Set the URL that was used to call this request.
 void setFeatureCount(int inFeatureCount)
          Set the number of features to return information about.
 void setFilters(FilterInfo[] inFilters)
          Set the filters to apply to the layers.
 void setFormat(java.lang.String inFormat)
          Set the format of the output image.
 void setHeight(int inHeight)
          Set the height of the requested result.
 void setLayers(java.lang.String[] inLayers)
          Set the layers to be included in the map, in the order in which they are to be included.
 void setMaxX(double inMaxX)
          Set the maximum X coordinate.
 void setMaxY(double inMaxY)
          Set the maximum Y coordinate.
 void setMinX(double inMinX)
          Set the minimum X coordinate.
 void setMinY(double inMinY)
          Set the minimum Y coordinate.
 void setRequest(java.lang.String inRequest)
          Set the name of the request.
 void setServiceName(java.lang.String inServiceName)
          Set the name of the service to which this request is addressed.
 void setSRS(java.lang.String inSRS)
          Set the Spatial Reference System Identifier.
 void setSRSAuto(boolean inAuto)
          Set to true for an AUTO SRS that allows specification of latitude and longitude.
 void setSRSLatitude(double inLatitude)
          Set the SRSLatitude value for auto SRS's
 void setSRSLongitude(double inLongitude)
          Set the SRSLongitude value for auto SRS's
 void setStyles(java.lang.String[] inStyles)
          Set the styles to apply to the layers.
 void setTransparent(boolean inTransparent)
          Set the transparent value, only valid for Gif and PDF.
 void setWidth(int inWidth)
          Set the width of the requested result.
 void setXPoint(int inXPoint)
          Set the X coordinate of the pixel of interest.
 void setYPoint(int inYPoint)
          Set the Y coordinate of the pixel of interest.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REQUEST_GET_MAP

public static final java.lang.String REQUEST_GET_MAP
Constant to use when requesting a map.

See Also:
Constant Field Values

REQUEST_GET_CAPABILITIES

public static final java.lang.String REQUEST_GET_CAPABILITIES
Constant to use when requesting the capabilities XML.

See Also:
Constant Field Values

REQUEST_GET_FEATURE_INFO

public static final java.lang.String REQUEST_GET_FEATURE_INFO
Constant to use when requesting information about a feature in a map.

See Also:
Constant Field Values

FORMAT_PNG

public static final java.lang.String FORMAT_PNG
Constant to use when requesting a PNG format.

See Also:
Constant Field Values

FORMAT_JPG

public static final java.lang.String FORMAT_JPG
Constant to use when requesting a JPG format.

See Also:
Constant Field Values

FORMAT_GIF

public static final java.lang.String FORMAT_GIF
Constant to use when requesting a GIF format.

See Also:
Constant Field Values
Constructor Detail

MapRequest

public MapRequest()
Creates new MapRequest


MapRequest

public MapRequest(java.lang.String inRequest)
Creates new MapRequest of the given type

Method Detail

setServiceName

public void setServiceName(java.lang.String inServiceName)
Set the name of the service to which this request is addressed.


getServiceName

public java.lang.String getServiceName()
Get the name of the service to which this request is addressed.


setRequest

public void setRequest(java.lang.String inRequest)
Set the name of the request.


getRequest

public java.lang.String getRequest()
Get the name of the request.


setLayers

public void setLayers(java.lang.String[] inLayers)
Set the layers to be included in the map, in the order in which they are to be included.


getLayers

public java.lang.String[] getLayers()
Get the layers to be included in the map, in the order in which they are to be included.


setStyles

public void setStyles(java.lang.String[] inStyles)
Set the styles to apply to the layers.


getStyles

public java.lang.String[] getStyles()
Get the list of styles to apply to the layers.


setFilters

public void setFilters(FilterInfo[] inFilters)
Set the filters to apply to the layers.


getFilters

public FilterInfo[] getFilters()
Get the filters to apply to the layers.


setSRS

public void setSRS(java.lang.String inSRS)
Set the Spatial Reference System Identifier.


getSRS

public java.lang.String getSRS()
Get the Spatial Reference System Identifier.


setSRSLongitude

public void setSRSLongitude(double inLongitude)
Set the SRSLongitude value for auto SRS's


getSRSLongitude

public double getSRSLongitude()
Get the SRSLongitude value for auto SRS's


setSRSLatitude

public void setSRSLatitude(double inLatitude)
Set the SRSLatitude value for auto SRS's


getSRSLatitude

public double getSRSLatitude()
Get the SRSLatitude value for auto SRS's


setSRSAuto

public void setSRSAuto(boolean inAuto)
Set to true for an AUTO SRS that allows specification of latitude and longitude.


isSRSAuto

public boolean isSRSAuto()
Returns true is there is a latitude and longitude available.


setMaxX

public void setMaxX(double inMaxX)
Set the maximum X coordinate.


getMaxX

public double getMaxX()
Get the maximum X coordinate.


setMinX

public void setMinX(double inMinX)
Set the minimum X coordinate.


getMinX

public double getMinX()
Get the minimum X coordinate.


setMaxY

public void setMaxY(double inMaxY)
Set the maximum Y coordinate.


getMaxY

public double getMaxY()
Get the maximum Y coordinate.


setMinY

public void setMinY(double inMinY)
Set the minimum Y coordinate.


getMinY

public double getMinY()
Get the minimumv Y coordinate.


setWidth

public void setWidth(int inWidth)
Set the width of the requested result.


getWidth

public int getWidth()
Get the width of the requested result.


getHeight

public int getHeight()
Get the heigth of the request result.


setHeight

public void setHeight(int inHeight)
Set the height of the requested result.


setFormat

public void setFormat(java.lang.String inFormat)
Set the format of the output image.


getFormat

public java.lang.String getFormat()
Get the format of the output image.


setTransparent

public void setTransparent(boolean inTransparent)
Set the transparent value, only valid for Gif and PDF.


getTransparent

public boolean getTransparent()
Get the transparent value.


setBackgroundColor

public void setBackgroundColor(java.awt.Color inColor)
Sets the background color of the image.


getBackgroundColor

public java.awt.Color getBackgroundColor()
Get the background color of the image.


setCalledURL

public void setCalledURL(java.lang.String inCalledURL)
Set the URL that was used to call this request.


getCalledURL

public java.lang.String getCalledURL()
Get the URL that was used to call this request.


setFeatureCount

public void setFeatureCount(int inFeatureCount)
Set the number of features to return information about.


getFeatureCount

public int getFeatureCount()
Get the numbe of features to return information about.


setXPoint

public void setXPoint(int inXPoint)
Set the X coordinate of the pixel of interest.


getXPoint

public int getXPoint()
Get the X coordinate of the pixel of interest for a getInfo request.


setYPoint

public void setYPoint(int inYPoint)
Set the Y coordinate of the pixel of interest.


getYPoint

public int getYPoint()
Get the Y coordinate of the pixel of interest for a getInfo request.