com.esri.arcgis.carto
Interface IBasicGeoprocessor

All Superinterfaces:
Serializable
All Known Implementing Classes:
BasicGeoprocessor

public interface IBasicGeoprocessor
extends Serializable

Provides access to members that control the basic geoprocessor.

Remarks

Dissolve aggregates features of an input layer based on values of a specified attribute; and can be used to create either a new layer or a stand alone summary table.

Merge combines layers of the same geometry type into a single feature class.

Clip extracts features of a point, line, or polygon layer based on the spatial extent of an overlay polygon layer. The attributes of the input feature class are carried over to the output feature class.

Intersect clips the features of a line or polygon layer with features of an overlay polygon layer. The output feature class will have the attributes of both input and overlay layers.

Union combines the features of two polygon layers into a new feature class that contains the attributes and the full spatial extent of both layers.

IBasicGeoprocessor.SpatialReference should be set to an appropriate to high or low precision based on the target workspace. For more details see the SpatialReference documentation, especially the ISpatialReferenceResolution interface.

When To Use

IBasicGeoprocessor provides access to the methods and properties of the BasicGeoprocessor object. The functionality of the BasicGeoprocessor object had been superseded by the new Geoprocessing framework of ArcGIS starting at version 9.0. Developers should utilize the new tools whenever possible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
IBasicGeoprocessor.dissolve(com.esri.arcgis.geodatabase.ITable, boolean, String, String, com.esri.arcgis.geodatabase.IDatasetName), IBasicGeoprocessor.intersect(com.esri.arcgis.geodatabase.ITable, boolean, com.esri.arcgis.geodatabase.ITable, boolean, double, com.esri.arcgis.geodatabase.IFeatureClassName), IBasicGeoprocessor.clip(com.esri.arcgis.geodatabase.ITable, boolean, com.esri.arcgis.geodatabase.ITable, boolean, double, com.esri.arcgis.geodatabase.IFeatureClassName), IBasicGeoprocessor.merge(com.esri.arcgis.system.IArray, com.esri.arcgis.geodatabase.ITable, com.esri.arcgis.geodatabase.IFeatureClassName), IBasicGeoprocessor.union(com.esri.arcgis.geodatabase.ITable, boolean, com.esri.arcgis.geodatabase.ITable, boolean, double, com.esri.arcgis.geodatabase.IFeatureClassName)

Method Summary
 IFeatureClass clip(ITable inputTable, boolean useSelectedInput, ITable clipTable, boolean useSelectedClip, double tolerance, IFeatureClassName outputName)
          Clips features.
 ITable dissolve(ITable inputTable, boolean useSelected, String dissolveField, String summaryFields, IDatasetName outputName)
          Dissolves features.
 ISpatialReference getSpatialReference()
          The output spatial reference.
 IFeatureClass intersect(ITable inputTable, boolean useSelectedInput, ITable overlayTable, boolean useSelectedOverlay, double tolerance, IFeatureClassName outputName)
          Intersects features.
 IFeatureClass merge(IArray tables, ITable fieldsTable, IFeatureClassName outputName)
          Merges features.
 void setCancelTrackerByRef(ITrackCancel rhs1)
          The cancel tracker.
 void setSpatialReference(ISpatialReference ppSpatialRef)
          The output spatial reference.
 IFeatureClass union(ITable inputTable, boolean useSelectedInput, ITable overlayTable, boolean useSelectedOverlay, double tolerance, IFeatureClassName outputName)
          Creates a union of features.
 

Method Detail

setCancelTrackerByRef

void setCancelTrackerByRef(ITrackCancel rhs1)
                           throws IOException,
                                  AutomationException
The cancel tracker.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException
The output spatial reference.

Remarks

IBasicGeoprocessor.SpatialReference should be set to an appropriate to high or low precision based on the target workspace. For more details see the SpatialReference documentation, particularly the ISpatialReferenceResolution interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReference

void setSpatialReference(ISpatialReference ppSpatialRef)
                         throws IOException,
                                AutomationException
The output spatial reference.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppSpatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

dissolve

ITable dissolve(ITable inputTable,
                boolean useSelected,
                String dissolveField,
                String summaryFields,
                IDatasetName outputName)
                throws IOException,
                       AutomationException
Dissolves features.

Description

Dissolve aggregates features of an input layer based on values of a specified attribute; and can be used to create either a new layer or a stand alone summary table.

Remarks

The useSelected state refers to whether or not a selected subset of the InputTable is to be dissolved. True signifies that a selected subset will be dissolved. False signifies that Dissolve will ignore any selected subset and will dissolve the entire set.

The summaryFields argument is a comma-delimited string that lists the generated summary fields. The syntax for the summaryFields argument is <operation_code1>.<field_name1>, <operation_codeN>.<field_nameN>. Operation codes include: Dissolve, Count, Minimum, Maximum, Sum, Average, Variance and StdDev.

