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

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

public class PointsToLine
extends AbstractGPTool

The Points To Line tool is contained in the Data Management Tools tool box.


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
PointsToLine()
          Creates the Points To Line tool with defaults.
PointsToLine(Object inputFeatures, Object outputFeatureClass, Object lineField)
          Creates the Points To Line tool with the required parameters.
 
Method Summary
 String getCloseLine()
          Returns the Close Line parameter of this tool .
 Object getInputFeatures()
          Returns the Input Features parameter of this tool .
 Object getLineField()
          Returns the Line Field parameter of this tool .
 Object getOutputFeatureClass()
          Returns the Output Feature Class parameter of this tool .
 Object getSortField()
          Returns the Sort Field 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 setCloseLine(String closeLine)
          Sets the Close Line parameter of this tool .
 void setInputFeatures(Object inputFeatures)
          Sets the Input Features parameter of this tool .
 void setLineField(Object lineField)
          Sets the Line Field parameter of this tool .
 void setOutputFeatureClass(Object outputFeatureClass)
          Sets the Output Feature Class parameter of this tool .
 void setSortField(Object sortField)
          Sets the Sort Field 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

PointsToLine

public PointsToLine()
Creates the Points To Line tool with defaults.

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


PointsToLine

public PointsToLine(Object inputFeatures,
                    Object outputFeatureClass,
                    Object lineField)
Creates the Points 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:
inputFeatures - null
outputFeatureClass - null
lineField - null
Method Detail

getInputFeatures

public Object getInputFeatures()
Returns the Input Features parameter of this tool . This is a required parameter.

Returns:
the Input Features

setInputFeatures

public void setInputFeatures(Object inputFeatures)
Sets the Input Features parameter of this tool . This is a required parameter.

Parameters:
inputFeatures - null

getOutputFeatureClass

public Object getOutputFeatureClass()
Returns the Output Feature Class parameter of this tool . This is a required parameter.

Returns:
the Output Feature Class

setOutputFeatureClass

public void setOutputFeatureClass(Object outputFeatureClass)
Sets the Output Feature Class parameter of this tool . This is a required parameter.

Parameters:
outputFeatureClass - null

getLineField

public Object getLineField()
Returns the Line Field parameter of this tool . This is a required parameter.

Returns:
the Line Field

setLineField

public void setLineField(Object lineField)
Sets the Line Field parameter of this tool . This is a required parameter.

Parameters:
lineField - null

getSortField

public Object getSortField()
Returns the Sort Field parameter of this tool . This parameter is by default, points used to created each output polygon feature will be used in the order they are found. If a different order is desired, specify a Sort Field. This is an optional parameter.

Returns:
the Sort Field

setSortField

public void setSortField(Object sortField)
Sets the Sort Field parameter of this tool . This parameter is by default, points used to created each output polygon feature will be used in the order they are found. If a different order is desired, specify a Sort Field. This is an optional parameter.

Parameters:
sortField - by default, points used to created each output polygon feature will be used in the order they are found. If a different order is desired, specify a Sort Field.

getCloseLine

public String getCloseLine()
Returns the Close Line parameter of this tool . This is an optional parameter.

Returns:
the Close Line

setCloseLine

public void setCloseLine(String closeLine)
Sets the Close Line parameter of this tool . This is an optional parameter.

Parameters:
closeLine - 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