Packagecom.esri.bacore.client
Classpublic class GPResultProcessors
InheritanceGPResultProcessors Inheritance ParseUtils Inheritance Object

The GPResultProcessors class contains a collection of standard processors of task output results returned in the GP Execute syntax.



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
  
getGPResults(asyncToken:AsyncToken):Array
[static] This utility method gets an array of all objects returned by a Community Analyst Task.
GPResultProcessors
 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
  
getProcessedResult(asyncToken:AsyncToken):*
[static] This utility method gets the result of processing.
GPResultProcessors
  
getSingleGPResult(asyncToken:AsyncToken, allowMissingResult:Boolean = false):Object
[static] This utility method gets a single result object returned by a Community Analyst Task.
GPResultProcessors
  
parseStdGeographiesFeatures(decodedItems:Array):Array
[static] This utility method parses an array of JSON-decoded items as an array of IDNamePair items.
GPResultProcessors
  
processBoolean(asyncToken:AsyncToken):void
[static] Processes a result as a Boolean value.
GPResultProcessors
  
processIDNamePairs(asyncToken:AsyncToken):void
[static] Processes a result as an array of IDNamePair values.
GPResultProcessors
  
processReportTemplateInfos(asyncToken:AsyncToken):void
[static] Processes a result as an array of ReportTemplateInfo values.
GPResultProcessors
  
processStdGeographiesFeatures(asyncToken:AsyncToken):void
[static] Processes a result as an array of IDNamePair values.
GPResultProcessors
  
processString(asyncToken:AsyncToken):void
[static] Processes a result as a String value.
GPResultProcessors
  
processStringArray(asyncToken:AsyncToken):void
[static] Processes a result as an array of String values.
GPResultProcessors
  
processSummarizationInfos(asyncToken:AsyncToken):void
[static] Processes a result as an array of SummarizationInfo values.
GPResultProcessors
  
processTaskResultOutput(asyncToken:AsyncToken):void
[static] Processes a result as a TaskResultOutput value.
GPResultProcessors
  
setProcessedResult(asyncToken:AsyncToken, result:*):void
[static] This utility method sets the result of processing.
GPResultProcessors
 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
Method Detail
getGPResults()method
public static function getGPResults(asyncToken:AsyncToken):Array

This utility method gets an array of all objects returned by a Community Analyst Task.

Parameters

asyncToken:AsyncToken — A token whose resultObject property contains a JSON-decoded result.

Returns
Array — Array of GPResult objects.
getProcessedResult()method 
public static function getProcessedResult(asyncToken:AsyncToken):*

This utility method gets the result of processing.

Parameters

asyncToken:AsyncToken — A token whose resultObject property contains a processed result.

Returns
* — A processed result value.
getSingleGPResult()method 
public static function getSingleGPResult(asyncToken:AsyncToken, allowMissingResult:Boolean = false):Object

This utility method gets a single result object returned by a Community Analyst Task.

Parameters

asyncToken:AsyncToken — A token whose resultObject property contains JSON-decoded result.
 
allowMissingResult:Boolean (default = false) — If true, a zero number of results is allowed.

Returns
Object — A GPResult object. In the case of missing result if this case is allowed, null is returned.

Throws
BAResponseError — The number of results in the result array differs from one.
parseStdGeographiesFeatures()method 
public static function parseStdGeographiesFeatures(decodedItems:Array):Array

This utility method parses an array of JSON-decoded items as an array of IDNamePair items.

Parameters

decodedItems:Array — Array of JSON-decoded items.

Returns
Array — Array of IDNamePair items.
processBoolean()method 
public static function processBoolean(asyncToken:AsyncToken):void

Processes a result as a Boolean value.

Parameters

asyncToken:AsyncToken — A token whose resultObject is processed.

processIDNamePairs()method 
public static function processIDNamePairs(asyncToken:AsyncToken):void

Processes a result as an array of IDNamePair values.

Parameters

asyncToken:AsyncToken — A token whose resultObject is processed.

processReportTemplateInfos()method 
public static function processReportTemplateInfos(asyncToken:AsyncToken):void

Processes a result as an array of ReportTemplateInfo values.

Parameters

asyncToken:AsyncToken — A token whose resultObject is processed.

processStdGeographiesFeatures()method 
public static function processStdGeographiesFeatures(asyncToken:AsyncToken):void

Processes a result as an array of IDNamePair values.

Parameters

asyncToken:AsyncToken — A token whose resultObject is processed.

processString()method 
public static function processString(asyncToken:AsyncToken):void

Processes a result as a String value.

Parameters

asyncToken:AsyncToken — A token whose resultObject is processed.

processStringArray()method 
public static function processStringArray(asyncToken:AsyncToken):void

Processes a result as an array of String values.

Parameters

asyncToken:AsyncToken — A token whose resultObject is processed.

processSummarizationInfos()method 
public static function processSummarizationInfos(asyncToken:AsyncToken):void

Processes a result as an array of SummarizationInfo values.

Parameters

asyncToken:AsyncToken — A token whose resultObject is processed.

processTaskResultOutput()method 
public static function processTaskResultOutput(asyncToken:AsyncToken):void

Processes a result as a TaskResultOutput value.

Parameters

asyncToken:AsyncToken — A token whose resultObject is processed.

setProcessedResult()method 
public static function setProcessedResult(asyncToken:AsyncToken, result:*):void

This utility method sets the result of processing.

Parameters

asyncToken:AsyncToken — A token whose resultObject property is set.
 
result:* — A processed result value to set.