com.esri.arcgis.geoprocessing
Interface IGPUtilities2

All Superinterfaces:

IGPUtilities, java.io.Serializable

All Known Subinterfaces:

IGPUtilities3, IGPUtilities4

All Known Implementing Classes:

GPUtilities, IGPUtilities2Proxy, IGPUtilities3Proxy, IGPUtilities4Proxy

public interface IGPUtilities2
extends IGPUtilities, java.io.Serializable

COM Interface 'IGPUtilities2'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to the properties/methods of a geoprocessing utilities object.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDd57e3b9b_5481_4f28_9f31_f0b8756b53b9
static int	xxDummy Deprecated. Internal use only

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

IID32f06b8f_a395_4f4e_b24f_52bbef06a036

Method Summary

void	abortEditOperation(IWorkspaceEdit pWorkspace) Abort edit operation within the application.
void	addToMapEx(IGPValue pGPValue, java.lang.String name, boolean temporary, java.lang.Object pUnkRenderer, boolean visible) Adds the given geoprocessing value object to the application display.
void	cleanupEditSession(boolean abort) Cleans up any edit session.
void	clearInMemoryWorkspace() Clear the virtual workspace.
void	createToolboxFromFactory(java.lang.String alias, java.lang.String location, java.lang.String toolboxName) Creates a toolbox at the given location for a function factory of a given alias.
void	generateGeographicTransformDomain(java.lang.Object iUnk, IGPCodedValueDomain pGTDomain, ISpatialReference pInSR, ISpatialReference pOutSR, IGPMessages pMessages) Generate the matching geographic transform domain from an input spatial reference to an output spatial reference.
IActiveView	getActiveView() Get active view.
IBasicMap	getBasicMap() Gets the basic map associated with the application.
IEnvelope	getExtent(IGPValue pValue, int[] envType) Gets the type and value of extent of the given value.
ISpatialReference	getGPSpRefEnvEx(IGPEnvironmentManager pEnvMgr, ISpatialReference pSrcSpRef, ISpatialReference pTgtSpRef, IEnvelope pNewExtent, double newMMin, double newMMax, double newZMin, double newZMax, java.lang.Object pWkspFDS) Creates the spatial reference from both a source and environment.
void	getGTOperationSet(IGPValue pGTs, ISpatialReference pInSR, ISpatialReference pOutSR, ICompositeGeoTransformation ppGTs) Gets the set of geographic transformations.
IWorkspace	getInMemoryWorkspace() Get the virtual workspace.
java.lang.String	getLayerName(IGPValue pValue, java.lang.String name) Get default layer name for given value.
IMap	getMap() Gets the map associated with the application.
IStatusBar	getStatusBar() Gets the status bar associated with the application.
IGPVariableManager	getVariableManager() Sets the Variable Manager.
boolean	inApplication() Indicates if the program is running in an ArcGIS applicaiton.
ILayer	makeLayer(IGPValue pValue, java.lang.String name, java.lang.Object pUnkRenderer) Creates appropriate layer for the value.
java.lang.Object	open(IGPValue pValue) Returns the dataset of the given value.
java.lang.Object	openFromString(java.lang.String nameString) Returns the dataset of the given value.
void	removeFromMapEx(IGPValue pGPValue) Removes the data/layers specified by the geoprocessing value object from the map.
void	removeInternalData() Removes all internal layers and tables.
void	saveLayer(java.lang.String catalogPath, ILayer pLayer) Saves a layer to a given location on disk.
void	setInternalMap(IMap pMap) Sets the internal map used by the geoprocessor.
void	setupEditSession(IClass pTable) Starts an edit session if needed.
void	setVariableManagerByRef(IGPVariableManager ppVariableManager) Sets the Variable Manager.
void	startEditOperation(IWorkspaceEdit pWorkspace, boolean bHasPrivateEditSession) Start edit operation within the application.
void	stopEditOperation(IWorkspaceEdit pWorkspace, java.lang.String operationLabel) Stop edit operation within the application.

Methods inherited from interface com.esri.arcgis.geoprocessing.IGPUtilities

