com.esri.arcgis.geoprocessing.tools.coveragetools
Class PolyRegion

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.PolyRegion

All Implemented Interfaces:

GPTool

public class PolyRegion
extends AbstractGPTool

Converts polygons to regions in a one-to-one mapping in a region subclass. The Polygon Coverage To Region tool is contained in the Coverage Tools tool box.

Usage tips:

• This tool can be used on an Input Coverage that does not have arc topology; however, the Input Coverage must have polygon topology.
• The tool builds region topology for the Output Subclass. Topology in the Input Coverage is maintained in the Output Coverage.
• When the Output Coverage is not the same as the Input Coverage, a new coverage will be created, and the Input Coverage is copied to the Output Coverage.
• The Output Coverage cannot refer to an existing coverage unless it's the Input Coverage.
• Polygon attributes are copied to the region subclass.
• Region subclass names may be from 1 to 13 characters and cannot start with a numeric character.

Field Summary

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

vals

Constructor Summary

PolyRegion()
Creates the Polygon Coverage To Region tool with defaults.

PolyRegion(Object inCover, Object outCover, String outSubclass)
Creates the Polygon Coverage To Region tool with the required parameters.

Method Summary

Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool .
String	getOutSubclass() Returns the Output Subclass 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	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage parameter of this tool .
void	setOutSubclass(String outSubclass) Sets the Output Subclass 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

PolyRegion

public PolyRegion()

Creates the Polygon Coverage To Region tool with defaults.

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

PolyRegion

public PolyRegion(Object inCover,
                  Object outCover,
                  String outSubclass)

Creates the Polygon Coverage To Region 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:

inCover - the polygon coverage to be converted to a region subclass. Each polygon of the is made into a region.

outCover - the coverage that will contain the new subclass.

outSubclass - the name of the region subclass that will be created.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the polygon coverage to be converted to a region subclass. Each polygon of the is made into a region. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the polygon coverage to be converted to a region subclass. Each polygon of the is made into a region. This is a required parameter.

Parameters:

inCover - the polygon coverage to be converted to a region subclass. Each polygon of the is made into a region.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the coverage that will contain the new subclass. This is a required parameter.

Returns:

the Output Coverage

setOutCover

public void setOutCover(Object outCover)

Sets the Output Coverage parameter of this tool . This parameter is the coverage that will contain the new subclass. This is a required parameter.

Parameters:

outCover - the coverage that will contain the new subclass.

getOutSubclass

public String getOutSubclass()

Returns the Output Subclass parameter of this tool . This parameter is the name of the region subclass that will be created. This is a required parameter.

Returns:

the Output Subclass

setOutSubclass

public void setOutSubclass(String outSubclass)

Sets the Output Subclass parameter of this tool . This parameter is the name of the region subclass that will be created. This is a required parameter.

Parameters:

outSubclass - the name of the region subclass that will be created.

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