com.esri.baserver.tasks.reports.BenchmarkReportParameters

Package	com.esri.baserver.tasks.reports
Class	public class BenchmarkReportParameters
Inheritance	BenchmarkReportParameters StandardReportParameters StandardReportParameters BATaskParameters Object

The BenchmarkReportParameters class provides input parameters for the Benchmark Report task.

The benchmarkOptions parameter specifies how to create the benchmark area:

Value	Description
`BenchmarkOptions.USE_ONE_OF_THE_TRADE_AREAS`	selects the benchmark area by OID from the benchmark layer (the `benchmarkLayer` and `benchmarkAreaOID` parameters should be specified)
`BenchmarkOptions.USE_AVERAGE_VALUES`	creates the benchmark area by calculating average summarization values for all areas in the trade area layers
`BenchmarkOptions.USE_MEDIAN_VALUES`	creates the benchmark area by calculating median summarization values for all areas in the trade area layers
`BenchmarkOptions.USE_NONE`	means no benchmark (creates a report without comparison with benchmark)

The taInRows parameter determines the orientation of the summarization fields in the report:

true value outputs the report with the summarization fields in columns and the trade areas in rows.
false value (default) outputs the report with the summarization fields in rows and the trade areas in columns.

The fieldSortType parameter specifies the sorting rules based on the field specified with the sortFieldName parameter value:

Value	Description
`BenchmarkSortOptions.SORT_NONE`	means no sorting
`BenchmarkSortOptions.SORT_BY_FIELD_ONLY`	sorts by the field itself
`BenchmarkSortOptions.SORT_BY_FIELD_DIFFERENCE`	sorts by the calculated difference between the field value and the benchmark field value
`BenchmarkSortOptions.SORT_BY_FIELD_PERCENT`	sorts by the calculated percent of the field value with respect to the benchmark field value
`BenchmarkSortOptions.SORT_BY_FIELD_INDEX`	sorts by the field index (available for some summarization fields)

Output options for this task include creating a report (outputTypes.getReport). You need not specify the output options for this task because the getReport output type is set by default.

View the examples

See also

BenchmarkReportTask

	Property	Defined By
		activeDatasetID : String Active dataset ID.	BATaskParameters
		benchmarkAreaOID : int OID of area from the benchmarkLayer layer to be used as a benchmark area.	BenchmarkReportParameters
		benchmarkLayer : Boundaries Data layer used for calculating the benchmark area.	BenchmarkReportParameters
		benchmarkOptions : BenchmarkOptions Benchmark area calculation method.	BenchmarkReportParameters
		dataHierarchy : String Name of a data hierarchy used for summarization.	BenchmarkReportParameters
		fieldSortType : BenchmarkSortOptions Report fields sorting options.	BenchmarkReportParameters
		outputReportItem : FolderItem Configuration options for storing the output report in the repository.	StandardReportParameters
		outputTypes : OutputTypes Task output types.	BATaskParameters
		resultType : BAResultType [read-only] Type of the result returned by the task associated with these parameters.	BATaskParameters
		sortFieldName : String Name of a summarization field the sorting will be based on.	BenchmarkReportParameters
		standardReportOptions : ReportOptions Standard report options.	StandardReportParameters
		summarizations : Array Array of names of variables the trade areas will be summarized by and compared with the benchmark.	BenchmarkReportParameters
		tAinRows : Boolean Report layout options.	BenchmarkReportParameters
		taLayersFields : Array Array of names of fields of trade area layers that will appear in the report.	BenchmarkReportParameters
		taskName : String [read-only] Name of a Community Analyst Task associated with these parameters.	BATaskParameters
		tradeAreas : Array Array containing one or more trade area layers to produce the benchmark report for.	BenchmarkReportParameters

	Method	Defined By
		BenchmarkReportParameters() Creates a new instance of the BenchmarkReportParameters class.	BenchmarkReportParameters

Property Detail

benchmarkAreaOID

property

benchmarkAreaOID:int

