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

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

public class RegionClass
extends AbstractGPTool

Converts arcs to preliminary regions in a new or existing coverage or appends preliminary regions to an existing region subclass. The Line Coverage To Region tool is contained in the Coverage Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
RegionClass()
          Creates the Line Coverage To Region tool with defaults.
RegionClass(Object inCover, String outSubclass)
          Creates the Line Coverage To Region tool with the required parameters.
 
Method Summary
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 Object getInRegionItem()
          Returns the Input Region Item parameter of this tool .
 String getMethod()
          Returns the Create Regions From parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage parameter of this tool .
 String getOutRegionItem()
          Returns the Output Region Item parameter of this tool .
 String getOutSubclass()
          Returns the Output Subclass parameter of this tool .
 Object getSelectionFile()
          Returns the Selection File 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 setInRegionItem(Object inRegionItem)
          Sets the Input Region Item parameter of this tool .
 void setMethod(String method)
          Sets the Create Regions From parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage parameter of this tool .
 void setOutRegionItem(String outRegionItem)
          Sets the Output Region Item parameter of this tool .
 void setOutSubclass(String outSubclass)
          Sets the Output Subclass parameter of this tool .
 void setSelectionFile(Object selectionFile)
          Sets the Selection File 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

RegionClass

public RegionClass()
Creates the Line Coverage To Region tool with defaults.

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


RegionClass

public RegionClass(Object inCover,
                   String outSubclass)
Creates the Line 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 coverage containing the arcs from which the preliminary regions are created.
outSubclass - the name of the region subclass to be created or appended.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is the coverage containing the arcs from which the preliminary regions are created. 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 arcs from which the preliminary regions are created. This is a required parameter.

Parameters:
inCover - the coverage containing the arcs from which the preliminary regions are created.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is the coverage that will contain the preliminary regions. If the output coverage is not specified, the preliminary regions are created in the input coverage. This is an optional 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 preliminary regions. If the output coverage is not specified, the preliminary regions are created in the input coverage. This is an optional parameter.

Parameters:
outCover - the coverage that will contain the preliminary regions. If the output coverage is not specified, the preliminary regions are created in the input coverage.

getOutSubclass

public String getOutSubclass()
Returns the Output Subclass parameter of this tool . This parameter is the name of the region subclass to be created or appended. 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 to be created or appended. This is a required parameter.

Parameters:
outSubclass - the name of the region subclass to be created or appended.

getInRegionItem

public Object getInRegionItem()
Returns the Input Region Item parameter of this tool . This parameter is item in the AAT of the input coverage whose values are used to group arcs into preliminary regions. The item is appended to the region PATsubclass. If not specified, each group of arcs becomes a preliminary region. This is an optional parameter.

Returns:
the Input Region Item

setInRegionItem

public void setInRegionItem(Object inRegionItem)
Sets the Input Region Item parameter of this tool . This parameter is item in the AAT of the input coverage whose values are used to group arcs into preliminary regions. The item is appended to the region PATsubclass. If not specified, each group of arcs becomes a preliminary region. This is an optional parameter.

Parameters:
inRegionItem - item in the AAT of the input coverage whose values are used to group arcs into preliminary regions. The item is appended to the region PATsubclass. If not specified, each group of arcs becomes a preliminary region.

getOutRegionItem

public String getOutRegionItem()
Returns the Output Region Item parameter of this tool . This parameter is output name for the input region Item to be used in the region PATsubclass instead of the Input Region Item name. This is an optional parameter.

Returns:
the Output Region Item

setOutRegionItem

public void setOutRegionItem(String outRegionItem)
Sets the Output Region Item parameter of this tool . This parameter is output name for the input region Item to be used in the region PATsubclass instead of the Input Region Item name. This is an optional parameter.

Parameters:
outRegionItem - output name for the input region Item to be used in the region PATsubclass instead of the Input Region Item name.

getSelectionFile

public Object getSelectionFile()
Returns the Selection File parameter of this tool . This parameter is the name of a selection file that can be used to specify a subset of the arcs to be grouped into preliminary regions. This is an optional parameter.

Returns:
the Selection File

setSelectionFile

public void setSelectionFile(Object selectionFile)
Sets the Selection File parameter of this tool . This parameter is the name of a selection file that can be used to specify a subset of the arcs to be grouped into preliminary regions. This is an optional parameter.

Parameters:
selectionFile - the name of a selection file that can be used to specify a subset of the arcs to be grouped into preliminary regions.

getMethod

public String getMethod()
Returns the Create Regions From parameter of this tool . This parameter is determines whether regions will be created from multiple rings of arcs or single rings of arcs. This is an optional parameter.

Returns:
the Create Regions From

setMethod

public void setMethod(String method)
Sets the Create Regions From parameter of this tool . This parameter is determines whether regions will be created from multiple rings of arcs or single rings of arcs. This is an optional parameter.

Parameters:
method - determines whether regions will be created from multiple rings of arcs or single rings of arcs.

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