public class

GPRasterDataLayer

extends GPParameter
java.lang.Object
   ↳ com.esri.core.tasks.ags.geoprocessing.GPParameter
     ↳ com.esri.core.tasks.ags.geoprocessing.GPRasterDataLayer

Class Overview

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>
   } 
  }
 }
 

Summary

[Expand]
Inherited Constants
From class com.esri.core.tasks.ags.geoprocessing.GPParameter
[Expand]
Inherited Fields
From class com.esri.core.tasks.ags.geoprocessing.GPParameter
Public Constructors
GPRasterDataLayer(String paramName)
Constructor taking in a parameter name.
GPRasterDataLayer()
Constructs an empty GPRasterDataLayer object.
Public Methods
boolean equals(Object obj)
void fromJson(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.
[Expand]
Inherited Methods
From class com.esri.core.tasks.ags.geoprocessing.GPParameter
From class java.lang.Object

Public Constructors

public GPRasterDataLayer (String paramName)

Constructor taking in a parameter name.

Parameters
paramName String: parameter name.

public GPRasterDataLayer ()

Constructs an empty GPRasterDataLayer object.

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public void fromJson (JsonParser parser)

Method used to populate a GP Parameter.

Parameters
parser JsonParser: a Json Parser
Throws
Exception

public String generateValueParams ()

Method serializing GP parameter's values into a Json format.

Returns
String the Json String containing the GP parameter's values.
Throws
Exception

public String getFormat ()

Gets the format of the raster data.

Returns
String the format of the raster data.

public GPMapImage getMapImage ()

Gets the GPMapImage object.

Returns
GPMapImage the GPMapImage object.

public URL getRasterDataUrl ()

Gets the url to the raster data.

Returns
URL the url to the raster data.

public int hashCode ()

Returns
int

public void setFormat (String format)

Sets the format.

Parameters
format String: the format of the raster data.

public void setMapImage (GPMapImage mapImage)

Sets the GPMapImage object.

Parameters
mapImage GPMapImage: the mapImage to set

public void setRasterDataUrl (String rasterDataUrl)

Sets the URL to the raster data.

Parameters
rasterDataUrl String: URL to the raster data.