OID of area from the benchmarkLayer layer to be used as a benchmark area. Value of -1 means that OID is missing. This property should be specified if the benchmarkOptions property is BenchmarkOptions.USE_ONE_OF_THE_TRADE_AREAS.

The default value is -1.

Implementation
public function get benchmarkAreaOID():int
public function set benchmarkAreaOID(value:int):void

benchmarkLayer

property

benchmarkLayer:Boundaries

Data layer used for calculating the benchmark area. This property should be specified if the benchmarkOptions property is BenchmarkOptions.USE_ONE_OF_THE_TRADE_AREAS.

Implementation
public function get benchmarkLayer():Boundaries
public function set benchmarkLayer(value:Boundaries):void

benchmarkOptions

property

benchmarkOptions:BenchmarkOptions

Benchmark area calculation method.

The default value is BenchmarkOptions.USE_NONE.

Implementation
public function get benchmarkOptions():BenchmarkOptions
public function set benchmarkOptions(value:BenchmarkOptions):void

dataHierarchy

property

dataHierarchy:String

Name of a data hierarchy used for summarization. If this property value is null or empty, the default data hierarchy is used. List of available data hierarchies can be retrieved with Get Data Hierarchies task.

Implementation
public function get dataHierarchy():String
public function set dataHierarchy(value:String):void

See also

GetDataHierarchiesTask

fieldSortType

property

fieldSortType:BenchmarkSortOptions

Report fields sorting options.

The default value is BenchmarkSortOptions.SORT_NONE.

Implementation
public function get fieldSortType():BenchmarkSortOptions
public function set fieldSortType(value:BenchmarkSortOptions):void

sortFieldName

property

sortFieldName:String

Name of a summarization field the sorting will be based on. This property should be specified if fieldSortType property value is any except BenchmarkSortOptions.SORT_NONE.

Implementation
public function get sortFieldName():String
public function set sortFieldName(value:String):void

summarizations

property

summarizations:Array

Array of names of variables the trade areas will be summarized by and compared with the benchmark. Available summarization fields can be retrieved with the Get Summarizations task. This array should contain items of the String type.

Implementation
public function get summarizations():Array
public function set summarizations(value:Array):void

See also

GetSummarizationsTask

tAinRows

property

tAinRows:Boolean

Report layout options. The "trade areas in rows" layout is used by default.

The default value is true.

Implementation
public function get tAinRows():Boolean
public function set tAinRows(value:Boolean):void

taLayersFields

property

taLayersFields:Array

Array of names of fields of trade area layers that will appear in the report. This array should contain items of the String type.

Implementation
public function get taLayersFields():Array
public function set taLayersFields(value:Array):void

tradeAreas

property

tradeAreas:Array

Array containing one or more trade area layers to produce the benchmark report for. The array should contain items of the Boundaries type.

Implementation
public function get tradeAreas():Array
public function set tradeAreas(value:Array):void

See also

Boundaries

Constructor Detail

BenchmarkReportParameters

()

Constructor

public function BenchmarkReportParameters()

Creates a new instance of the BenchmarkReportParameters class.

Examples

ActionScript to create BenchmarkReportParameters and then use in a Benchmark Report task:

                     
     var parameters : BenchmarkReportParameters = new BenchmarkReportParameters();
     
     // Set trade areas as an array of the Boundaries type items.
     parameters.tradeAreas = [ boundaries ];
     
     // Set fields of the geography data layer to be summarized for trade areas and compared with the benchmark.             
     parameters.summarizations = ["TOTPOP_CY", "HHPOP_CY"];
     
     // Set report parameters. 
     parameters.standardReportOptions = new ReportOptions("PDF");
     
     benchmarkReportTask.execute(parameters, new Responder(resultHandler, faultHandler));

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

Esri Community Analyst API for Flex 2.2 Reference	All Packages \| All Classes \| Index \| Frames No Frames
BenchmarkReportParameters	Properties \| Methods \| Examples