Package | com.esri.baserver.tasks.segmentation |
Class | public class ProfileByTableGeocodingParameters |
Inheritance | ProfileByTableGeocodingParameters BAUtilityParameters BABaseParameters Object |
Implements | IBAResultProcessor |
Only matched address records will be taken into account in the output segmentation profile.
The output profile can be saved in the Business Analyst Server repository
if the outputItem
parameter is specified.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BAUtilityParameters | ||
geocodeData : GeocodeData
Table containing address records (required). | ProfileByTableGeocodingParameters | ||
outputItem : FolderItem
Configuration options for storing the output item in the repository. | ProfileByTableGeocodingParameters | ||
resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | ||
segmentationBase : String
Segmentation base (required). | ProfileByTableGeocodingParameters | ||
taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters | ||
weightField : String
The attribute field in the geocodeData table which contains weight value
(e.g., sales) for each address record (optional). | ProfileByTableGeocodingParameters |
Method | Defined By | ||
---|---|---|---|
Creates a new instance of the ProfileByTableGeocodingParameters class. | ProfileByTableGeocodingParameters |
geocodeData | property |
geocodeData:GeocodeData
Table containing address records (required).
public function get geocodeData():GeocodeData
public function set geocodeData(value:GeocodeData):void
outputItem | property |
outputItem:FolderItem
Configuration options for storing the output item in the repository.
public function get outputItem():FolderItem
public function set outputItem(value:FolderItem):void
segmentationBase | property |
segmentationBase:String
Segmentation base (required). Use the Get Segmentation Bases lookup operation to query available segmentation bases.
public function get segmentationBase():String
public function set segmentationBase(value:String):void
See also
weightField | property |
weightField:String
The attribute field in the geocodeData
table which contains weight value
(e.g., sales) for each address record (optional).
public function get weightField():String
public function set weightField(value:String):void
ProfileByTableGeocodingParameters | () | Constructor |
public function ProfileByTableGeocodingParameters()
Creates a new instance of the ProfileByTableGeocodingParameters class.
var parameters : ProfileByTableGeocodingParameters = new ProfileByTableGeocodingParameters(); // The GeocodeData type is an address information for geocoding, e.g. //var geocodeData : GeocodeData = new GeocodeData(new TableData(geocodeAddressesData)); parameters.geocodeData = geocodeData; // Set a segmentation base. parameters.segmentationBase = "Total Households"; // Set an attribute field in the geocodeData table which contains weight value (optional). parameters.weightField = "SALES"; profileByTableGeocodingTask.execute(parameters, new Responder(resultHandler, faultHandler));