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

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

All Implemented Interfaces:

GPTool

public class FeatureToLine
extends AbstractGPTool

Creates a new output line The Feature To Line tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• The attributes of the Input Features are transferred to the Output Feature Class lines.
• To get lines with right and left polygon IDs as attributes from a polygon feature class, use the Polygon To Line tool instead.
• If the Preserve Attributes parameter is set to NO_ATTRIBUTES (or not checked on the dialog box), none of the input's attributes will be transferred to the output.
• An output line features will be created for each input line, and each input polygon boundary. If input lines or polygon boundaries cross, the output lines will be split into different features at those locations.
• Learn more about spatial reference and geoprocessing;
• The following environment settings affect this tool: Coordinate system; Extent; XY Tolerance; Z Tolerance; M Tolerance; XY Resolution; Z Resolution; M Resolution; Output XY domain; Output Z domain; Output M domain; Output has M values; Output has Z values; Default Z value; Configuration keyword; Output Spatial Grid;

Field Summary

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

vals

Constructor Summary

FeatureToLine()
Creates the Feature To Line tool with defaults.

FeatureToLine(Object inFeatures, Object outFeatureClass)
Creates the Feature To Line tool with the required parameters.

Method Summary

String	getAttributes() Returns the Preserve attributes parameter of this tool .
Object	getClusterTolerance() Returns the XY Tolerance parameter of this tool .
Object	getInFeatures() Returns the Input Features 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	setAttributes(String attributes) Sets the Preserve attributes parameter of this tool .
void	setClusterTolerance(Object clusterTolerance) Sets the XY Tolerance parameter 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 .

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

FeatureToLine

public FeatureToLine()

Creates the Feature To Line tool with defaults.

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

FeatureToLine

public FeatureToLine(Object inFeatures,
                     Object outFeatureClass)

Creates the Feature 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 - Feature Layer, input polygon features whose geometry will be used to create line features.

outFeatureClass - Feature Class, the feature class to be created that will contain the line features.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is Feature Layer, input polygon features whose geometry will be used to create line features. 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 Feature Layer, input polygon features whose geometry will be used to create line features. This is a required parameter.

Parameters:

inFeatures - Feature Layer, input polygon features whose geometry will be used to create line features.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class to be created that will contain the line features. 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 Feature Class, the feature class to be created that will contain the line features. This is a required parameter.

Parameters:

outFeatureClass - Feature Class, the feature class to be created that will contain the line features.

getClusterTolerance

public Object getClusterTolerance()

Returns the XY Tolerance parameter of this tool . This parameter is Linear unit, level of your data. By default, the minimum possible tolerance value is calculated in the units of the spatial reference of the input. This is an optional parameter.

Returns:

the XY Tolerance

setClusterTolerance

public void setClusterTolerance(Object clusterTolerance)

Sets the XY Tolerance parameter of this tool . This parameter is Linear unit, level of your data. By default, the minimum possible tolerance value is calculated in the units of the spatial reference of the input. This is an optional parameter.

Parameters:

clusterTolerance - Linear unit, level of your data. By default, the minimum possible tolerance value is calculated in the units of the spatial reference of the input.

getAttributes

public String getAttributes()

Returns the Preserve attributes parameter of this tool . This parameter is String, if this parameter is set to Attributes and there are coincident lines or polygon boundaries within an input feature class, for example the boundary seperating two polygons, two features with identical line geometry will be written to the output. One output feature will have the attribute of one of the input polygons, and the other output line feature will have the attribute of the other input polygon. If this parameter is set to No_Attributes, a single line feature will be written to the output. This is an optional parameter.

Returns:

the Preserve attributes

setAttributes

public void setAttributes(String attributes)

Sets the Preserve attributes parameter of this tool . This parameter is String, if this parameter is set to Attributes and there are coincident lines or polygon boundaries within an input feature class, for example the boundary seperating two polygons, two features with identical line geometry will be written to the output. One output feature will have the attribute of one of the input polygons, and the other output line feature will have the attribute of the other input polygon. If this parameter is set to No_Attributes, a single line feature will be written to the output. This is an optional parameter.

Parameters:

attributes - String, if this parameter is set to Attributes and there are coincident lines or polygon boundaries within an input feature class, for example the boundary seperating two polygons, two features with identical line geometry will be written to the output. One output feature will have the attribute of one of the input polygons, and the other output line feature will have the attribute of the other input polygon. If this parameter is set to No_Attributes, a single line feature will be written to the output.

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