com.esri.core.tasks.ags.geoprocessing
Class GPRasterDataLayer

java.lang.Object
  extended by com.esri.core.tasks.ags.geoprocessing.GPParameter
      extended by com.esri.core.tasks.ags.geoprocessing.GPRasterDataLayer
All Implemented Interfaces:
Serializable

public class GPRasterDataLayer
extends GPParameter

Container class representing a Geo-Processing parameter of the type raster data layer.


This object can have 2 representations:
- if data is the return type selected, the format is as follow:

 {
 "paramName" : "<paramName>",
 "dataType" : "GPRasterDataLayer",
 "value" : { "url" : "<url>", "format" : "<format>" }
 }
 
- if data is NOT the return type selected, the format is as follow:
 {
 "paramName" : "<paramName>",
 "dataType" : "<GPRasterDataLayer | GPFeatureRecordSetLayer>",
 "value" : 
  { 
  "mapImage" : 
  {
  "href" : "<href>",
  "width" : <width>,
  "height" : <height>,
  "extent" : {<envelope>},
  "scale" : <scale>
   } 
  }
 }
 

See Also:
Serialized Form

Constructor Summary
GPRasterDataLayer()
          Constructs an empty GPRasterDataLayer object.
GPRasterDataLayer(String paramName)
          Constructor taking in a parameter name.
 
Method Summary
 boolean equals(Object obj)
           
 void fromJson(org.codehaus.jackson.JsonParser parser)
          Method used to populate a GP Parameter.
 String generateValueParams()
          Method serializing GP parameter's values into a Json format.
 String getFormat()
          Gets the format of the raster data.
 GPMapImage getMapImage()
          Gets the GPMapImage object.
 URL getRasterDataUrl()
          Gets the url to the raster data.
 int hashCode()
           
 void setFormat(String format)
          Sets the format.
 void setMapImage(GPMapImage mapImage)
          Sets the GPMapImage object.
 void setRasterDataUrl(String rasterDataUrl)
          Sets the url to the raster data
 
Methods inherited from class com.esri.core.tasks.ags.geoprocessing.GPParameter
createFromJson, generateRequestParams, getDataType, getParamName, setParamName
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GPRasterDataLayer

public GPRasterDataLayer(String paramName)
Constructor taking in a parameter name.

Parameters:
paramName - parameter name.

GPRasterDataLayer

public GPRasterDataLayer()
Constructs an empty GPRasterDataLayer object.

Method Detail

setRasterDataUrl

public void setRasterDataUrl(String rasterDataUrl)
Sets the url to the raster data

Parameters:
rasterDataUrl - url to the raster data.

setFormat

public void setFormat(String format)
Sets the format.

Parameters:
format - the format of the raster data.

getRasterDataUrl

public URL getRasterDataUrl()
Gets the url to the raster data.

Returns:
the url to the raster data.

getFormat

public String getFormat()
Gets the format of the raster data.

Returns:
the format of the raster data.

setMapImage

public void setMapImage(GPMapImage mapImage)
Sets the GPMapImage object.

Parameters:
mapImage - the mapImage to set

getMapImage

public GPMapImage getMapImage()
Gets the GPMapImage object.

Returns:
the GPMapImage object.

generateValueParams

public String generateValueParams()
                           throws Exception
Description copied from class: GPParameter
Method serializing GP parameter's values into a Json format.

Specified by:
generateValueParams in class GPParameter
Returns:
the Json String containing the GP parameter's values.
Throws:
Exception

fromJson

public void fromJson(org.codehaus.jackson.JsonParser parser)
              throws Exception
Description copied from class: GPParameter
Method used to populate a GP Parameter.

Specified by:
fromJson in class GPParameter
Parameters:
parser - a Json Parser
Throws:
Exception

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


Copyright © 2012. All Rights Reserved.