Packagecom.esri.bacore.client
Classpublic class GPResultParsers
InheritanceGPResultParsers Inheritance ParseUtils Inheritance Object

The GPResultParsers class contains a collection of static parsers of standard ArcGIS Server GPResult objects.


Public Methods
 MethodDefined By
 Inherited
ensureGPResult(decodedObject:Object):void
[static] Ensures that the JSON-decoded object is a GPResult object.
ParseUtils
 Inherited
ensureValidGPDataType(decodedObject:Object, value:String):void
[static] Ensures that the dataType property value of the specified JSON-decoded GPResult object is equal to the given value.
ParseUtils
 Inherited
getOptionalProperty(typeName:String, decodedObject:Object, propertyName:String, propertyType:Class = null, defaultValue:*):*
[static] Gets a value of the given property of a JSON-decoded object or a default value if the property value is missing.
ParseUtils
  
parseGPBoolean(decodedObject:Object):Boolean
[static] Parses a JSON-decoded GPResult object as a Boolean value.
GPResultParsers
  
parseGPDataFile(decodedObject:Object):String
[static] Parses a JSON-decoded GPResult object as a data file URL string.
GPResultParsers
  
parseGPDouble(decodedObject:Object):Number
[static] Parses a JSON-decoded GPResult object as a Number value.
GPResultParsers
  
parseGPFeatureRecordSetLayer(decodedObject:Object):FeatureSet
[static] Parses a JSON-decoded GPResult object as a FeatureSet value.
GPResultParsers
  
parseGPLong(decodedObject:Object):int
[static] Parses a JSON-decoded GPResult object as an integer value.
GPResultParsers
  
parseGPRasterData(decodedObject:Object):MapImage
[static] Parses a JSON-decoded GPResult object as a MapImage value.
GPResultParsers
  
parseGPRasterDataLayer(decodedObject:Object):MapImage
[static] Parses a JSON-decoded GPResult object as a MapImage value.
GPResultParsers
  
parseGPResult(decodedObject:Object):*
[static] Parses a JSON-decoded GPResult object.
GPResultParsers
  
parseGPResults(decodedObject:Array):Array
[static] Parses an array of JSON-decoded GPResult objects and stores the results of parsing in the result array.
GPResultParsers
  
parseGPString(decodedObject:Object):String
[static] Parses a JSON-decoded GPResult object as a string value.
GPResultParsers
 Inherited
testAndGetProperty(typeName:String, decodedObject:Object, propertyName:String, propertyType:Class = null):*
[static] Tests a property of a JSON-decoded object to be specified and gets it.
ParseUtils
Public Constants
 ConstantDefined By
  GP_BOOLEAN : String = GPBoolean
[static] Boolean value type.
GPResultParsers
  GP_DATA_FILE : String = GPDataFile
[static] External data type.
GPResultParsers
  GP_DOUBLE : String = GPDouble
[static] Real value type.
GPResultParsers
  GP_FEATURE_RECORD_SET_LAYER : String = GPFeatureRecordSetLayer
[static] Feature record set type.
GPResultParsers
  GP_LONG : String = GPLong
[static] Integer value type.
GPResultParsers
  GP_RASTER_DATA : String = GPRasterData
[static] External image type.
GPResultParsers
  GP_RASTER_DATA_LAYER : String = GPRasterDataLayer
[static] External map image type.
GPResultParsers
  GP_STRING : String = GPString
[static] String value type.
GPResultParsers
Method Detail
parseGPBoolean()method
public static function parseGPBoolean(decodedObject:Object):Boolean

Parses a JSON-decoded GPResult object as a Boolean value.

Parameters

decodedObject:Object — JSON-decoded GPResult object.

Returns
Boolean — Result of parsing.

Throws
BAResponseError — Wrong GPResult dataType.
parseGPDataFile()method 
public static function parseGPDataFile(decodedObject:Object):String

Parses a JSON-decoded GPResult object as a data file URL string.

Parameters

decodedObject:Object — JSON-decoded GPResult object.