addInternalLayer, addInternalLayer2, addInternalTable, addInternalTable2, addToMap, canAddToMap, compareWildCard, copy, createDataElement, createFeatureClassName, createFeatureLayer, createParameterValue, createParentFromCatalogPath, createRasterCatalogName, createRasterDatasetName, createTableName, decodeDETable, decodeFeatureLayer, decodeLayer, decodeRaster, decodeRasterLayer, decodeStandaloneTable, decodeTableView, delete, exists, expandDataElement, exportFeatureClass, fieldExists, findField, findMapLayer, findMapLayer2, findMapTable, findMapTable2, generateDefaultOutputValue, generateSpRef, getCatalog, getEnvironment, getFields, getGPLayers, getGPMapData, getGPSpRefEnv, getGPTableViews, getGxObject, getGxObjectFromLocation, getGxObjects, getMapLayers, getMapTables, getNameObject, getNameObjectFromLocation, getUnQualifiedCatalogPath, getWorkspace, internalValidate, internalValidateValue, isBadMessage, isDatasetType, isDerived, isGPTableView, isRefreshCatalogParent, makeDataElement, makeDataElementFromNameObject, makeDataElements, makeGPLayer, makeGPLayerFromLayer, makeGPTableView, makeGPTableViewFromTable, makeGPValueFromObject, openDataset, openDatasetFromLocation, openFeatureClassFromString, openFeatureLayerFromString, openRasterDatasetFromString, openRasterLayerFromString, openTableFromString, packGPValue, qualifyOutputCatalogPath, qualifyOutputDataElement, refreshCatalog, refreshView, releaseInternals, removeFromMap, removeInternalLayer, removeInternalLayerEx, removeInternalTable, removeInternalTableEx, removeInternalValues, rename, setGridIndex, setRefreshCatalogParent, setWorkspace, unpackGPValue, validateExists

Field Detail

IIDd57e3b9b_5481_4f28_9f31_f0b8756b53b9

static final int IIDd57e3b9b_5481_4f28_9f31_f0b8756b53b9

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

open

java.lang.Object open(IGPValue pValue)
                      throws java.io.IOException,
                             AutomationException

