com.esri.arcgis.geoprocessing
Interface IDEUtilities

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DEUtilities, IDEUtilitiesProxy

public interface IDEUtilities
extends java.io.Serializable

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

Description: 'Provides access to the Data Element Utilities.' 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	IID39fcba4f_fad5_4360_a91e_f6c995205676
static int	xxDummy Deprecated. Internal use only

Method Summary

void	assignTinProperties(ITin pTin, IDataElement pDataElement) Assign tin properties.
boolean	compareWildCard(java.lang.String wildCard, java.lang.String data) Compares a wildcard string against a given value.
void	copy(IGPValue pSourceGPValue, IGPValue pTargetGPValue) Copys the data element.
void	delete(IGPValue pGPValue) Deletes the data element.
boolean	exists(IGPValue pGPValue) Checks if a data element exists.
void	expandDataElement(IDataElement pInDE, IDEBrowseOptions pBrowseOptions) Expands a given data element.
java.lang.Object	getCatalog() Gets the catalog object.
java.lang.Object	getGxObject(IDataElement pDataTlement) Gets the GxObject for a data element.
java.lang.Object	getGxObjectFromLocation(java.lang.String catalogPath, IGPDataType pDataType) Gets the GxObject from a catalog path.
IArray	getGxObjects(java.lang.String catalogPath) Returns an array of GxObjects for a catalog path.
IName	getNameObject(IDataElement pDataElement) Gets the name object for data element.
IName	getNameObjectFromLocation(java.lang.String locationMoniker, IGPDataType pDataType) Gets the name object from a catalog path.
java.lang.String	getWorkspace() Sets the current workspace.
boolean	isEqualArray(IArray pObjects1, IArray pObjects2) Check if field arrays are equal.
boolean	isRefreshCatalogParent() Indicates whether to refresh catalog parent.
IDataElement	makeDataElement(java.lang.String catalogPath, IDEBrowseOptions pBrowseOptions, IGPDataType pDataType) Makes a data element from path.
IDataElement	makeDataElementFromNameObject(IName name) Makes a data element from name object.
IArray	makeDataElements(java.lang.String catalogPath, IDEBrowseOptions pBrowseOptions) Returns an array of data elements for a catalog path.
IDataset	openDataset(IDataElement pDataElement) Returns the dataset for the given data element.
IDataset	openDatasetFromLocation(java.lang.String catalogPath, IGPDataType pDataType) Returns the dataset by catalog path.
ILayer	openLayerFromLocation(java.lang.String catalogPath) Returns the layer based upon the given catalog path.
void	parseContainer(java.lang.String catalogPath, java.lang.String[] pContainer) Returns the container of a catalog path.
void	parseName(java.lang.String catalogPath, java.lang.String[] pName) Returns the name of a catalog path.
void	refreshCatalog(IDataElement pSourceDataElement) Refreshs catalog for the parent of the given data element.
void	releaseInternals() Release the internal objects used prior to releasing this DEUtilities object.
void	rename(IGPValue pSourceGPValue, IGPValue pTargetGPValue) Renames the data element.
void	setRefreshCatalogParent(boolean pRefresh) Indicates whether to refresh catalog parent.
void	setWorkspace(java.lang.String workPath) Sets the current workspace.

Field Detail

IID39fcba4f_fad5_4360_a91e_f6c995205676

static final int IID39fcba4f_fad5_4360_a91e_f6c995205676

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

assignTinProperties

void assignTinProperties(ITin pTin,
                         IDataElement pDataElement)
                         throws java.io.IOException,
                                AutomationException

Assign tin properties.

Parameters:

pTin - A reference to a com.esri.arcgis.geodatabase.ITin (in)

pDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqualArray

boolean isEqualArray(IArray pObjects1,
                     IArray pObjects2)
                     throws java.io.IOException,
                            AutomationException

Check if field arrays are equal.

Parameters:

pObjects1 - A reference to a com.esri.arcgis.system.IArray (in)

pObjects2 - A reference to a com.esri.arcgis.system.IArray (in)

Returns:

The pEqual

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWorkspace

void setWorkspace(java.lang.String workPath)
                  throws java.io.IOException,
                         AutomationException

Sets the current workspace.

Parameters:

workPath - The workPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspace

java.lang.String getWorkspace()
                              throws java.io.IOException,
                                     AutomationException

Sets the current workspace.

Returns:

The workPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCatalog

java.lang.Object getCatalog()
                            throws java.io.IOException,
                                   AutomationException

Gets the catalog object.

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRefreshCatalogParent

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

Indicates whether to refresh catalog parent.

Returns:

The pRefresh

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRefreshCatalogParent

void setRefreshCatalogParent(boolean pRefresh)
                             throws java.io.IOException,
                                    AutomationException

Indicates whether to refresh catalog parent.

Parameters:

