Packagecom.esri.baserver.tasks.segmentation
Classpublic class CoreDevelopSegmentsParameters
InheritanceCoreDevelopSegmentsParameters Inheritance StandardReportParameters Inheritance StandardReportParameters Inheritance BATaskParameters Inheritance Object

The CoreDevelopSegmentsParameters class provides input parameters for the Core and Developmental Segments task.

Two tapestry segmentation profiles should be specified—the base profile (baseProfile parameter) is used for calculating the index and the target profile (targetProfile parameter) is used for calculating the percent composition for each Tapestry segment.

Two variations of the report creation are supported: with and without a target group.

Without target group (useExistingTargetGroup=false), the percentThreshold and the indexThreshold parameters specify the percent composition and index thresholds, respectively.

With a target group (useExistingTargetGroup=true), the targetGroup parameter specifies the target group and the coreTargetName and developmentalTargetName parameters specify the Core and Developmental summary groups of the target group, respectively.

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

CoreDevelopSegmentsTask

Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
  baseProfile : ProfileData
Base segmentation profile (required).
CoreDevelopSegmentsParameters
  coreTargetName : String
Core summary group name (required if useExistingTargetGroup=true).
CoreDevelopSegmentsParameters
  developmentalTargetName : String
Developmental summary group name (required if useExistingTargetGroup=true).
CoreDevelopSegmentsParameters
  indexThreshold : Number
Index threshold (required if useExistingTargetGroup=false).
CoreDevelopSegmentsParameters
 InheritedoutputReportItem : FolderItem
Configuration options for storing the output report in the repository.
StandardReportParameters
 InheritedoutputTypes : OutputTypes
Task output types.
BATaskParameters
  percentThreshold : Number
Percent composition threshold (required if useExistingTargetGroup=false).
CoreDevelopSegmentsParameters
 InheritedresultType : BAResultType
[read-only] Type of the result returned by the task associated with these parameters.
BATaskParameters
 InheritedstandardReportOptions : ReportOptions
Standard report options.
StandardReportParameters
  targetGroup : TargetGroupData
Target group (required if useExistingTargetGroup=true).
CoreDevelopSegmentsParameters
  targetProfile : ProfileData
Target segmentation profile (required).
CoreDevelopSegmentsParameters
 InheritedtaskName : String
[read-only] Name of a Community Analyst Task associated with these parameters.
BATaskParameters
  useExistingTargetGroup : Boolean
Option specifying the use of the existing target group.
CoreDevelopSegmentsParameters
Public Methods
 MethodDefined By
  
CoreDevelopSegmentsParameters()
Creates a new instance of the CoreDevelopSegmentsParameters class.
CoreDevelopSegmentsParameters
Property Detail
baseProfileproperty
baseProfile:ProfileData

Base segmentation profile (required).


Implementation
    public function get baseProfile():ProfileData
    public function set baseProfile(value:ProfileData):void
coreTargetNameproperty 
coreTargetName:String

Core summary group name (required if useExistingTargetGroup=true).


Implementation
    public function get coreTargetName():String
    public function set coreTargetName(value:String):void
developmentalTargetNameproperty 
developmentalTargetName:String

Developmental summary group name (required if useExistingTargetGroup=true).


Implementation
    public function get developmentalTargetName():String
    public function set developmentalTargetName(value:String):void
indexThresholdproperty 
indexThreshold:Number

Index threshold (required if useExistingTargetGroup=false).

The default value is NaN.


Implementation
    public function get indexThreshold():Number
    public function set indexThreshold(value:Number):void
percentThresholdproperty 
percentThreshold:Number

Percent composition threshold (required if useExistingTargetGroup=false).

The default value is NaN.


Implementation
    public function get percentThreshold():Number
    public function set percentThreshold(value:Number):void
targetGroupproperty 
targetGroup:TargetGroupData

Target group (required if useExistingTargetGroup=true).


Implementation
    public function get targetGroup():TargetGroupData
    public function set targetGroup(value:TargetGroupData):void
targetProfileproperty 
targetProfile:ProfileData

Target segmentation profile (required).


Implementation
    public function get targetProfile():ProfileData
    public function set targetProfile(value:ProfileData):void
useExistingTargetGroupproperty 
useExistingTargetGroup:Boolean

Option specifying the use of the existing target group.

The default value is false.


Implementation
    public function get useExistingTargetGroup():Boolean
    public function set useExistingTargetGroup(value:Boolean):void
Constructor Detail
CoreDevelopSegmentsParameters()Constructor
public function CoreDevelopSegmentsParameters()

Creates a new instance of the CoreDevelopSegmentsParameters class.

Examples
ActionScript to create CoreDevelopSegmentsParameters and then use in a Core and Developmental Segments task: 
                     
     var parameters : CoreDevelopSegmentsParameters = new CoreDevelopSegmentsParameters();
     
     // The ProfileData type could take either data as an XML string
     // or as com.esri.baserver.FolderItem type, e.g.
     //var baseProfile:FolderItem = new FolderItem(workspaceName, projectName, FolderType.SEGMENTATION_PROFILES, profileName);
     
     // Set a base segmentation profile.
     parameters.baseProfile = new ProfileData(baseProfile);
     
     // Set a target segmentation profile.
     parameters.targetProfile = new ProfileData(targetProfile);
     
     // Set the use of existing target group.
     parameters.useExistingTargetGroup = true;
     
     // The TargetGroupData type could take either data as an XML string
     // or as com.esri.baserver.FolderItem type, e.g.
     //var targetGroup:FolderItem = new FolderItem(workspaceName, projectName, FolderType.SEGMENTATION_TARGET_GROUPS, tgName);
     
     // Set a target group to be used.
     parameters.targetGroup = new TargetGroupData(targetGroup);
     
     // Set a core summary group name.
     parameters.coreTargetName = "U1. Principal Urban Centers I";
     
     // Set a developmental summary group name.
     parameters.developmentalTargetName = "U11. Rural II";
     
     // Set report parameters. 
     parameters.standardReportOptions = new ReportOptions("PDF");
     
     coreDevelopSegmentsTask.execute(parameters, new Responder(resultHandler, faultHandler));



© 2011 Esri, Inc. All rights reserved.

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