public abstract class

GPParameter

extends Object
implements Serializable
java.lang.Object
   ↳ com.esri.core.tasks.ags.geoprocessing.GPParameter
Known Direct Subclasses

Class Overview

Base class for all GeoProcessing parameters.

Summary

Constants
String DATATYPE_GPBOOLEAN Represents a true or false value.
String DATATYPE_GPDATAFILE Represents any file type; for example .txt, .pdf, .csv
String DATATYPE_GPDATE Represents the number of milliseconds since epoch (January 1, 1970) in UTC.
String DATATYPE_GPDOUBLE Represents a decimal value.
String DATATYPE_GPFEATURERECORDSETLAYER Represents a layer containing features that have a geometry, spatial reference and attribute values.
String DATATYPE_GPLINEARUNIT A value that has a distance value and its unit of measurement; for example miles, kilometers, feet.
String DATATYPE_GPLONG Represents an integer value between −2,147,483,648 to 2,147,483,647
String DATATYPE_GPMULTIVALUE Represents an array of GP parameter values of the same data type; for example, GPMultiValue:GPString, GPMultiValue:GPLinearUnit.
String DATATYPE_GPRASTERDATA Represents raster data that consists of a matrix of cells (or pixels) where each cell contains a value representing information.
String DATATYPE_GPRASTERDATALAYER Represents a layer containing raster data.
String DATATYPE_GPRECORDSET Represents a tables structured as rows and columns.
String DATATYPE_GPSTRING Represents a string value.
Fields
protected String dataType
Public Constructors
GPParameter()
Public Methods
static GPParameter createFromJson(JsonParser parser)
Static method generating a GP Parameter based on the GPParameter Json representation the Json Parser is pointing to.
abstract 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 three entries: parameter name, date type and value.
abstract String generateValueParams()
Method serializing GP parameter's values into a Json format.
String getDataType()
Gets the data type.
String getParamName()
Gets the parameter name.
void setParamName(String paramName)
Sets the parameter name.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

protected static final String DATATYPE_GPBOOLEAN

Represents a true or false value.

Constant Value: "GPBoolean"

protected static final String DATATYPE_GPDATAFILE

Represents any file type; for example .txt, .pdf, .csv

Constant Value: "GPDataFile"

protected static final String DATATYPE_GPDATE

Represents the number of milliseconds since epoch (January 1, 1970) in UTC.

Constant Value: "GPDate"

protected static final String DATATYPE_GPDOUBLE

Represents a decimal value. For example 1.414

Constant Value: "GPDouble"

protected static final String DATATYPE_GPFEATURERECORDSETLAYER

Represents a layer containing features that have a geometry, spatial reference and attribute values.

Constant Value: "GPFeatureRecordSetLayer"

protected static final String DATATYPE_GPLINEARUNIT

A value that has a distance value and its unit of measurement; for example miles, kilometers, feet.

Constant Value: "GPLinearUnit"

protected static final String DATATYPE_GPLONG

Represents an integer value between −2,147,483,648 to 2,147,483,647

Constant Value: "GPLong"

protected static final String DATATYPE_GPMULTIVALUE

Represents an array of GP parameter values of the same data type; for example, GPMultiValue:GPString, GPMultiValue:GPLinearUnit.

Constant Value: "GPMultiValue"

protected static final String DATATYPE_GPRASTERDATA

Represents raster data that consists of a matrix of cells (or pixels) where each cell contains a value representing information.

Constant Value: "GPRasterData"

protected static final String DATATYPE_GPRASTERDATALAYER

Represents a layer containing raster data.

Constant Value: "GPRasterDataLayer"

protected static final String DATATYPE_GPRECORDSET

Represents a tables structured as rows and columns.

Constant Value: "GPRecordSet"

protected static final String DATATYPE_GPSTRING

Represents a string value.

Constant Value: "GPString"

Fields

protected String dataType

Public Constructors

public GPParameter ()

Public Methods

public static GPParameter createFromJson (JsonParser parser)

Static method generating a GP Parameter based on the GPParameter Json representation the Json Parser is pointing to.

Parameters
parser JsonParser: a Json parser pointing to a Json representation of a GP Parameter object.
Returns
GPParameter a GPParameter of the type defined in the Json representation
Throws
Exception when the supplied Json cannot be parsed

public abstract void fromJson (JsonParser parser)

Method used to populate a GP Parameter.

Parameters
parser JsonParser: a Json Parser
Throws
Exception
Exception

public Map<String, String> generateRequestParams ()

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

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

public abstract 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
Exception

public String getDataType ()

Gets the data type.

Returns
String the dataType

public String getParamName ()

Gets the parameter name.

Returns
String the paramName.

public void setParamName (String paramName)

Sets the parameter name.

Parameters
paramName String: the parameter name to set.