com.esri.arcgis.geoprocessing
Class IGeoProcessorProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geoprocessing.IGeoProcessorProxy

All Implemented Interfaces:

IGeoProcessor, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for COM Interface 'IGeoProcessor'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'The Geoprocessor. Provides access to toolboxes and 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 =

public class IGeoProcessorProxy
extends com.esri.arcgis.interop.Dispatch
implements IGeoProcessor, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

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

IID, IIDefdde95c_61fc_419d_be35_e5f18c7df160

Constructor Summary

	IGeoProcessorProxy() Deprecated. For internal use only
	IGeoProcessorProxy(java.lang.Object obj) Deprecated.
protected	IGeoProcessorProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IGeoProcessorProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IGeoProcessorProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

void	addError(java.lang.String message) Deprecated. Output an error message.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
void	addMessage(java.lang.String message) Deprecated. Output an informative message.
void	addReturnMessage(int index) Deprecated. Output message from the last tool executed.
void	addToolbox(java.lang.String toolbox) Deprecated. Add a toolbox to the current Geoprocessing session by catalog path.
void	addWarning(java.lang.String message) Deprecated. Output a warning message.
void	clearMessages() Deprecated. Clear the messages to be returned as tool message when running within a script tool.
IGeoProcessorResult	createResult(java.lang.String toolName, java.lang.String jobID) Deprecated. Create a new result object.
IGeoProcessorResult	execute(java.lang.String name, IVariantArray ipValues, ITrackCancel pTrackCancel) Deprecated. Execute a tool within the current Geoprocessing session.
boolean	exists(java.lang.Object inputValue, java.lang.Object pDataType) Deprecated. Test the existence of a given parameter value (GPValue or catalog path) the type of the data is optional.
IDataElement	getDataElement(java.lang.Object inputValue, java.lang.Object pDataType) Deprecated. Make a dataelement from the given value.
java.lang.Object	getEnvironmentValue(java.lang.String environmentName) Deprecated. Retrieve the value of an environment by name.
int	getMaxSeverity() Deprecated. Return the maximum severity of the message of the last tool executed.
java.lang.String	getMessage(int index) Deprecated. Return the message description by index of the last tool executed.
int	getMessageCount() Deprecated. Return the number of messages of the last tool executed.
java.lang.String	getMessages(java.lang.Object pSeverity) Deprecated. Return all of the message descriptions of the last tool executed.
int	getParameterCount() Deprecated. Return the number of input command line or script tool parameters.
java.lang.Object	getParameterValue(int index) Deprecated. Return the input command line or script tool parameter by index as a GPValue.
int	getReturnCode(int index) Deprecated. Return the message error code (Error Messages Only) by index of the last tool executed.
IGPMessages	getReturnMessages() Deprecated. Return the GPMessages object which will be messages of the last tool executed.
int	getSeverity(int index) Deprecated. Return the message severity by index of the last tool executed.
boolean	isAddOutputsToMap() Deprecated. Set whether resulting output datasets should be added to the application display.
boolean	isLogHistory() Deprecated. Set whether or not to log the execution of geoprocessing tools.
boolean	isOverwriteOutput() Deprecated. Set the overwrite outputs flag within the current Geoprocessing session.
boolean	isSynchronous(java.lang.String toolName) Deprecated. Is server tool synchronous.
boolean	isTemporaryMapLayers() Deprecated. Set whether new map layers are temporary by default.
IGpEnumList	listDatasets(java.lang.String wildCard, java.lang.String datasetType) Deprecated. Return the list of feature datasets within the current workspace.
IGpEnumList	listEnvironments(java.lang.String wildCard) Deprecated. Return the list of environments (properties) within the current Geoprocessing session.
IGpEnumList	listFeatureClasses(java.lang.String wildCard, java.lang.String featureType, java.lang.String dataset) Deprecated. Return the list of feature classes within the current workspace or feature dataset within the workspace.
IGpEnumList	listRasters(java.lang.String wildCard, java.lang.String rasterType) Deprecated. Return the list of rasters within the current workspace.
IGpEnumList	listTables(java.lang.String wildCard, java.lang.String tableType) Deprecated. Return the list of tables within the current workspace.
IGpEnumList	listToolboxes(java.lang.String wildCard) Deprecated. Return the list of toolboxes within the current Geoprocessing session.
IGpEnumList	listTools(java.lang.String wildCard) Deprecated. Return the list of tools within the current Geoprocessing session.
IGpEnumList	listWorkspaces(java.lang.String wildCard, java.lang.String workspaceType) Deprecated. Return the list of workspaces within the current workspace (the workspace can be a folder).
void	loadSettings(java.lang.String fileName) Deprecated. Load the current settings (toolboxes, environment values, etc) from a file on disk in XML format.
java.lang.Object	open(java.lang.Object value) Deprecated. Open an objector a namestring.
java.lang.String	parseFieldName(java.lang.String inputFieldName, java.lang.String workspace) Deprecated. Parse a field name within the given workspace.
java.lang.String	parseTableName(java.lang.String inputTableName, java.lang.String workspace) Deprecated. Parse a table name within the given workspace.
java.lang.String	qualifyFieldName(java.lang.String inputFieldName, java.lang.String workspace) Deprecated. Qualify a field name within the given workspace.
java.lang.String	qualifyTableName(java.lang.String inputTableName, java.lang.String workspace) Deprecated. Qualify a table name within the given workspace.
void	registerGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents) Deprecated. Register an object to recieve IGeoProcessorEvents.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	removeToolbox(java.lang.String toolbox) Deprecated. Remove a toolbox from the current Geoprocessing session by catalog path.
void	resetEnvironments() Deprecated. Reset the environments to their initial state.
void	saveSettings(java.lang.String fileName) Deprecated. Save the current settings (toolboxes, environment values, etc) to a file on disk in XML format.
void	setAddOutputsToMap(boolean addToMap) Deprecated. Set whether resulting output datasets should be added to the application display.
void	setEnvironmentValue(java.lang.String environmentName, java.lang.Object value) Deprecated. Update the value of an environment by name.
void	setLogHistory(boolean logHistory) Deprecated. Set whether or not to log the execution of geoprocessing tools.
void	setOverwriteOutput(boolean pOverrideOutput) Deprecated. Set the overwrite outputs flag within the current Geoprocessing session.
void	setParameterValue(int index, java.lang.Object value) Deprecated. Set the output script tool parameter by index as a GPValue.
void	setTemporaryMapLayers(boolean temporaryMapLayers) Deprecated. Set whether new map layers are temporary by default.
java.lang.String	testSchemaLock(java.lang.String fileName) Deprecated. Test for the presence of a schema lock (already open for writing) of a given file or dataset.
void	unRegisterGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents) Deprecated. UnRegister an object to stop recieving IGeoProcessorEvents.
java.lang.String	usage(java.lang.String method) Deprecated. Returns the command line usage of a given tool by name.
IGPMessages	validate(java.lang.String name, IVariantArray ipValues, boolean bUpdateValues) Deprecated. Validate the parameters (input) of a tool within the current Geoprocessing session.
java.lang.String	validateFieldName(java.lang.String inputFieldName, java.lang.String workspace) Deprecated. Validate a field name within the given workspace.
java.lang.String	validateTableName(java.lang.String inputTableName, java.lang.String workspace) Deprecated. Validate a table or feature class name within the given workspace.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IGeoProcessorProxy