To perform a spatial dissolve (i.e. output features instead of a summary table) the Dissolve operation code must be used in conjunction with the shape field at the beginning of the summaryFields string. Example: "Dissolve.Shape, Sum.Area, StdDev.Area, etc..." To create a stand alone summary table simply remove "Dissolve.Shape".

To include the dissolved field in the output, you must add it to the summary fields. For example, if you were disolving on a field called name, set the summary fields to: "Minimum.Name, Sum.Area, etc..." to include the name field in the output.


Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
inputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
useSelected - The useSelected (in)
dissolveField - The dissolveField (in)
summaryFields - The summaryFields (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

merge

IFeatureClass merge(IArray tables,
                    ITable fieldsTable,
                    IFeatureClassName outputName)
                    throws IOException,
                           AutomationException
Merges features.

Description

Merge combines layers of the same geometry type into a single feature class.

Remarks

The fieldsTable object refers to the specified input table that defines the fields to be used in the output.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
tables - A reference to a com.esri.arcgis.system.IArray (in)
fieldsTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clip

IFeatureClass clip(ITable inputTable,
                   boolean useSelectedInput,
                   ITable clipTable,
                   boolean useSelectedClip,
                   double tolerance,
                   IFeatureClassName outputName)
                   throws IOException,
                          AutomationException
Clips features.

Description

Clip extracts features of a point, line, or polygon layer based on the spatial extent of an overlay polygon layer. The attributes of the input feature class are carried over to the output feature class.

Remarks

The inputTable is the data to be clipped.

The clipTable parameter is the data that will be used to perform the clip.

The useSelectedInput state refers to whether or not a selected subset of the InputTable is to be clipped. True signifies that a selected subset will be clipped. False signifies that clip operation will ignore any selected subset.

The useSelectedClip state refers to whether or not a selected subset of the clipTable is to be used in the clip operation. True signifies that the selected subset will serve as the clip layer. False signifies that the clip operation will ignore any selected subset.

Passing 0.0 causes the default tolerance to be used. The default tolerance is 1/10,000 of the extent of the data frame's spatial domain.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
inputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
useSelectedInput - The useSelectedInput (in)
clipTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
useSelectedClip - The useSelectedClip (in)
tolerance - The tolerance (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

intersect

IFeatureClass intersect(ITable inputTable,
                        boolean useSelectedInput,
                        ITable overlayTable,
                        boolean useSelectedOverlay,
                        double tolerance,
                        IFeatureClassName outputName)
                        throws IOException,
                               AutomationException
Intersects features.

Description

Intersect clips the features of a line or polygon layer with features of an overlay polygon layer. The output feature class will have the attributes of both input and overlay layers.

Remarks

The useSelectedInput state refers to whether or not a selected subset of the InputTable is to be intersected. True signifies that a selected subset will be intersected. False signifies that intersect operation will ignore any selected subset.

The useSelectedOverlay state refers to whether or not a selected subset of the overlayTable is to be used in the intersect operation. True signifies that the selected subset will serve as the overlay layer. False signifies that the intersect operation will ignore any selected subset.

Passing 0.0 causes the default tolerance to be used. The default tolerance is 1/10,000 of the extent of the data frame's spatial domain.

ClusterTolerance is the tolerance value that has to be set to derive how accurate you want the results to be. For example, if the data is accurate to about 1 Millimeter then setting a tolerance value of 1 Centimeter will snap the features within this tolerance level. If the tolerance value is set to 0.5 Millimeter then these features are ignored. Minimum value of Tolerance is twice the Resolution (Resolution * 2).

If the tolerance value is very high then an error message is given and the data is not processed.

Tolerance value can be set according to how accurate you want the results to be.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
inputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
useSelectedInput - The useSelectedInput (in)
overlayTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
useSelectedOverlay - The useSelectedOverlay (in)
tolerance - The tolerance (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

union

IFeatureClass union(ITable inputTable,
                    boolean useSelectedInput,
                    ITable overlayTable,
                    boolean useSelectedOverlay,
                    double tolerance,
                    IFeatureClassName outputName)
                    throws IOException,
                           AutomationException
Creates a union of features.

Description

Union combines the features of two polygon layers into a new feature class that contains the attributes and the full spatial extent of both layers.

Remarks

The useSelectedInput state refers to whether or not a selected subset of the InputTable is to be combined with the overlay. True signifies that a selected subset will be used. False signifies that union operation will ignore any selected subset.

The useSelectedOverlay state refers to whether or not a selected subset of the overlayTable is to be used. True signifies that the selected subset will serve as the overlay layer. False signifies that the union operation will ignore any selected subset.

Passing 0.0 causes the default tolerance to be used. The default tolerance is 1/10,000 of the extent of the data frame's spatial domain.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
inputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
useSelectedInput - The useSelectedInput (in)
overlayTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
useSelectedOverlay - The useSelectedOverlay (in)
tolerance - The tolerance (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.