public class

GPFeatureRecordSetLayer

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

Class Overview

Container class representing a Geo-Processing parameter of the type Graphic record set layer.


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

 {
 "paramName" : "<paramName>",
 "dataType" : "GPFeatureRecordSetLayer",
 "value" : 
  { 
  "geometryType" : "<geometryType>",
  "spatialReference" : {<spatialReference>}, 
  "features" : [
  { 
  "geometry" : {<geometry1>},
  "attributes" : 
  {
  "<field1>" : <value11>, 
  "<field2>" : <value12>
   }
   },
  { 
  "geometry" : {<geometry2>},
  "attributes" : 
  {
  "<field1>" : <value21>, 
  "<field2>" : <value22>
   }
   } 
  ] 
  }
 }
- 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
GPFeatureRecordSetLayer(String paramName)
Constructor taking in the name of the parameter.
GPFeatureRecordSetLayer()
Constructs an empty GPFeatureRecordSetLayer object.
Public Methods
void addGraphic(Graphic graphic)
Convenient method to add a Graphic to a GPFeatureRecordSetLayer.
boolean equals(Object obj)
void fromJson(JsonParser parser)
Method used to populate a GP Parameter.
Map<String, String> generateRequestParams()
Generate request parameters in the form of map which contains three entried: parameter name, date type and value.
String generateValueParams()
Method serializing GP parameter's values into a Json format.
Geometry.Type getGeometryType()
Gets the Geometry.Type.
ArrayList<Graphic> getGraphics()
This method returns the Graphic associated with this GPFeatureRecordSetLayer.
GPMapImage getMapImage()
This method returns the GPMapImage associated with this GPFeatureRecordSetLayer.
SpatialReference getSpatialReference()
Gets the spatial reference.
int hashCode()
void setGeometryType(Geometry.Type geometryType)
Sets the Geometry.Type.
void setGraphics(ArrayList<Graphic> graphics)
Sets the graphics to this GPFeatureRecordSetLayer object.
void setMapImage(GPMapImage mapImage)
void setSpatialReference(SpatialReference spatialReference)
Sets the spatial reference.
[Expand]
Inherited Methods
From class com.esri.core.tasks.ags.geoprocessing.GPParameter
From class java.lang.Object

Public Constructors

public GPFeatureRecordSetLayer (String paramName)

Constructor taking in the name of the parameter.

Parameters
paramName name of the parameter

public GPFeatureRecordSetLayer ()

Constructs an empty GPFeatureRecordSetLayer object.

Public Methods

public void addGraphic (Graphic graphic)

Convenient method to add a Graphic to a GPFeatureRecordSetLayer.

public boolean equals (Object obj)

public void fromJson (JsonParser parser)

Method used to populate a GP Parameter.

Parameters
parser a Json Parser
Throws
Exception

public Map<String, String> generateRequestParams ()

Generate request parameters in the form of map which contains three entried: parameter name, date type and value.

Returns
  • map representing the request parameters.

public String generateValueParams ()

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

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

public Geometry.Type getGeometryType ()

Gets the Geometry.Type.

Returns
  • the geometry type.

public ArrayList<Graphic> getGraphics ()

This method returns the Graphic associated with this GPFeatureRecordSetLayer.
It returns null if the return type of this instance is not data.

Returns
  • the graphics

public GPMapImage getMapImage ()

This method returns the GPMapImage associated with this GPFeatureRecordSetLayer.
It returns null if the return type of this instance is data.

Returns
  • the mapImage

public SpatialReference getSpatialReference ()

Gets the spatial reference.

Returns
  • the spatial reference.

public int hashCode ()

public void setGeometryType (Geometry.Type geometryType)

Sets the Geometry.Type.

Parameters
geometryType the geometry type to set

public void setGraphics (ArrayList<Graphic> graphics)

Sets the graphics to this GPFeatureRecordSetLayer object.

Parameters
graphics the graphics to set.

public void setMapImage (GPMapImage mapImage)

Parameters
mapImage the mapImage to set

public void setSpatialReference (SpatialReference spatialReference)

Sets the spatial reference.

Parameters
spatialReference the spatial reference to set.