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.

Since:

1.0

See Also:

Serialized Form

Field Summary

protected String	dataType
protected static String	DATATYPE_GPBOOLEAN
protected static String	DATATYPE_GPDATAFILE
protected static String	DATATYPE_GPDATE
protected static String	DATATYPE_GPDOUBLE
protected static String	DATATYPE_GPFEATURERECORDSETLAYER
protected static String	DATATYPE_GPLINEARUNIT
protected static String	DATATYPE_GPLONG
protected static String	DATATYPE_GPMULTIVALUE
protected static String	DATATYPE_GPRASTERDATA
protected static String	DATATYPE_GPRASTERDATALAYER
protected static String	DATATYPE_GPRECORDSET
protected static String	DATATYPE_GPSTRING

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

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

Field Detail

DATATYPE_GPBOOLEAN

protected static final String DATATYPE_GPBOOLEAN

See Also:

Constant Field Values

DATATYPE_GPDOUBLE

protected static final String DATATYPE_GPDOUBLE

See Also:

Constant Field Values

DATATYPE_GPLONG

protected static final String DATATYPE_GPLONG

See Also:

Constant Field Values

DATATYPE_GPSTRING

protected static final String DATATYPE_GPSTRING

See Also:

Constant Field Values

DATATYPE_GPDATE

protected static final String DATATYPE_GPDATE

See Also:

Constant Field Values

DATATYPE_GPLINEARUNIT

protected static final String DATATYPE_GPLINEARUNIT

See Also:

Constant Field Values

DATATYPE_GPDATAFILE

protected static final String DATATYPE_GPDATAFILE

See Also:

Constant Field Values

DATATYPE_GPRASTERDATA

protected static final String DATATYPE_GPRASTERDATA

See Also:

Constant Field Values

DATATYPE_GPRECORDSET

protected static final String DATATYPE_GPRECORDSET

See Also:

Constant Field Values

DATATYPE_GPRASTERDATALAYER

protected static final String DATATYPE_GPRASTERDATALAYER

See Also:

Constant Field Values

DATATYPE_GPFEATURERECORDSETLAYER

protected static final String DATATYPE_GPFEATURERECORDSETLAYER

See Also:

Constant Field Values

DATATYPE_GPMULTIVALUE

protected static final String DATATYPE_GPMULTIVALUE

See Also:

Constant Field Values

dataType

protected String dataType

Constructor Detail

GPParameter

public GPParameter()

Method Detail

getDataType

public String getDataType()

Gets the data type.

Returns:

the dataType

Since:

1.0

getParamName

public String getParamName()

Gets the parameter name.

Returns:

the paramName.

Since:

1.0

setParamName

public void setParamName(String paramName)

Sets the parameter name.

Parameters:

paramName - the parameter name to set.

Since:

1.0

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.

Since:

1.0

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

Since:

1.0

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

Since:

1.0

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

Since:

1.0