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

java.lang.Object
  com.esri.core.tasks.ags.geoprocessing.GPParameter
      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>
   } 
  }
 }
 

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.esri.core.tasks.ags.geoprocessing.GPParameter

dataType, DATATYPE_GPBOOLEAN, DATATYPE_GPDATAFILE, DATATYPE_GPDATE, DATATYPE_GPDOUBLE, DATATYPE_GPFEATURERECORDSETLAYER, DATATYPE_GPLINEARUNIT, DATATYPE_GPLONG, DATATYPE_GPMULTIVALUE, DATATYPE_GPRASTERDATA, DATATYPE_GPRASTERDATALAYER, DATATYPE_GPRECORDSET, DATATYPE_GPSTRING

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

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

Constructor Detail

GPRasterDataLayer

public GPRasterDataLayer(String paramName)

Constructor taking in a parameter name.

Parameters:

paramName - parameter name.

Since:

1.0

GPRasterDataLayer

public GPRasterDataLayer()

Constructs an empty GPRasterDataLayer object.

Since:

1.0

Method Detail

setRasterDataUrl

public void setRasterDataUrl(String rasterDataUrl)

Sets the url to the raster data

Parameters:

rasterDataUrl - url to the raster data.

Since:

1.0

setFormat

public void setFormat(String format)

Sets the format.

Parameters:

format - the format of the raster data.

Since:

1.0

getRasterDataUrl

public URL getRasterDataUrl()

Gets the url to the raster data.

Returns:

the url to the raster data.

Since:

1.0

getFormat

public String getFormat()

Gets the format of the raster data.

Returns:

the format of the raster data.

Since:

1.0

setMapImage

public void setMapImage(GPMapImage mapImage)

Sets the GPMapImage object.

Parameters:

mapImage - the mapImage to set

Since:

1.0

getMapImage

public GPMapImage getMapImage()

Gets the GPMapImage object.

Returns:

the GPMapImage object.

Since:

1.0

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

Since:

1.0

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

Since:

1.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.0

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

1.0