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

java.lang.Object
  com.esri.core.tasks.ags.geoprocessing.GPParameter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GPBoolean, GPDataFile, GPDate, GPDouble, GPFeatureRecordSetLayer, GPLinearUnit, GPLong, GPMultiValue, GPRasterData, GPRasterDataLayer, GPRecordSet, GPString

public abstract class GPParameter
extends Object
implements Serializable

Base class for all GeoProcessing parameters.

See Also:

Serialized Form

Constructor Summary

GPParameter()

Method Summary

static GPParameter	createFromJson(org.codehaus.jackson.JsonParser parser) Static method generating a GP Parameter based on the GPParameter Json representation the Json Parser is pointing to.
abstract void	fromJson(org.codehaus.jackson.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.
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GPParameter

public GPParameter()

Method Detail

getDataType

public String getDataType()

Gets the data type.

Returns:

the dataType

getParamName

public String getParamName()

Gets the parameter name.

Returns:

the paramName.

setParamName

public void setParamName(String paramName)

Sets the parameter name.

Parameters:

paramName - the parameter name to set.

generateRequestParams

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.

createFromJson

public static GPParameter createFromJson(org.codehaus.jackson.JsonParser parser)
                                  throws Exception

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

Parameters:

parser - a Json parser pointing to a Json representation of a GP Parameter object.

Returns:

a GPParameter of the type defined in the Json representation

Throws:

Exception

fromJson

public abstract void fromJson(org.codehaus.jackson.JsonParser parser)
                       throws Exception

Method used to populate a GP Parameter.

Parameters:

parser - a Json Parser

Throws:

Exception

generateValueParams

public abstract String generateValueParams()
                                    throws Exception

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

Returns:

the Json String containing the GP parameter's values.

Throws:

Exception