Returns
String — Result of parsing.

Throws
BAResponseError — Wrong GPResult dataType.
parseGPDouble()method 
public static function parseGPDouble(decodedObject:Object):Number

Parses a JSON-decoded GPResult object as a Number value.

Parameters

decodedObject:Object — JSON-decoded GPResult object.

Returns
Number — Result of parsing.

Throws
BAResponseError — Wrong GPResult dataType.
parseGPFeatureRecordSetLayer()method 
public static function parseGPFeatureRecordSetLayer(decodedObject:Object):FeatureSet

Parses a JSON-decoded GPResult object as a FeatureSet value.

Parameters

decodedObject:Object — JSON-decoded GPResult object.

Returns
FeatureSet — Result of parsing.

Throws
BAResponseError — Wrong GPResult dataType.
parseGPLong()method 
public static function parseGPLong(decodedObject:Object):int

Parses a JSON-decoded GPResult object as an integer value.

Parameters

decodedObject:Object — JSON-decoded GPResult object.

Returns
int — Result of parsing.

Throws
BAResponseError — Wrong GPResult dataType.
parseGPRasterData()method 
public static function parseGPRasterData(decodedObject:Object):MapImage

Parses a JSON-decoded GPResult object as a MapImage value. Only href property is specified in the object returned.

Parameters

decodedObject:Object — JSON-decoded GPResult object.

Returns
MapImage — Result of parsing.

Throws
BAResponseError — Wrong GPResult dataType.
parseGPRasterDataLayer()method 
public static function parseGPRasterDataLayer(decodedObject:Object):MapImage

Parses a JSON-decoded GPResult object as a MapImage value.

Parameters

decodedObject:Object — JSON-decoded GPResult object.

Returns
MapImage — Result of parsing.

Throws
BAResponseError — Wrong GPResult dataType.
parseGPResult()method 
public static function parseGPResult(decodedObject:Object):*

Parses a JSON-decoded GPResult object.

A GPResult object MUST contain 3 properties: paramName, dataType, and value. If any of these properties are absent or the dataType is not recognized, null is returned.

The following data types are parsed with this parser: "GPBoolean", "GPDouble", "GPLong", "GPString", "GPDataFile", "GPRasterData", "GPRasterDataLayer", and "GPFeatureRecordSetLayer".

Parameters

decodedObject:Object — JSON-decoded GPResult object.

Returns
* — Result of parsing or null.
parseGPResults()method 
public static function parseGPResults(decodedObject:Array):Array

Parses an array of JSON-decoded GPResult objects and stores the results of parsing in the result array. If some objects of this array are not GPResult objects or their type isn't recognized, a null is stored in the result array.

Parameters

decodedObject:Array — Array of GPResult objects.

Returns
Array — Result array.
parseGPString()method 
public static function parseGPString(decodedObject:Object):String

Parses a JSON-decoded GPResult object as a string value.

Parameters

decodedObject:Object — JSON-decoded GPResult object.

Returns
String — Result of parsing.

Throws
BAResponseError — Wrong GPResult dataType.
Constant Detail
GP_BOOLEANConstant
public static const GP_BOOLEAN:String = GPBoolean

Boolean value type.

GP_DATA_FILEConstant 
public static const GP_DATA_FILE:String = GPDataFile

External data type.

GP_DOUBLEConstant 
public static const GP_DOUBLE:String = GPDouble

Real value type.

GP_FEATURE_RECORD_SET_LAYERConstant 
public static const GP_FEATURE_RECORD_SET_LAYER:String = GPFeatureRecordSetLayer

Feature record set type.

GP_LONGConstant 
public static const GP_LONG:String = GPLong

Integer value type.

GP_RASTER_DATAConstant 
public static const GP_RASTER_DATA:String = GPRasterData

External image type.

GP_RASTER_DATA_LAYERConstant 
public static const GP_RASTER_DATA_LAYER:String = GPRasterDataLayer

External map image type.

GP_STRINGConstant 
public static const GP_STRING:String = GPString

String value type.




© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00