Packagecom.esri.bao.tasks.reports
Classpublic class BenchmarkReportParameters
InheritanceBenchmarkReportParameters Inheritance StandardReportParameters Inheritance BATaskParameters Inheritance Object

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

The benchmarkOptions property specifies how to create the benchmark area:

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

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

The fieldSortType property specifies the sorting rules based on the sortFieldName field:

ValueDescription
BenchmarkSortOptions.SORT_NONE means no sorting
BenchmarkSortOptions.SORT_BY_FIELD_ONLY sorts by the field itself
BenchmarkSortOptions.SORT_BY_FIELD_DIFFERENCE sorts by calculated difference between the field value and the benchmark field value
BenchmarkSortOptions.SORT_BY_FIELD_PERCENT sorts by calculating 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

Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : 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
  fieldSortType : BenchmarkSortOptions
Report fields sorting options.
BenchmarkReportParameters
 InheritedoutputTypes : OutputTypes
Task output types.
BATaskParameters
 InheritedresultType : BAResultType
[read-only] Type of the result returned by the task associated with these parameters.
BATaskParameters
  sortFieldName : String
Name of a summarization field the field sorting will be based on.
BenchmarkReportParameters
 InheritedstandardReportOptions : 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
 InheritedtaskName : 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
Public Methods
 MethodDefined By
  
BenchmarkReportParameters()
Creates a new instance of the BenchmarkReportParameters class.
BenchmarkReportParameters
Property Detail
benchmarkAreaOIDproperty
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 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
benchmarkLayerproperty 
benchmarkLayer:Boundaries

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


Implementation
    public function get benchmarkLayer():Boundaries
    public function set benchmarkLayer(value:Boundaries):void
benchmarkOptionsproperty 
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
fieldSortTypeproperty 
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
sortFieldNameproperty 
sortFieldName:String

Name of a summarization field the field 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
summarizationsproperty 
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 from the Get Summarizations task. Type array of String items.


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

See also

GetSummarizationsTask
taInRowsproperty 
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
taLayersFieldsproperty 
taLayersFields:Array

Array of names of fields of trade area layers that will appear in the report. Type array of String items.


Implementation
    public function get taLayersFields():Array
    public function set taLayersFields(value:Array):void
tradeAreasproperty 
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 the BenchmarkReportTask: 
                     
     var parameters : BenchmarkReportParameters = new BenchmarkReportParameters();
     
     // BenchmarkOptions.USE_NONE is the default value for benchmarkOptions.
     parameters.benchmarkOptions = BenchmarkOptions.USE_AVERAGE_VALUES;
     
     parameters.fieldSortType = BenchmarkSortOptions.SORT_BY_FIELD_DIFFERENCE;
     parameters.sortFieldName = "TOTPOP_CY";
     parameters.summarizations = [ "TOTPOP_CY", "TOTHH_CY" ];
     
     // true is the default value for taInRows. 
     parameters.taInRows = false;
     
     parameters.taLayersFields = [ "STORE_ID" ];
     
     // Trade areas can be either a feature set or standard layers.
     parameters.tradeAreas = [ taLayer1, taLayer2 ];
     
     // Set report options.
     var reportOptions:ReportOptions = new ReportOptions("PDF");
     reportOptions.header = new ReportHeader("Benchmark Report for two rings");
     parameters.standardReportOptions = reportOptions;
     
     benchmarkReportTask.execute(parameters, new Responder(resultHandler, faultHandler));



© 2011 Esri, Inc. All rights reserved.

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