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 georocessing parameter of the data type GPFeatureRecordSetLayer. This data type is to represent a set of features in a layer. This includes the geometry, spatial reference, and field definitions for the features, as well as the features themselves which you an obtain as a list of graphics using getGraphics.

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)
Convenience 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()
Generates request parameters in the form of a Map which contains four entries: parameter name, date type, value and "exceededTransferLimit".
String generateValueParams()
Method serializing GP parameter's values into a Json format.
Geometry.Type getGeometryType()
Gets the geometry type for the feature geometries, for example point, polyline, or polygon.
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 for the geometries of the features in this record set.
int hashCode()
void setGeometryType(Geometry.Type geometryType)
Sets the geometry type for the geometries of the features in this record set.
void setGraphics(ArrayList<Graphic> graphics)
Sets the graphics to this GPFeatureRecordSetLayer object.
void setMapImage(GPMapImage mapImage)
Sets the GPMapImage associated with this GPFeatureRecordSetLayer.
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 String: name of the parameter

public GPFeatureRecordSetLayer ()

Constructs an empty GPFeatureRecordSetLayer object.

Public Methods

public void addGraphic (Graphic graphic)

Convenience method to add a Graphic to a GPFeatureRecordSetLayer.

Parameters
graphic Graphic: the graphic to add

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 Map<String, String> generateRequestParams ()

Generates request parameters in the form of a Map which contains four entries: parameter name, date type, value and "exceededTransferLimit".

Returns
Map<String, String> map representing the request parameters.

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 Geometry.Type getGeometryType ()

Gets the geometry type for the feature geometries, for example point, polyline, or polygon.

Returns
Geometry.Type 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
ArrayList<Graphic> 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
GPMapImage the mapImage

public SpatialReference getSpatialReference ()

Gets the spatial reference for the geometries of the features in this record set.

Returns
SpatialReference the spatial reference.

public int hashCode ()

Returns
int

public void setGeometryType (Geometry.Type geometryType)

Sets the geometry type for the geometries of the features in this record set.

Parameters
geometryType Geometry.Type: the geometry type to set

public void setGraphics (ArrayList<Graphic> graphics)

Sets the graphics to this GPFeatureRecordSetLayer object.

Parameters
graphics ArrayList: the graphics to set.

public void setMapImage (GPMapImage mapImage)

Sets the GPMapImage associated with this GPFeatureRecordSetLayer.

Parameters
mapImage GPMapImage: the mapImage to set

public void setSpatialReference (SpatialReference spatialReference)

Sets the spatial reference.

Parameters
spatialReference SpatialReference: the spatial reference to set.