public IGeoProcessorProxy(java.lang.String CLSID,
                          java.lang.String host,
                          com.esri.arcgis.interop.AuthInfo authInfo)
                   throws java.net.UnknownHostException,
                          java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

IGeoProcessorProxy

public IGeoProcessorProxy()

Deprecated.

For internal use only

IGeoProcessorProxy

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

Deprecated.

Throws:

java.io.IOException

IGeoProcessorProxy

protected IGeoProcessorProxy(java.lang.Object obj,
                             java.lang.String iid)
                      throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IGeoProcessorProxy

protected IGeoProcessorProxy(java.lang.String CLSID,
                             java.lang.String iid,
                             java.lang.String host,
                             com.esri.arcgis.interop.AuthInfo authInfo)
                      throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Deprecated.

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getEnvironmentValue

public java.lang.Object getEnvironmentValue(java.lang.String environmentName)
                                     throws java.io.IOException,
                                            AutomationException

Deprecated.

Retrieve the value of an environment by name. The properties of the current Geoprocessing session.

Specified by:

getEnvironmentValue in interface IGeoProcessor

Parameters:

environmentName - The environmentName (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnvironmentValue

public void setEnvironmentValue(java.lang.String environmentName,
                                java.lang.Object value)
                         throws java.io.IOException,
                                AutomationException

Deprecated.

Update the value of an environment by name. The properties of the current Geoprocessing session.

Specified by:

setEnvironmentValue in interface IGeoProcessor

Parameters:

environmentName - The environmentName (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetEnvironments

public void resetEnvironments()
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Reset the environments to their initial state.

Specified by:

resetEnvironments in interface IGeoProcessor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

execute

public IGeoProcessorResult execute(java.lang.String name,
                                   IVariantArray ipValues,
                                   ITrackCancel pTrackCancel)
                            throws java.io.IOException,
                                   AutomationException

Deprecated.

Execute a tool within the current Geoprocessing session.

Specified by:

execute in interface IGeoProcessor

Parameters:

name - The name (in)

ipValues - A reference to a com.esri.arcgis.system.IVariantArray (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validate

public IGPMessages validate(java.lang.String name,
                            IVariantArray ipValues,
                            boolean bUpdateValues)
                     throws java.io.IOException,
                            AutomationException

Deprecated.

Validate the parameters (input) of a tool within the current Geoprocessing session.

Specified by:

validate in interface IGeoProcessor

Parameters:

name - The name (in)

ipValues - A reference to a com.esri.arcgis.system.IVariantArray (in)

bUpdateValues - The bUpdateValues (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.

open

public java.lang.Object open(java.lang.Object value)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

Open an objector a namestring. Example a DEFeatureClass object will return an IFeatureClass.

Specified by:

open in interface IGeoProcessor

Parameters:

value - A Variant (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataElement

public IDataElement getDataElement(java.lang.Object inputValue,
                                   java.lang.Object pDataType)
                            throws java.io.IOException,
                                   AutomationException

Deprecated.

Make a dataelement from the given value.

Specified by:

getDataElement in interface IGeoProcessor

Parameters:

inputValue - A Variant (in)

pDataType - A Variant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listTools

public IGpEnumList listTools(java.lang.String wildCard)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

Return the list of tools within the current Geoprocessing session.

Specified by:

listTools in interface IGeoProcessor

Parameters:

wildCard - The wildCard (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listEnvironments

public IGpEnumList listEnvironments(java.lang.String wildCard)
                             throws java.io.IOException,
                                    AutomationException

Deprecated.

Return the list of environments (properties) within the current Geoprocessing session.

Specified by:

listEnvironments in interface IGeoProcessor

Parameters:

wildCard - The wildCard (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listToolboxes

public IGpEnumList listToolboxes(java.lang.String wildCard)
                          throws java.io.IOException,
                                 AutomationException

Deprecated.

Return the list of toolboxes within the current Geoprocessing session.

Specified by:

listToolboxes in interface IGeoProcessor

Parameters:

wildCard - The wildCard (in)

Returns:

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

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

Deprecated.

Add a toolbox to the current Geoprocessing session by catalog path.

Specified by:

addToolbox in interface IGeoProcessor

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

Deprecated.

Remove a toolbox from the current Geoprocessing session by catalog path.

Specified by:

removeToolbox in interface IGeoProcessor

Parameters:

toolbox - The toolbox (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAddOutputsToMap

public void setAddOutputsToMap(boolean addToMap)
                        throws java.io.IOException,
                               AutomationException

Deprecated.

Set whether resulting output datasets should be added to the application display.

Specified by:

setAddOutputsToMap in interface IGeoProcessor

Parameters:

addToMap - The addToMap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAddOutputsToMap

public boolean isAddOutputsToMap()
                          throws java.io.IOException,
                                 AutomationException

Deprecated.

Set whether resulting output datasets should be added to the application display.

Specified by:

isAddOutputsToMap in interface IGeoProcessor

Returns:

The addToMap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverwriteOutput

public void setOverwriteOutput(boolean pOverrideOutput)
                        throws java.io.IOException,
                               AutomationException

Deprecated.

Set the overwrite outputs flag within the current Geoprocessing session. True means outputs of tools will be overwritten.

Specified by:

setOverwriteOutput in interface IGeoProcessor

Parameters:

pOverrideOutput - The pOverrideOutput (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOverwriteOutput

public boolean isOverwriteOutput()
                          throws java.io.IOException,
                                 AutomationException

Deprecated.

Set the overwrite outputs flag within the current Geoprocessing session. True means outputs of tools will be overwritten.

Specified by:

isOverwriteOutput in interface IGeoProcessor

Returns:

The pOverrideOutput

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporaryMapLayers

public void setTemporaryMapLayers(boolean temporaryMapLayers)
                           throws java.io.IOException,
                                  AutomationException

Deprecated.

Set whether new map layers are temporary by default.

Specified by:

setTemporaryMapLayers in interface IGeoProcessor

Parameters:

temporaryMapLayers - The temporaryMapLayers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTemporaryMapLayers

public boolean isTemporaryMapLayers()
                             throws java.io.IOException,
                                    AutomationException

Deprecated.

Set whether new map layers are temporary by default.

Specified by:

isTemporaryMapLayers in interface IGeoProcessor

Returns:

The temporaryMapLayers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLogHistory

public void setLogHistory(boolean logHistory)
                   throws java.io.IOException,
                          AutomationException

Deprecated.

Set whether or not to log the execution of geoprocessing tools.

Specified by:

setLogHistory in interface IGeoProcessor

Parameters:

logHistory - The logHistory (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLogHistory

public boolean isLogHistory()
                     throws java.io.IOException,
                            AutomationException

Deprecated.

Set whether or not to log the execution of geoprocessing tools.

Specified by:

isLogHistory in interface IGeoProcessor

Returns:

The logHistory

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReturnMessages

public IGPMessages getReturnMessages()
                              throws java.io.IOException,
                                     AutomationException

Deprecated.

Return the GPMessages object which will be messages of the last tool executed.

Specified by:

getReturnMessages in interface IGeoProcessor

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.

getMessageCount

public int getMessageCount()
                    throws java.io.IOException,
                           AutomationException

Deprecated.

Return the number of messages of the last tool executed.

Specified by:

getMessageCount in interface IGeoProcessor

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

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

Deprecated.

Return the message description by index of the last tool executed.

Specified by:

getMessage in interface IGeoProcessor

Parameters:

index - The index (in)

Returns:

The pMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSeverity

public int getSeverity(int index)
                throws java.io.IOException,
                       AutomationException

Deprecated.

Return the message severity by index of the last tool executed.

Specified by:

getSeverity in interface IGeoProcessor

Parameters:

index - The index (in)

Returns:

The pSeverity

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReturnCode

public int getReturnCode(int index)
                  throws java.io.IOException,
                         AutomationException

Deprecated.

Return the message error code (Error Messages Only) by index of the last tool executed.

Specified by:

getReturnCode in interface IGeoProcessor

Parameters:

index - The index (in)

Returns:

The pCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessages

public java.lang.String getMessages(java.lang.Object pSeverity)
                             throws java.io.IOException,
                                    AutomationException

Deprecated.

Return all of the message descriptions of the last tool executed.

Specified by:

getMessages in interface IGeoProcessor

Parameters:

pSeverity - A Variant (in)

Returns:

The pMessages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxSeverity

public int getMaxSeverity()
                   throws java.io.IOException,
                          AutomationException

Deprecated.

Return the maximum severity of the message of the last tool executed.

Specified by:

getMaxSeverity in interface IGeoProcessor

Returns:

The pSeverity

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMessage

public void addMessage(java.lang.String message)
                throws java.io.IOException,
                       AutomationException

Deprecated.

Output an informative message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console

Specified by:

addMessage in interface IGeoProcessor

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addError

public void addError(java.lang.String message)
              throws java.io.IOException,
                     AutomationException

Deprecated.

Output an error message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console

Specified by:

addError in interface IGeoProcessor

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addWarning

public void addWarning(java.lang.String message)
                throws java.io.IOException,
                       AutomationException

Deprecated.

Output a warning message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console

Specified by:

addWarning in interface IGeoProcessor

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addReturnMessage

public void addReturnMessage(int index)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

Output message from the last tool executed. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console

Specified by:

addReturnMessage in interface IGeoProcessor

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearMessages

public void clearMessages()
                   throws java.io.IOException,
                          AutomationException

Deprecated.

Clear the messages to be returned as tool message when running within a script tool.

Specified by:

clearMessages in interface IGeoProcessor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterCount

public int getParameterCount()
                      throws java.io.IOException,
                             AutomationException

Deprecated.

Return the number of input command line or script tool parameters.

Specified by:

getParameterCount in interface IGeoProcessor

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterValue

public java.lang.Object getParameterValue(int index)
                                   throws java.io.IOException,
                                          AutomationException

Deprecated.

Return the input command line or script tool parameter by index as a GPValue.

Specified by:

getParameterValue in interface IGeoProcessor

Parameters:

index - The index (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParameterValue

public void setParameterValue(int index,
                              java.lang.Object value)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Set the output script tool parameter by index as a GPValue.

Specified by:

setParameterValue in interface IGeoProcessor

Parameters:

index - The index (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exists

public boolean exists(java.lang.Object inputValue,
                      java.lang.Object pDataType)
               throws java.io.IOException,
                      AutomationException

Deprecated.

Test the existence of a given parameter value (GPValue or catalog path) the type of the data is optional.

Specified by:

exists in interface IGeoProcessor

Parameters:

inputValue - A Variant (in)

pDataType - A Variant (in)

Returns:

The exists

Throws:

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

AutomationException - If the ArcObject component throws an exception.

usage

public java.lang.String usage(java.lang.String method)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Returns the command line usage of a given tool by name.

Specified by:

usage in interface IGeoProcessor

Parameters:

method - The method (in)

Returns:

The usage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listFeatureClasses

public IGpEnumList listFeatureClasses(java.lang.String wildCard,
                                      java.lang.String featureType,
                                      java.lang.String dataset)
                               throws java.io.IOException,
                                      AutomationException

Deprecated.

Return the list of feature classes within the current workspace or feature dataset within the workspace.

Specified by:

listFeatureClasses in interface IGeoProcessor

Parameters:

wildCard - The wildCard (in)

featureType - The featureType (in)

dataset - The dataset (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listDatasets

public IGpEnumList listDatasets(java.lang.String wildCard,
                                java.lang.String datasetType)
                         throws java.io.IOException,
                                AutomationException

Deprecated.

Return the list of feature datasets within the current workspace.

Specified by:

listDatasets in interface IGeoProcessor

Parameters:

wildCard - The wildCard (in)

datasetType - The datasetType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listWorkspaces

public IGpEnumList listWorkspaces(java.lang.String wildCard,
                                  java.lang.String workspaceType)
                           throws java.io.IOException,
                                  AutomationException

Deprecated.

Return the list of workspaces within the current workspace (the workspace can be a folder).

Specified by:

listWorkspaces in interface IGeoProcessor

Parameters:

wildCard - The wildCard (in)

workspaceType - The workspaceType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listTables

public IGpEnumList listTables(java.lang.String wildCard,
                              java.lang.String tableType)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Return the list of tables within the current workspace.

Specified by:

listTables in interface IGeoProcessor

Parameters:

wildCard - The wildCard (in)

tableType - The tableType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listRasters

public IGpEnumList listRasters(java.lang.String wildCard,
                               java.lang.String rasterType)
                        throws java.io.IOException,
                               AutomationException

Deprecated.

Return the list of rasters within the current workspace.

Specified by:

listRasters in interface IGeoProcessor

Parameters:

wildCard - The wildCard (in)

rasterType - The rasterType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateFieldName

public java.lang.String validateFieldName(java.lang.String inputFieldName,
                                          java.lang.String workspace)
                                   throws java.io.IOException,
                                          AutomationException

Deprecated.

Validate a field name within the given workspace.

Specified by:

validateFieldName in interface IGeoProcessor

Parameters:

inputFieldName - The inputFieldName (in)

workspace - The workspace (in)

Returns:

The outputFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateTableName

public java.lang.String validateTableName(java.lang.String inputTableName,
                                          java.lang.String workspace)
                                   throws java.io.IOException,
                                          AutomationException

Deprecated.

Validate a table or feature class name within the given workspace.

Specified by:

validateTableName in interface IGeoProcessor

Parameters:

inputTableName - The inputTableName (in)

workspace - The workspace (in)

Returns:

The outputTableName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

qualifyFieldName

public java.lang.String qualifyFieldName(java.lang.String inputFieldName,
                                         java.lang.String workspace)
                                  throws java.io.IOException,
                                         AutomationException

Deprecated.

Qualify a field name within the given workspace. This will add the connected user and database names.

Specified by:

qualifyFieldName in interface IGeoProcessor

Parameters:

inputFieldName - The inputFieldName (in)

workspace - The workspace (in)

Returns:

The outputFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

qualifyTableName

public java.lang.String qualifyTableName(java.lang.String inputTableName,
                                         java.lang.String workspace)
                                  throws java.io.IOException,
                                         AutomationException

Deprecated.

Qualify a table name within the given workspace. This will add the connected user and database names.

Specified by:

qualifyTableName in interface IGeoProcessor

Parameters:

inputTableName - The inputTableName (in)

workspace - The workspace (in)

Returns:

The outputTableName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

parseFieldName

public java.lang.String parseFieldName(java.lang.String inputFieldName,
                                       java.lang.String workspace)
                                throws java.io.IOException,
                                       AutomationException

Deprecated.

Parse a field name within the given workspace. This will strip the connected user and database names.

Specified by:

parseFieldName in interface IGeoProcessor

Parameters:

inputFieldName - The inputFieldName (in)

workspace - The workspace (in)

Returns:

The outputParsedName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

parseTableName

public java.lang.String parseTableName(java.lang.String inputTableName,
                                       java.lang.String workspace)
                                throws java.io.IOException,
                                       AutomationException

Deprecated.

Parse a table name within the given workspace. This will strip the connected user and database names.

Specified by:

parseTableName in interface IGeoProcessor

Parameters:

inputTableName - The inputTableName (in)

workspace - The workspace (in)

Returns:

The outputParsedName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveSettings

public void saveSettings(java.lang.String fileName)
                  throws java.io.IOException,
                         AutomationException

Deprecated.

Save the current settings (toolboxes, environment values, etc) to a file on disk in XML format.

Specified by:

saveSettings in interface IGeoProcessor

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadSettings

public void loadSettings(java.lang.String fileName)
                  throws java.io.IOException,
                         AutomationException

Deprecated.

Load the current settings (toolboxes, environment values, etc) from a file on disk in XML format.

Specified by:

loadSettings in interface IGeoProcessor

Parameters:

fileName - The fileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

testSchemaLock

public java.lang.String testSchemaLock(java.lang.String fileName)
                                throws java.io.IOException,
                                       AutomationException

Deprecated.

Test for the presence of a schema lock (already open for writing) of a given file or dataset.

Specified by:

testSchemaLock in interface IGeoProcessor

Parameters:

fileName - The fileName (in)

Returns:

The pStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

registerGeoProcessorEvents

public void registerGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents)
                                throws java.io.IOException,
                                       AutomationException

Deprecated.

Register an object to recieve IGeoProcessorEvents.

Specified by:

registerGeoProcessorEvents in interface IGeoProcessor

Parameters:

pGeoProcessorEvents - A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorEvents (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unRegisterGeoProcessorEvents

public void unRegisterGeoProcessorEvents(IGeoProcessorEvents pGeoProcessorEvents)
                                  throws java.io.IOException,
                                         AutomationException

Deprecated.

UnRegister an object to stop recieving IGeoProcessorEvents.

Specified by:

unRegisterGeoProcessorEvents in interface IGeoProcessor

Parameters:

pGeoProcessorEvents - A reference to a com.esri.arcgis.geoprocessing.IGeoProcessorEvents (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createResult

public IGeoProcessorResult createResult(java.lang.String toolName,
                                        java.lang.String jobID)
                                 throws java.io.IOException,
                                        AutomationException

Deprecated.

Create a new result object.

Specified by:

createResult in interface IGeoProcessor

Parameters:

toolName - The toolName (in)

jobID - The jobID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSynchronous

public boolean isSynchronous(java.lang.String toolName)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

Is server tool synchronous.

Specified by:

isSynchronous in interface IGeoProcessor

Parameters:

toolName - The toolName (in)

Returns:

The isSynchronous

Throws:

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

AutomationException - If the ArcObject component throws an exception.