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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.SplitLineAtPoint

All Implemented Interfaces:

GPTool

public class SplitLineAtPoint
extends AbstractGPTool

Splits line features based on intersection or proximity to point features. The Split Line at Point tool is contained in the Data Management Tools tool box.

Usage tips:

• Input Features must be lines.
• If search_radius is unspecified, a nearest point will be used to split the line feature.

Field Summary

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

vals

Constructor Summary

SplitLineAtPoint()
Creates the Split Line at Point tool with defaults.

SplitLineAtPoint(Object inFeatures, Object pointFeatures, Object outFeatureClass)
Creates the Split Line at Point tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getPointFeatures() Returns the Point Features parameter of this tool .
Object	getSearchRadius() Returns the Search Distance 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	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setPointFeatures(Object pointFeatures) Sets the Point Features parameter of this tool .
void	setSearchRadius(Object searchRadius) Sets the Search Distance 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

SplitLineAtPoint

public SplitLineAtPoint()

Creates the Split Line at Point tool with defaults.

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

SplitLineAtPoint

public SplitLineAtPoint(Object inFeatures,
                        Object pointFeatures,
                        Object outFeatureClass)

Creates the Split Line at Point 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 line features to be split.

pointFeatures - the input point features whose locations will be used to split the input lines.

outFeatureClass - the new feature class that will be created containing the split lines.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input line features to be split. 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 line features to be split. This is a required parameter.

Parameters:

inFeatures - the input line features to be split.

getPointFeatures

public Object getPointFeatures()

Returns the Point Features parameter of this tool . This parameter is the input point features whose locations will be used to split the input lines. This is a required parameter.

Returns:

the Point Features

setPointFeatures

public void setPointFeatures(Object pointFeatures)

Sets the Point Features parameter of this tool . This parameter is the input point features whose locations will be used to split the input lines. This is a required parameter.

Parameters:

pointFeatures - the input point features whose locations will be used to split the input lines.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the new feature class that will be created containing the split lines. 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 new feature class that will be created containing the split lines. This is a required parameter.

Parameters:

outFeatureClass - the new feature class that will be created containing the split lines.

getSearchRadius

public Object getSearchRadius()

Returns the Search Distance parameter of this tool . This parameter is used to split lines by their proximity to point features. Points within the search distance to an input line will be used to split those lines at the nearest location to the point along the line segment. This is an optional parameter.

Returns:

the Search Distance

setSearchRadius

public void setSearchRadius(Object searchRadius)

Sets the Search Distance parameter of this tool . This parameter is used to split lines by their proximity to point features. Points within the search distance to an input line will be used to split those lines at the nearest location to the point along the line segment. This is an optional parameter.

Parameters:

searchRadius - used to split lines by their proximity to point features. Points within the search distance to an input line will be used to split those lines at the nearest location to the point along the line segment.

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