com.esri.arcgis.carto
Class BasicGeoprocessor

java.lang.Object
  com.esri.arcgis.carto.BasicGeoprocessor

All Implemented Interfaces:

IBasicGeoprocessor, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class BasicGeoprocessor
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IBasicGeoprocessor

A basic geoprocessor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

BasicGeoprocessor()
Constructs a BasicGeoprocessor using ArcGIS Engine.

BasicGeoprocessor(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BasicGeoprocessor theBasicGeoprocessor = (BasicGeoprocessor) obj;

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.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
ISpatialReference	getSpatialReference() The output spatial reference.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

BasicGeoprocessor

public BasicGeoprocessor()
                  throws IOException,
                         UnknownHostException

Constructs a BasicGeoprocessor using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

BasicGeoprocessor

public BasicGeoprocessor(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BasicGeoprocessor theBasicGeoprocessor = (BasicGeoprocessor) obj;

Construct a BasicGeoprocessor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to BasicGeoprocessor.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setCancelTrackerByRef

public 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

Specified by:

setCancelTrackerByRef in interface IBasicGeoprocessor

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

public 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

Specified by:

getSpatialReference in interface IBasicGeoprocessor

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

public 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

Specified by:

setSpatialReference in interface IBasicGeoprocessor

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

public 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

Specified by:

dissolve in interface IBasicGeoprocessor

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

public 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

Specified by:

merge in interface IBasicGeoprocessor

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

public 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

Specified by:

clip in interface IBasicGeoprocessor

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

public 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

Specified by:

intersect in interface IBasicGeoprocessor

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

public 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

Specified by:

union in interface IBasicGeoprocessor

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.