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

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

public class FeatureEnvelopeToPolygon
extends AbstractGPTool

Creates a feature class containing polygons, each of which represents the envelope of an input feature. The Feature Envelope to Polygon 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
FeatureEnvelopeToPolygon()
          Creates the Feature Envelope to Polygon tool with defaults.
FeatureEnvelopeToPolygon(Object inFeatures, Object outFeatureClass)
          Creates the Feature Envelope to Polygon 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 getSingleEnvelope()
          Returns the Create multipart features 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 setSingleEnvelope(String singleEnvelope)
          Sets the Create multipart features 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

FeatureEnvelopeToPolygon

public FeatureEnvelopeToPolygon()
Creates the Feature Envelope to Polygon tool with defaults.

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


FeatureEnvelopeToPolygon

public FeatureEnvelopeToPolygon(Object inFeatures,
                                Object outFeatureClass)
Creates the Feature Envelope to Polygon 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 polygon 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 polygon 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 polygon feature class. This is a required parameter.

Parameters:
outFeatureClass - the output polygon feature class.

getSingleEnvelope

public String getSingleEnvelope()
Returns the Create multipart features parameter of this tool . This parameter is specifies whether to use one envelope for each entire multipart feature or one envelope per part of a multipart feature. This parameter will affect the results of multipart input features only. This is an optional parameter.

Returns:
the Create multipart features

setSingleEnvelope

public void setSingleEnvelope(String singleEnvelope)
Sets the Create multipart features parameter of this tool . This parameter is specifies whether to use one envelope for each entire multipart feature or one envelope per part of a multipart feature. This parameter will affect the results of multipart input features only. This is an optional parameter.

Parameters:
singleEnvelope - specifies whether to use one envelope for each entire multipart feature or one envelope per part of a multipart feature. This parameter will affect the results of multipart input features only.

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