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

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

All Implemented Interfaces:

GPTool

public class FeatureToPoint
extends AbstractGPTool

Creates a feature class containing points generated from the representative locations of input features. The Feature To Point tool is contained in the Data Management Tools tool box.

Usage tips:

• The attributes of the input features will be maintained in the output feature class. A new field, ORIG_FID, will be added to the output feature class and set to the input feature IDs.
• If the Inside option on the dialog box is(the point_location parameter is set to CENTROID), the location of the output point will be determined as follows:
  • For an input multipoint feature: the output point will be located at the average x and y coordinates of all the points in the multipoint feature.
  • For an input line feature: the output point will be located at the weighted average x and y coordinates of the midpoints of all line segments in the line feature; where the weight of a particular midpoint is the length of the correspondent line segment. Parametric (true) curves are first densified.
  • For an input polygon feature: the output point will be located at the center of gravity (centroid) of the polygon.
  If the Inside option on the dialog box is(the point_location parameter is set to INSIDE), the location of the representative point of an input feature will be contained by the input feature and determined as follows:
  • For an input multipoint: the output point will be coincident with one of the points in the multipoint.
  • For an input line: the output point will be on the line. If the line is a parametric (true) curve, the output point will be at the midpoint of the line.
  • For an input polygon: the output point will be inside the polygon.

Field Summary

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

vals

Constructor Summary

FeatureToPoint()
Creates the Feature To Point tool with defaults.

FeatureToPoint(Object inFeatures, Object outFeatureClass)
Creates the Feature To 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 .
String	getPointLocation() Returns the Inside 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	setPointLocation(String pointLocation) Sets the Inside 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

FeatureToPoint

public FeatureToPoint()

Creates the Feature To Point tool with defaults.

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

FeatureToPoint

public FeatureToPoint(Object inFeatures,
                      Object outFeatureClass)

Creates the Feature To 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 features that can be multipoint, line, polygon, or annotation.

outFeatureClass - the output point feature class.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input features that can be multipoint, line, polygon, or annotation. 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 can be multipoint, line, polygon, or annotation. This is a required parameter.

Parameters:

inFeatures - the input features that can be multipoint, line, polygon, or annotation.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output point 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 point feature class. This is a required parameter.

Parameters:

outFeatureClass - the output point feature class.

getPointLocation

public String getPointLocation()

Returns the Inside parameter of this tool . This parameter is specifies whether to use representative centers of input features or locations contained by input features as the output point locations. This is an optional parameter.

Returns:

the Inside

setPointLocation

public void setPointLocation(String pointLocation)

Sets the Inside parameter of this tool . This parameter is specifies whether to use representative centers of input features or locations contained by input features as the output point locations. This is an optional parameter.

Parameters:

pointLocation - specifies whether to use representative centers of input features or locations contained by input features as the output point locations.

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