Packagecom.esri.baserver.tasks.reports
Classpublic final class MarketRankingParameters
InheritanceMarketRankingParameters Inheritance AnalysisAndReportParameters Inheritance StandardReportParameters Inheritance BATaskParameters Inheritance Object

The MarketRankingParameters class provides input parameters for the Market Ranking task.

The analysis can be restricted to an analysis extent if the analysisExtent parameter is specified. The optional useAllFeatures parameter expands the analysis on all features of the rankingData layer including those who goes beyond the analysis extent.

Features of the rankingData layer are ranked by the primary ranking field specified with the primaryRankField parameter. If the rankPercentages parameter is true, the percentField parameter should specify a field to calculate the percentage of the primary ranking field. If the featureLimit parameter is -1, all analyzed features are ranked. Otherwise, features having top featureLimit values of the primary ranking field are shown in the report and are exported to the output feature class.

Output options for this task include rendering an output image (outputTypes.getMapImage), creating a feature class for subsequent analysis (outputTypes.getFeatureClass), and/or creating a report (outputTypes.getReport). If no output options are specified, the required output options are specified as follows. If the renderingParameters parameter is specified, the image output is requested. If the standardReportOptions parameter is specified, the report is requested. If the outputAnalysisItem parameter is specified, the output analysis feature class will be stored in the repository. If renderingParameters, standardReportOptions, and outputAnalysisItem parameters are missing, the feature class output is requested.

View the examples

See also

MarketRankingTask

Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
  additionalFields : Array
Array of additional fields of the rankingData layer to be shown in the output report and to be exported to the output feature class.
MarketRankingParameters
  analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by.
MarketRankingParameters
  featuresLimit : int
The maximum number of ranked features to be shown in the output report and to be exported to the output feature class.
MarketRankingParameters
  includeSummaryField : Boolean
An option that shows summary rank values in the report.
MarketRankingParameters
  nameField : String
The attribute field in the rankingData layer which specifies a name for every feature (required).
MarketRankingParameters
 InheritedoutputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository.
AnalysisAndReportParameters
 InheritedoutputReportItem : FolderItem
Configuration options for storing the output report in the repository.
AnalysisAndReportParameters
 InheritedoutputSpatialReference : SpatialReference
The spatial reference to return the output feature set in.
AnalysisAndReportParameters
 InheritedoutputTypes : OutputTypes
Task output types.
BATaskParameters
  percentField : String
The attribute field in the rankingData layer which specifies a field to be used for calculating the percentage of the primaryRankField field with respect to this field.
MarketRankingParameters
  primaryRankField : String
The attribute field in the rankingData layer which specifies a field to rank features by (required).
MarketRankingParameters
  rankingData : BADataLayer
A point or polygon layer containing features to be ranked (required).
MarketRankingParameters
  rankPercentages : Boolean
An option that shows the percentage of the primaryRankField field with respect to percentField field in the output report.
MarketRankingParameters
 InheritedrenderingParameters : RenderingParameters
Configuration options for rendering output to map image.
AnalysisAndReportParameters
 InheritedresultType : BAResultType
[read-only] Type of the result returned by the task associated with these parameters.
BATaskParameters
 InheritedreturnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set.
AnalysisAndReportParameters
 InheritedstandardReportOptions : ReportOptions
Standard report options.
StandardReportParameters
 InheritedtaskName : String
[read-only] Name of a Community Analyst Task associated with these parameters.
BATaskParameters
  useAllFeatures : Boolean
An option specifying the use of all features of the rankingData layer in the analysis.
MarketRankingParameters
Public Methods
 MethodDefined By
  
MarketRankingParameters(outputTypes:OutputTypes = null)
Creates a new instance of the MarketRankingParameters class.
MarketRankingParameters
Property Detail
additionalFieldsproperty
additionalFields:Array

Array of additional fields of the rankingData layer to be shown in the output report and to be exported to the output feature class. The additional fields must have a numerical type because they are used in calculating the summary rank.


Implementation
    public function get additionalFields():Array
    public function set additionalFields(value:Array):void
analysisExtentproperty 
analysisExtent:Geometry

Spatial/geographic extent to restrict analysis by. This parameter expects a value of the Extent or Polygon type.


Implementation
    public function get analysisExtent():Geometry
    public function set analysisExtent(value:Geometry):void

See also

com.esri.ags.geometry.Geometry
featuresLimitproperty 
featuresLimit:int

The maximum number of ranked features to be shown in the output report and to be exported to the output feature class. Negative value means ranking all features.

The default value is -1.


Implementation
    public function get featuresLimit():int
    public function set featuresLimit(value:int):void
includeSummaryFieldproperty 
includeSummaryField:Boolean

An option that shows summary rank values in the report.

The default value is false.


Implementation
    public function get includeSummaryField():Boolean
    public function set includeSummaryField(value:Boolean):void
nameFieldproperty 
nameField:String

The attribute field in the rankingData layer which specifies a name for every feature (required).


Implementation
    public function get nameField():String
    public function set nameField(value:String):void
percentFieldproperty 
percentField:String

The attribute field in the rankingData layer which specifies a field to be used for calculating the percentage of the primaryRankField field with respect to this field.


Implementation
    public function get percentField():String
    public function set percentField(value:String):void
primaryRankFieldproperty 
primaryRankField:String

The attribute field in the rankingData layer which specifies a field to rank features by (required).


Implementation
    public function get primaryRankField():String
    public function set primaryRankField(value:String):void
rankingDataproperty 
rankingData:BADataLayer

A point or polygon layer containing features to be ranked (required). An instance of the Boundaries or PointLayer type can be assigned to this parameter.


Implementation
    public function get rankingData():BADataLayer
    public function set rankingData(value:BADataLayer):void

See also

Boundaries
PointLayer
rankPercentagesproperty 
rankPercentages:Boolean

An option that shows the percentage of the primaryRankField field with respect to percentField field in the output report.

The default value is false.


Implementation
    public function get rankPercentages():Boolean
    public function set rankPercentages(value:Boolean):void
useAllFeaturesproperty 
useAllFeatures:Boolean

An option specifying the use of all features of the rankingData layer in the analysis.

The default value is false.


Implementation
    public function get useAllFeatures():Boolean
    public function set useAllFeatures(value:Boolean):void
Constructor Detail
MarketRankingParameters()Constructor
public function MarketRankingParameters(outputTypes:OutputTypes = null)

Creates a new instance of the MarketRankingParameters class.

Parameters
outputTypes:OutputTypes (default = null) — Task output types.
Examples
ActionScript to create MarketRankingParameters and then use in a Market Ranking task: 
                     
     var parameters : MarketRankingParameters = new MarketRankingParameters();
     
     // The rankingData parameter can be set with an instance of the PontLayer or Boundaries types
     // derived from the BADataLayer type.
     // The PointLayer type could take either data as type
     // com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem,
     // or an array of com.esri.bacore.PointRecord items.
     // The Boundaries type could take either data as type 
     // com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem,
     // or com.esri.bacore.StandardLayer.
     
     // Set rankingData as a point layer.
     parameters.rankingData = new PointLayer(rankingData);
     
     // Set the attribute field in the rankingData layer which specifies a name of every feature.
     parameters.nameField = "NAME";
     
     // Set the attribute field in the rankingData layer which specifies a field to rank features by.
     parameters.primaryRankField = "SALES";
      
     marketRankingTask.execute(parameters, new Responder(resultHandler, faultHandler));



© 2011 Esri, Inc. All rights reserved.

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