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

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

All Implemented Interfaces:

GPTool

public class AddRepresentation
extends AbstractGPTool

Adds a feature class representation to a geodatabase feature class. The Add Representation tool is contained in the Cartography Tools tool box.

Usage tips:

• The input must be a geodatabase feature class.
• Two new fields with the specified field names will be appended to the input feature class attribute table to identify the representation rules that govern how each category of features will be portrayed, and to hold any feature-specific overrides to these rules.
• Specify an import rule layer to import symbol choices listed under the renderer type (i.e., Categories-Unique values) specified on the layer file. All of the symbol choices will be copied into this feature class representation as new representation rules. If an import rule layer is not specified, all features will be assigned to a single default representation rule.
• If the import rule layer has the same source feature class as the input feature class, you can use the Assign Rule IDs parameter to assign representation rules to features to match the RuleID assignments of the import rule layer.
• If an import rule layer is specified and the Assign Rule IDs parameter is set to ASSIGN, all features will be assigned to a representation rule based on the symbol choices listed under the renderer type (i.e., Categories-Unique values) specified on the layer file. If an import rule layer is specified, but the Assign Rule IDs parameter is set to NO_ASSIGN, all features will be assigned to a single default representation rule.
• If is used to symbolize features in the input layer, that symbol will become Rule ID 1 when a representation is added.

Field Summary

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

vals

Constructor Summary

AddRepresentation()
Creates the Add Representation tool with defaults.

AddRepresentation(Object inFeatures, String representationName)
Creates the Add Representation tool with the required parameters.

Method Summary

String	getAssignRuleIdOption() Returns the Assign Rule IDs parameter of this tool .
String	getGeometryEditingOption() Returns the Geometry Editing Option parameter of this tool .
Object	getImportRuleLayer() Returns the Import Rule Layer parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
String	getOverrideFieldName() Returns the Override Field Name parameter of this tool .
String	getRepresentationName() Returns the Representation Name parameter of this tool .
String	getRuleIdFieldName() Returns the Rule ID Field Name 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	setAssignRuleIdOption(String assignRuleIdOption) Sets the Assign Rule IDs parameter of this tool .
void	setGeometryEditingOption(String geometryEditingOption) Sets the Geometry Editing Option parameter of this tool .
void	setImportRuleLayer(Object importRuleLayer) Sets the Import Rule Layer parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOverrideFieldName(String overrideFieldName) Sets the Override Field Name parameter of this tool .
void	setRepresentationName(String representationName) Sets the Representation Name parameter of this tool .
void	setRuleIdFieldName(String ruleIdFieldName) Sets the Rule ID Field Name 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

AddRepresentation

public AddRepresentation()

Creates the Add Representation tool with defaults.

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

AddRepresentation

public AddRepresentation(Object inFeatures,
                         String representationName)

Creates the Add Representation 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 input geodatabase feature class to which a new feature class representation will be added.

representationName - the name of the feature class representation to be added.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input geodatabase feature class to which a new feature class representation will be added. 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 input geodatabase feature class to which a new feature class representation will be added. This is a required parameter.

Parameters:

inFeatures - the input geodatabase feature class to which a new feature class representation will be added.

getRepresentationName

public String getRepresentationName()

Returns the Representation Name parameter of this tool . This parameter is the name of the feature class representation to be added. This is a required parameter.

Returns:

the Representation Name

setRepresentationName

public void setRepresentationName(String representationName)

Sets the Representation Name parameter of this tool . This parameter is the name of the feature class representation to be added. This is a required parameter.

Parameters:

representationName - the name of the feature class representation to be added.

getRuleIdFieldName

public String getRuleIdFieldName()

Returns the Rule ID Field Name parameter of this tool . This parameter is the name of the RuleID field, which will hold a reference to the representation rule for each feature. This is an optional parameter.

Returns:

the Rule ID Field Name

setRuleIdFieldName

public void setRuleIdFieldName(String ruleIdFieldName)

Sets the Rule ID Field Name parameter of this tool . This parameter is the name of the RuleID field, which will hold a reference to the representation rule for each feature. This is an optional parameter.

Parameters:

ruleIdFieldName - the name of the RuleID field, which will hold a reference to the representation rule for each feature.

getOverrideFieldName

public String getOverrideFieldName()

Returns the Override Field Name parameter of this tool . This parameter is the name of the Override field, which will hold overrides to representation rules for each feature. This is an optional parameter.

Returns:

the Override Field Name

setOverrideFieldName

public void setOverrideFieldName(String overrideFieldName)

Sets the Override Field Name parameter of this tool . This parameter is the name of the Override field, which will hold overrides to representation rules for each feature. This is an optional parameter.

Parameters:

overrideFieldName - the name of the Override field, which will hold overrides to representation rules for each feature.

getGeometryEditingOption

public String getGeometryEditingOption()

Returns the Geometry Editing Option parameter of this tool . This parameter is specifies what will happen to the supporting feature class geometry when features are modified with the representation editing tools. This is an optional parameter.

Returns:

the Geometry Editing Option

setGeometryEditingOption

public void setGeometryEditingOption(String geometryEditingOption)

Sets the Geometry Editing Option parameter of this tool . This parameter is specifies what will happen to the supporting feature class geometry when features are modified with the representation editing tools. This is an optional parameter.

Parameters:

geometryEditingOption - specifies what will happen to the supporting feature class geometry when features are modified with the representation editing tools.

getImportRuleLayer

public Object getImportRuleLayer()

Returns the Import Rule Layer parameter of this tool . This parameter is a feature layer that symbolizes features with a feature class representation, from which the representation rules are imported. This is an optional parameter.

Returns:

the Import Rule Layer

setImportRuleLayer

public void setImportRuleLayer(Object importRuleLayer)

Sets the Import Rule Layer parameter of this tool . This parameter is a feature layer that symbolizes features with a feature class representation, from which the representation rules are imported. This is an optional parameter.

Parameters:

importRuleLayer - a feature layer that symbolizes features with a feature class representation, from which the representation rules are imported.

getAssignRuleIdOption

public String getAssignRuleIdOption()

Returns the Assign Rule IDs parameter of this tool . This parameter is specifies whether or not to assign representation rules to features to match the RuleID assignments of the import rule layer. This option applies only when Import Rule Layer is specified. This is an optional parameter.

Returns:

the Assign Rule IDs

setAssignRuleIdOption

public void setAssignRuleIdOption(String assignRuleIdOption)

Sets the Assign Rule IDs parameter of this tool . This parameter is specifies whether or not to assign representation rules to features to match the RuleID assignments of the import rule layer. This option applies only when Import Rule Layer is specified. This is an optional parameter.

Parameters:

assignRuleIdOption - specifies whether or not to assign representation rules to features to match the RuleID assignments of the import rule layer. This option applies only when Import Rule Layer is specified.

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