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

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

public class PolygonToLine
extends AbstractGPTool

Creates a feature class containing lines that are converted from polygon boundaries or generated by splitting polygon boundaries at their intersections; each output line carries the left and right input polygon feature IDs. The Polygon To Line tool is contained in the Data Management Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
PolygonToLine()
          Creates the Polygon To Line tool with defaults.
PolygonToLine(Object inFeatures, Object outFeatureClass)
          Creates the Polygon To Line tool with the required parameters.
 
Method Summary
 Object getInFeatures()
          Returns the Input Features parameter of this tool .
 String getLeftRightOption()
          Returns the Provide left-right neighbor information 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.
 void setInFeatures(Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setLeftRightOption(String leftRightOption)
          Sets the Provide left-right neighbor information parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class 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

PolygonToLine

public PolygonToLine()
Creates the Polygon To Line tool with defaults.

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


PolygonToLine

public PolygonToLine(Object inFeatures,
                     Object outFeatureClass)
Creates the Polygon To Line 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 features that must be polygon.
outFeatureClass - the output line feature class.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is the input features that must be 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 features that must be polygon. This is a required parameter.

Parameters:
inFeatures - the input features that must be polygon.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is the output line feature class. 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 output line feature class. This is a required parameter.

Parameters:
outFeatureClass - the output line feature class.

getLeftRightOption

public String getLeftRightOption()
Returns the Provide left-right neighbor information parameter of this tool . This is an optional parameter.

Returns:
the Provide left-right neighbor information

setLeftRightOption

public void setLeftRightOption(String leftRightOption)
Sets the Provide left-right neighbor information parameter of this tool . This is an optional parameter.

Parameters:
leftRightOption - null

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