pRefresh - The pRefresh (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

makeDataElement

IDataElement makeDataElement(java.lang.String catalogPath,
                             IDEBrowseOptions pBrowseOptions,
                             IGPDataType pDataType)
                             throws java.io.IOException,
                                    AutomationException

Makes a data element from path.

Parameters:

catalogPath - The catalogPath (in)

pBrowseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

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

makeDataElementFromNameObject

IDataElement makeDataElementFromNameObject(IName name)
                                           throws java.io.IOException,
                                                  AutomationException

Makes a data element from name object.

Parameters:

name - A reference to a com.esri.arcgis.system.IName (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.

expandDataElement

void expandDataElement(IDataElement pInDE,
                       IDEBrowseOptions pBrowseOptions)
                       throws java.io.IOException,
                              AutomationException

Expands a given data element.

Parameters:

pInDE - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

pBrowseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openDataset

IDataset openDataset(IDataElement pDataElement)
                     throws java.io.IOException,
                            AutomationException

Returns the dataset for the given data element.

Parameters:

pDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openLayerFromLocation

ILayer openLayerFromLocation(java.lang.String catalogPath)
                             throws java.io.IOException,
                                    AutomationException

Returns the layer based upon the given catalog path.

Parameters:

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

openDatasetFromLocation

IDataset openDatasetFromLocation(java.lang.String catalogPath,
                                 IGPDataType pDataType)
                                 throws java.io.IOException,
                                        AutomationException

Returns the dataset by catalog path.

Parameters:

catalogPath - The catalogPath (in)

pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshCatalog

void refreshCatalog(IDataElement pSourceDataElement)
                    throws java.io.IOException,
                           AutomationException

Refreshs catalog for the parent of the given data element.

Parameters:

pSourceDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

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

Deletes the data element.

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.

rename

void rename(IGPValue pSourceGPValue,
            IGPValue pTargetGPValue)
            throws java.io.IOException,
                   AutomationException

Renames the data element.

Parameters:

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

pTargetGPValue - 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.

copy

void copy(IGPValue pSourceGPValue,
          IGPValue pTargetGPValue)
          throws java.io.IOException,
                 AutomationException

Copys the data element.

Parameters:

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

pTargetGPValue - 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.

exists

boolean exists(IGPValue pGPValue)
               throws java.io.IOException,
                      AutomationException

Checks if a data element exists.

Parameters:

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

Returns:

The exists

Throws:

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

AutomationException - If the ArcObject component throws an exception.

compareWildCard

boolean compareWildCard(java.lang.String wildCard,
                        java.lang.String data)
                        throws java.io.IOException,
                               AutomationException

Compares a wildcard string against a given value.

Parameters:

wildCard - The wildCard (in)

data - The data (in)

Returns:

The matched

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNameObject

IName getNameObject(IDataElement pDataElement)
                    throws java.io.IOException,
                           AutomationException

Gets the name object for data element.

Parameters:

pDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNameObjectFromLocation

IName getNameObjectFromLocation(java.lang.String locationMoniker,
                                IGPDataType pDataType)
                                throws java.io.IOException,
                                       AutomationException

Gets the name object from a catalog path.

Parameters:

locationMoniker - The locationMoniker (in)

pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGxObjectFromLocation

java.lang.Object getGxObjectFromLocation(java.lang.String catalogPath,
                                         IGPDataType pDataType)
                                         throws java.io.IOException,
                                                AutomationException

Gets the GxObject from a catalog path.

Parameters:

catalogPath - The catalogPath (in)

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

parseName

void parseName(java.lang.String catalogPath,
               java.lang.String[] pName)
               throws java.io.IOException,
                      AutomationException

Returns the name of a catalog path.

Parameters:

catalogPath - The catalogPath (in)

pName - The pName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

parseContainer

void parseContainer(java.lang.String catalogPath,
                    java.lang.String[] pContainer)
                    throws java.io.IOException,
                           AutomationException

Returns the container of a catalog path.

Parameters:

catalogPath - The catalogPath (in)

pContainer - The pContainer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

releaseInternals

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

Release the internal objects used prior to releasing this DEUtilities object.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGxObject

java.lang.Object getGxObject(IDataElement pDataTlement)
                             throws java.io.IOException,
                                    AutomationException

Gets the GxObject for a data element.

Parameters:

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

getGxObjects

IArray getGxObjects(java.lang.String catalogPath)
                    throws java.io.IOException,
                           AutomationException

Returns an array of GxObjects for a catalog path.

Parameters:

catalogPath - The catalogPath (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

makeDataElements

IArray makeDataElements(java.lang.String catalogPath,
                        IDEBrowseOptions pBrowseOptions)
                        throws java.io.IOException,
                               AutomationException

Returns an array of data elements for a catalog path.

Parameters:

catalogPath - The catalogPath (in)

pBrowseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.