com.esri.arcgis.geoprocessing
Class GpDispatch

java.lang.Object
  com.esri.arcgis.geoprocessing.GpDispatch

All Implemented Interfaces:

IGPComHelper, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GpDispatch
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPComHelper

COM Class 'GpDispatch'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'Utility object used to execute geoprocessing tools.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPComHelper

IID, IID1e54e6b6_c2b0_470f_b030_d81d9464f3b3, xxDummy

Constructor Summary

GpDispatch()
Constructs a GpDispatch using ArcGIS Engine.

GpDispatch(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpDispatch theGpDispatch = (GpDispatch) obj;

Method Summary

void	addToolbox(java.lang.String toolbox) Adds a reference to the specified toolbox to the GeoProcessor.
boolean	equals(java.lang.Object o) Compare this object with another
IGPMessages	execute(java.lang.String toolName, IPropertySet params, ITrackCancel trackCancel) Executes the specified tool.
static java.lang.String	getClsid() getClsid.
IGPEnvironmentManager	getEnvironmentManager() The environment manager object associated with the helper.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getParameterName(java.lang.String toolName, int index) Get the parameter name for a given tool and index.
int	hashCode() the hashcode for this object
void	release() Release a GpDispatch.
void	removeToolbox(java.lang.String toolbox) Removes the reference to the specified toolbox from the GeoProcessor.

Methods inherited from class java.lang.Object

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

Constructor Detail

GpDispatch

public GpDispatch()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a GpDispatch using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GpDispatch

public GpDispatch(java.lang.Object obj)
           throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GpDispatch.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

execute

public IGPMessages execute(java.lang.String toolName,
                           IPropertySet params,
                           ITrackCancel trackCancel)
                    throws java.io.IOException,
                           AutomationException

Executes the specified tool.

Specified by:

execute in interface IGPComHelper

Parameters:

toolName - The toolName (in)

params - A reference to a com.esri.arcgis.system.IPropertySet (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessages

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterName

public java.lang.String getParameterName(java.lang.String toolName,
                                         int index)
                                  throws java.io.IOException,
                                         AutomationException

Get the parameter name for a given tool and index.

Specified by:

getParameterName in interface IGPComHelper

Parameters:

toolName - The toolName (in)

index - The index (in)

Returns:

The paramName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addToolbox

public void addToolbox(java.lang.String toolbox)
                throws java.io.IOException,
                       AutomationException

Adds a reference to the specified toolbox to the GeoProcessor.

Specified by:

addToolbox in interface IGPComHelper

Parameters:

toolbox - The toolbox (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeToolbox

public void removeToolbox(java.lang.String toolbox)
                   throws java.io.IOException,
                          AutomationException

Removes the reference to the specified toolbox from the GeoProcessor.

Specified by:

removeToolbox in interface IGPComHelper

Parameters:

toolbox - The toolbox (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvironmentManager

public IGPEnvironmentManager getEnvironmentManager()
                                            throws java.io.IOException,
                                                   AutomationException

The environment manager object associated with the helper.

Specified by:

getEnvironmentManager in interface IGPComHelper

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.