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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.cartographytools.UpdateOverride
All Implemented Interfaces:
GPTool

public class UpdateOverride
extends AbstractGPTool

Transfers feature representation overrides from the default override field to explicit fields as defined by the representation rules in the representation. The Update Override tool is contained in the Cartography Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
UpdateOverride()
          Creates the Update Override tool with defaults.
UpdateOverride(Object inFeatures, String representation)
          Creates the Update Override 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 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.
 String getUpdateOption()
          Returns the Update Option parameter 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 setUpdateOption(String updateOption)
          Sets the Update Option 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

UpdateOverride

public UpdateOverride()
Creates the Update Override tool with defaults.

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


UpdateOverride

public UpdateOverride(Object inFeatures,
                      String representation)
Creates the Update Override 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 feature layer containing at least one representation.
representation - the representation containing overrides to be transferred to explicit fields.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is the input feature layer containing at least one representation. 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 feature layer containing at least one representation. This is a required parameter.

Parameters:
inFeatures - the input feature layer containing at least one representation.

getRepresentation

public String getRepresentation()
Returns the Representation parameter of this tool . This parameter is the representation containing overrides to be transferred to explicit fields. 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 representation containing overrides to be transferred to explicit fields. This is a required parameter.

Parameters:
representation - the representation containing overrides to be transferred to explicit fields.

getUpdateOption

public String getUpdateOption()
Returns the Update Option parameter of this tool . This parameter is specifies the type of representation override to be transferred to explicit fields. This is an optional parameter.

Returns:
the Update Option

setUpdateOption

public void setUpdateOption(String updateOption)
Sets the Update Option parameter of this tool . This parameter is specifies the type of representation override to be transferred to explicit fields. This is an optional parameter.

Parameters:
updateOption - specifies the type of representation override to be transferred to explicit fields.

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