Returns the dataset of the given value.

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (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.

saveLayer

void saveLayer(java.lang.String catalogPath,
               ILayer pLayer)
               throws java.io.IOException,
                      AutomationException

Saves a layer to a given location on disk.

Parameters:

catalogPath - The catalogPath (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

Get active view.

Returns:

A reference to a com.esri.arcgis.carto.IActiveView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMap

IMap getMap()
            throws java.io.IOException,
                   AutomationException

Gets the map associated with the application.

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBasicMap

IBasicMap getBasicMap()
                      throws java.io.IOException,
                             AutomationException

Gets the basic map associated with the application.

Returns:

A reference to a com.esri.arcgis.carto.IBasicMap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

inApplication

boolean inApplication()
                      throws java.io.IOException,
                             AutomationException

Indicates if the program is running in an ArcGIS applicaiton.

Returns:

The pInApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

makeLayer

ILayer makeLayer(IGPValue pValue,
                 java.lang.String name,
                 java.lang.Object pUnkRenderer)
                 throws java.io.IOException,
                        AutomationException

Creates appropriate layer for the value.

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

name - The name (in)

pUnkRenderer - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatusBar

IStatusBar getStatusBar()
                        throws java.io.IOException,
                               AutomationException

Gets the status bar associated with the application.

Returns:

A reference to a com.esri.arcgis.system.IStatusBar

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startEditOperation

void startEditOperation(IWorkspaceEdit pWorkspace,
                        boolean bHasPrivateEditSession)
                        throws java.io.IOException,
                               AutomationException

Start edit operation within the application.

Parameters:

pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspaceEdit (in)

bHasPrivateEditSession - The bHasPrivateEditSession (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

abortEditOperation

void abortEditOperation(IWorkspaceEdit pWorkspace)
                        throws java.io.IOException,
                               AutomationException

Abort edit operation within the application.

Parameters:

pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspaceEdit (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopEditOperation

void stopEditOperation(IWorkspaceEdit pWorkspace,
                       java.lang.String operationLabel)
                       throws java.io.IOException,
                              AutomationException

Stop edit operation within the application.

Parameters:

pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspaceEdit (in)

operationLabel - The operationLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVariableManagerByRef

void setVariableManagerByRef(IGPVariableManager ppVariableManager)
                             throws java.io.IOException,
                                    AutomationException

Sets the Variable Manager.

Parameters:

ppVariableManager - A reference to a com.esri.arcgis.geoprocessing.IGPVariableManager (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVariableManager

IGPVariableManager getVariableManager()
                                      throws java.io.IOException,
                                             AutomationException

Sets the Variable Manager.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

generateGeographicTransformDomain

void generateGeographicTransformDomain(java.lang.Object iUnk,
                                       IGPCodedValueDomain pGTDomain,
                                       ISpatialReference pInSR,
                                       ISpatialReference pOutSR,
                                       IGPMessages pMessages)
                                       throws java.io.IOException,
                                              AutomationException

Generate the matching geographic transform domain from an input spatial reference to an output spatial reference.

Parameters:

iUnk - A reference to another Object (IUnknown) (in)

pGTDomain - A reference to a com.esri.arcgis.geodatabase.IGPCodedValueDomain (in)

pInSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

pOutSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

pMessages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGTOperationSet

void getGTOperationSet(IGPValue pGTs,
                       ISpatialReference pInSR,
                       ISpatialReference pOutSR,
                       ICompositeGeoTransformation ppGTs)
                       throws java.io.IOException,
                              AutomationException

Gets the set of geographic transformations.

Parameters:

pGTs - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

pInSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

pOutSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

ppGTs - A reference to a com.esri.arcgis.geometry.ICompositeGeoTransformation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent(IGPValue pValue,
                    int[] envType)
                    throws java.io.IOException,
                           AutomationException

Gets the type and value of extent of the given value.

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

envType - A com.esri.arcgis.geoprocessing.esriGPExtentEnum constant (out: use single element array)

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGPSpRefEnvEx

ISpatialReference getGPSpRefEnvEx(IGPEnvironmentManager pEnvMgr,
                                  ISpatialReference pSrcSpRef,
                                  ISpatialReference pTgtSpRef,
                                  IEnvelope pNewExtent,
                                  double newMMin,
                                  double newMMax,
                                  double newZMin,
                                  double newZMax,
                                  java.lang.Object pWkspFDS)
                                  throws java.io.IOException,
                                         AutomationException

Creates the spatial reference from both a source and environment.

Parameters:

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

pSrcSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

pTgtSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

pNewExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

newMMin - The newMMin (in)

newMMax - The newMMax (in)

newZMin - The newZMin (in)

newZMax - The newZMax (in)

pWkspFDS - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createToolboxFromFactory

void createToolboxFromFactory(java.lang.String alias,
                              java.lang.String location,
                              java.lang.String toolboxName)
                              throws java.io.IOException,
                                     AutomationException

Creates a toolbox at the given location for a function factory of a given alias.

Parameters:

alias - The alias (in)

location - The location (in)

toolboxName - The toolboxName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInternalMap

void setInternalMap(IMap pMap)
                    throws java.io.IOException,
                           AutomationException

Sets the internal map used by the geoprocessor.

Parameters:

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerName

java.lang.String getLayerName(IGPValue pValue,
                              java.lang.String name)
                              throws java.io.IOException,
                                     AutomationException

Get default layer name for given value.

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

name - The name (in)

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeInternalData

void removeInternalData()
                        throws java.io.IOException,
                               AutomationException

Removes all internal layers and tables.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInMemoryWorkspace

IWorkspace getInMemoryWorkspace()
                                throws java.io.IOException,
                                       AutomationException

Get the virtual workspace.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearInMemoryWorkspace

void clearInMemoryWorkspace()
                            throws java.io.IOException,
                                   AutomationException

Clear the virtual workspace.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openFromString

java.lang.Object openFromString(java.lang.String nameString)
                                throws java.io.IOException,
                                       AutomationException

Returns the dataset of the given value.

Parameters:

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

setupEditSession

void setupEditSession(IClass pTable)
                      throws java.io.IOException,
                             AutomationException

Starts an edit session if needed.

Parameters:

pTable - A reference to a com.esri.arcgis.geodatabase.IClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

cleanupEditSession

void cleanupEditSession(boolean abort)
                        throws java.io.IOException,
                               AutomationException

Cleans up any edit session.

Parameters:

abort - The abort (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeFromMapEx

void removeFromMapEx(IGPValue pGPValue)
                     throws java.io.IOException,
                            AutomationException

Removes the data/layers specified by the geoprocessing value object from the map.

Parameters:

pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addToMapEx

void addToMapEx(IGPValue pGPValue,
                java.lang.String name,
                boolean temporary,
                java.lang.Object pUnkRenderer,
                boolean visible)
                throws java.io.IOException,
                       AutomationException

Adds the given geoprocessing value object to the application display.

Parameters:

pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

name - The name (in)

temporary - The temporary (in)

pUnkRenderer - A reference to another Object (IUnknown) (in)

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.