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

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

All Implemented Interfaces:

GPTool

public class RegionPoly
extends AbstractGPTool

Converts a region subclass to a polygon coverage and creates an INFO table containing overlapping region information. The Region To Polygon Coverage tool is contained in the Coverage Tools tool box.

Usage tips:

• All items in the region subclass polygon attribute table (PAT) are maintained in the Output Coverage PAT.
• The Output Coverage PAT contains only the attributes of the first region associated with each polygon. Values of zero indicate void areas in which the subclass does not exist.
• The attributes of the second to the Nth regions associated with each polygon are stored in the Output Table.
• If only one region is associated with each polygon (a planar region subclass), then the Output Table does not need to be specified. However, an Output Table must be specified when using non-planar region subclasses.
• The polygon User-IDs of the Output Coverage will be altered.
• Use the Output Table to relate the Output Coverage polygons to the Input Coverage region subclass.

Field Summary

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

vals

Constructor Summary

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

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

Method Summary

Object	getInCover() Returns the Input Coverage parameter of this tool .
String	getInSubclass() Returns the Input Subclass parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool .
Object	getOutTable() Returns the Output Table 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	setInSubclass(String inSubclass) Sets the Input Subclass parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage parameter of this tool .
void	setOutTable(Object outTable) Sets the Output Table 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

RegionPoly

public RegionPoly()

Creates the Region To Polygon Coverage tool with defaults.

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

RegionPoly

public RegionPoly(Object inCover,
                  Object outCover,
                  String inSubclass)

Creates the Region To Polygon Coverage 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 coverage containing the region subclass to convert to polygons.

outCover - the polygon coverage to be created from the Input Subclass. The coverage may not already exist.

inSubclass - the region subclass of the Input Coverage that will be converted to a polygon coverage.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage containing the region subclass to convert to polygons. 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 coverage containing the region subclass to convert to polygons. This is a required parameter.

Parameters:

inCover - the coverage containing the region subclass to convert to polygons.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the polygon coverage to be created from the Input Subclass. The coverage may not already exist. 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 polygon coverage to be created from the Input Subclass. The coverage may not already exist. This is a required parameter.

Parameters:

outCover - the polygon coverage to be created from the Input Subclass. The coverage may not already exist.

getInSubclass

public String getInSubclass()

Returns the Input Subclass parameter of this tool . This parameter is the region subclass of the Input Coverage that will be converted to a polygon coverage. This is a required parameter.

Returns:

the Input Subclass

setInSubclass

public void setInSubclass(String inSubclass)

Sets the Input Subclass parameter of this tool . This parameter is the region subclass of the Input Coverage that will be converted to a polygon coverage. This is a required parameter.

Parameters:

inSubclass - the region subclass of the Input Coverage that will be converted to a polygon coverage.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is the output INFO table that will contain information for regions associated with each polygon. This is an optional parameter.

Returns:

the Output Table

setOutTable

public void setOutTable(Object outTable)

Sets the Output Table parameter of this tool . This parameter is the output INFO table that will contain information for regions associated with each polygon. This is an optional parameter.

Parameters:

outTable - the output INFO table that will contain information for regions associated with each polygon.

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