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

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

All Implemented Interfaces:

GPTool

public class DropRepresentation
extends AbstractGPTool

Deletes a feature class representation from a geodatabase feature class. The Drop Representation tool is contained in the Cartography Tools tool box.

Usage tips:

• Once a feature class representation is deleted from a feature class, all representation rules and feature overrides associated with that representation are deleted. No features from the source feature class are deleted.
• A feature class representation cannot be deleted from a feature class during an editing session. Deleting a representation is a schema change and schema changes are prevented during an editing session.

Field Summary

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

vals

Constructor Summary

DropRepresentation()
Creates the Drop Representation tool with defaults.

DropRepresentation(Object inFeatures, String representation)
Creates the Drop Representation 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.
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setRepresentation(String representation) Sets the Representation 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

DropRepresentation

public DropRepresentation()

Creates the Drop Representation tool with defaults.

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

DropRepresentation

public DropRepresentation(Object inFeatures,
                          String representation)

Creates the Drop 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 feature layer containing representation(s).

representation - the feature class representation to be deleted.

Method Detail

getInFeatures

public Object getInFeatures()

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

Parameters:

inFeatures - the input feature layer containing representation(s).

getRepresentation

public String getRepresentation()

Returns the Representation parameter of this tool . This parameter is the feature class representation to be deleted. 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 to be deleted. This is a required parameter.

Parameters:

representation - the feature class representation to be deleted.

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