com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class Dice

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.Dice

All Implemented Interfaces:

GPTool

public class Dice
extends AbstractGPTool

Subdivides a feature into smaller features based on a specified vertex limit. This tool is intended as a way to subdivide extremely large features which cause issues with drawing, analysis, editing, and/or performance but are difficult to split up with standard editing and geoprocessing tools. This tool should not be used in any cases other than those where tools are failing to complete successfully due to the size of features. The Dice tool is contained in the Data Management Tools tool box.

Usage tips:

• The input can be a multipoint, line, or polygon feature layer or feature class.
• No default vertex limit is provided. The number of vertices in a single feature that may cause issues due to being too large is dependent on your hardware configuration.
• Features which do not exceed the vertex limit will be written to the output feature class as is.
• The splitting of polygons may create new vertices.
• Polygon components (think of this as the outer boundary of a part, and all the holes and other parts which it contains) will be grouped together in the output.
• Lines are only diced at a vertex.
• For line and polygon feature classes the number of vertices specified in the Vertex Limit parameter is not always the vertex count you get in the output after a feature has been diced.
• This tool does not use the Output Coordinate System environment. This means there will be no projecting of features prior to processing. You always end up with the same coordinate system as the input. Any projecting should be done after the Dice tool has been run. This is done because projecting the "problem" feature may cause a system failure if it exceeds system resources.

Field Summary

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

vals

Constructor Summary

Dice()
Creates the Dice tool with defaults.

Dice(Object inFeatures, Object outFeatureClass, int vertexLimit)
Creates the Dice tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class 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.
int	getVertexLimit() Returns the Vertex Limit parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setVertexLimit(int vertexLimit) Sets the Vertex Limit 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

Dice

public Dice()

Creates the Dice tool with defaults.

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

Dice

public Dice(Object inFeatures,
            Object outFeatureClass,
            int vertexLimit)

Creates the Dice 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 class or feature layer. The geometry type must be multipoint, line, or polygon.

outFeatureClass - the feature class which will be created and to which the result will be written

vertexLimit - features with geometries which exceed this vertex limit will be subdivided before being written to the output feature class.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input feature class or feature layer. The geometry type must be multipoint, line, or polygon. 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 class or feature layer. The geometry type must be multipoint, line, or polygon. This is a required parameter.

Parameters:

inFeatures - the input feature class or feature layer. The geometry type must be multipoint, line, or polygon.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the feature class which will be created and to which the result will be written This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the feature class which will be created and to which the result will be written This is a required parameter.

Parameters:

outFeatureClass - the feature class which will be created and to which the result will be written

getVertexLimit

public int getVertexLimit()

Returns the Vertex Limit parameter of this tool . This parameter is features with geometries which exceed this vertex limit will be subdivided before being written to the output feature class. This is a required parameter.

Returns:

the Vertex Limit

setVertexLimit

public void setVertexLimit(int vertexLimit)

Sets the Vertex Limit parameter of this tool . This parameter is features with geometries which exceed this vertex limit will be subdivided before being written to the output feature class. This is a required parameter.

Parameters:

vertexLimit - features with geometries which exceed this vertex limit will be subdivided before being written to the output feature class.

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