com.esri.arcgis.geoprocessing.tools.cartographytools
Class CalculateRepresentationRule

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.CalculateRepresentationRule

All Implemented Interfaces:

GPTool

public class CalculateRepresentationRule
extends AbstractGPTool

Applies existing representation rules to features in a feature class representation by calculating the RuleID field. The Calculate Representation Rule tool is contained in the Cartography Tools tool box.

Usage tips:

• The input must be a geodatabase feature class with at least one feature class representation.
• Specify a representation rule to assign to a feature. The selected feature or features will have their Rule ID field populated with the specified rule.
• If the specified Rule ID matches the current Rule ID for a selected feature or features, there will be no change.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

CalculateRepresentationRule()
Creates the Calculate Representation Rule tool with defaults.

CalculateRepresentationRule(Object inFeatures, String representation, String representationRule)
Creates the Calculate Representation Rule tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
String	getRepresentation() Returns the Representation parameter of this tool .
String	getRepresentationRule() Returns the Representation Rule parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setRepresentation(String representation) Sets the Representation parameter of this tool .
void	setRepresentationRule(String representationRule) Sets the Representation Rule parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CalculateRepresentationRule

public CalculateRepresentationRule()

Creates the Calculate Representation Rule tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

CalculateRepresentationRule

public CalculateRepresentationRule(Object inFeatures,
                                   String representation,
                                   String representationRule)

Creates the Calculate Representation Rule tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inFeatures - the feature class that contains the features for which representation rules will be calculated.

representation - the feature class representation that contains the representation rules that will be applied to features. This feature class representation must belong to the input feature class.

representationRule - the representation rule to be applied to the input features by calculating the RuleID field.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the feature class that contains the features for which representation rules will be calculated. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the feature class that contains the features for which representation rules will be calculated. This is a required parameter.

Parameters:

inFeatures - the feature class that contains the features for which representation rules will be calculated.

getRepresentation

public String getRepresentation()

Returns the Representation parameter of this tool . This parameter is the feature class representation that contains the representation rules that will be applied to features. This feature class representation must belong to the input feature class. This is a required parameter.

Returns:

the Representation

setRepresentation

public void setRepresentation(String representation)

Sets the Representation parameter of this tool . This parameter is the feature class representation that contains the representation rules that will be applied to features. This feature class representation must belong to the input feature class. This is a required parameter.

Parameters:

representation - the feature class representation that contains the representation rules that will be applied to features. This feature class representation must belong to the input feature class.

getRepresentationRule

public String getRepresentationRule()

Returns the Representation Rule parameter of this tool . This parameter is the representation rule to be applied to the input features by calculating the RuleID field. This is a required parameter.

Returns:

the Representation Rule

setRepresentationRule

public void setRepresentationRule(String representationRule)

Sets the Representation Rule parameter of this tool . This parameter is the representation rule to be applied to the input features by calculating the RuleID field. This is a required parameter.

Parameters:

representationRule - the representation rule to be applied to the input features by calculating the RuleID field.

getOutFeatures

public Object getOutFeatures()

Returns the Output Features parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Features

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias