Package | com.esri.baserver.tasks.analyses |
Class | public class CustomerProspectingParameters |
Inheritance | CustomerProspectingParameters AnalysisParameters AnalysisParameters BATaskParameters Object |
The analysisExtent
parameter specifies the market area to prospect.
The dataLayerID
property specifies the geography layer for analysis.
Two types of prospecting analysis are supported—Conventional Analysis and Principal Component Analysis.
For Conventional Analysis, either the prospectingQuery
parameter or
the customerProfileDescription
parameter should be specified.
In the first case, the WHERE-clause SQL statement is manually specified.
It queries for sites from the geography layer with the given attribute values.
In the last case, the floor and ceiling values for variables of the Customer Profile are
used for generating the SQL query for the WHERE clause. Conditions for every variable
of the profile are joined using the logical AND operation.
For Principal Component Analysis, the customerProfileDescription
parameter
should be specified. It defines the Customer Profile whose average values for profiled
variables are used as a benchmark. The geography sites are ranked by similarity based on this
benchmark. The pcaRankSites
parameter can specify the maximal number of sites
to be ranked. If its value is -1 (default), all sites are ranked.
The pcaEigenvalue
parameter specifies the eigenvalue boundary for Kaiser
Criterion used in Principal Component Analysis. The default value is 1 as recommended.
To prepare a Customer Profile for analysis, execute the Customer Profiling task and assign
its result to the customerProfileDescription
parameter value.
Output options for this task include rendering an output image (outputTypes.getMapImage) and/or creating
a feature class for subsequent analysis (outputTypes.getFeatureClass).
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 outputAnalysisItem
parameter is specified, the output analysis feature class
will be stored in the repository. If both renderingParameters
and
outputAnalysisItem
parameters are missing, the feature class output is requested.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BATaskParameters | ||
analysisExtent : Geometry
Spatial/geographic extent on which to perform the analysis (required). | CustomerProspectingParameters | ||
customerProfileDescription : String
Customer profile string returned by the Customer Profiling task. | CustomerProspectingParameters | ||
dataLayerID : String
ID of a geography layer to get demography for analysis from (required). | CustomerProspectingParameters | ||
outputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository. | AnalysisParameters | ||
outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | AnalysisParameters | ||
outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
pcaEigenvalue : Number
Eigenvalue boundary for Kaiser Criterion used with Principal Component Analysis. | CustomerProspectingParameters | ||
pcaRankSites : int
Maximum number of sites to rank used with Principal Component Analysis. | CustomerProspectingParameters | ||
prospectingQuery : String
Prospecting query for manual analysis. | CustomerProspectingParameters | ||
prospectingType : CustomerProspectingAnalysisType
Customer prospecting type. | CustomerProspectingParameters | ||
renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | AnalysisParameters | ||
resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | ||
returnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set. | AnalysisParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters |
Method | Defined By | ||
---|---|---|---|
CustomerProspectingParameters(outputTypes:OutputTypes = null)
Creates a new instance of the CustomerProspectingParameters class. | CustomerProspectingParameters |
analysisExtent | property |
analysisExtent:Geometry
Spatial/geographic extent on which to perform the analysis (required). This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry
public function set analysisExtent(value:Geometry):void
See also
customerProfileDescription | property |
customerProfileDescription:String
Customer profile string returned by the Customer Profiling task.
public function get customerProfileDescription():String
public function set customerProfileDescription(value:String):void
dataLayerID | property |
dataLayerID:String
ID of a geography layer to get demography for analysis from (required).
public function get dataLayerID():String
public function set dataLayerID(value:String):void
pcaEigenvalue | property |
pcaEigenvalue:Number
Eigenvalue boundary for Kaiser Criterion used with Principal Component Analysis.
The default value is 1
.
public function get pcaEigenvalue():Number
public function set pcaEigenvalue(value:Number):void
pcaRankSites | property |
pcaRankSites:int
Maximum number of sites to rank used with Principal Component Analysis. Negative value means ranking all sites.
The default value is -1
.
public function get pcaRankSites():int
public function set pcaRankSites(value:int):void
prospectingQuery | property |
prospectingQuery:String
Prospecting query for manual analysis.
public function get prospectingQuery():String
public function set prospectingQuery(value:String):void
prospectingType | property |
prospectingType:CustomerProspectingAnalysisType
Customer prospecting type.
The default value is CustomerProspectingAnalysisType.PCA
.
public function get prospectingType():CustomerProspectingAnalysisType
public function set prospectingType(value:CustomerProspectingAnalysisType):void
CustomerProspectingParameters | () | Constructor |
public function CustomerProspectingParameters(outputTypes:OutputTypes = null)
Creates a new instance of the CustomerProspectingParameters class.
ParametersoutputTypes:OutputTypes (default = null ) — Task output types.
|
var parameters : CustomerProspectingParameters = new CustomerProspectingParameters(); // Set ID of a geography layer to get demography for analysis from. parameters.dataLayerID = "US.BlockGroups"; // The Principal Component Analysis is the default analysis type. //parameters.prospectingType = CustomerProspectingAnalysisType.PCA; parameters.pcaRankSites = 10; // Rank not more than 10 sites. parameters.pcaEigenvalue = 0.5; // The less value of this threshold, the more principal components are taken into account. // Set the analysis extent to myExtent that is a value of the Extent or Polygon type. parameters.analysisExtent = myExtent; // The customerProfile string contains a customer profile returned by the Customer Profiling task. parameters.customerProfileDescription = customerProfile; customerProspectingTask.execute(parameters, new Responder(resultHandler, faultHandler));