com.esri.arcgis.geoprocessing
Class DEUtilities

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

All Implemented Interfaces:

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

public class DEUtilities
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDEUtilities

Data Element Utilities object.

Product Availability

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

Singleton:

This type is a singleton.

See Also:

Serialized Form

Constructor Summary

DEUtilities()
Constructs a DEUtilities using ArcGIS Engine.

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

Method Summary

void	assignTinProperties(ITin pTin, IDataElement pDataElement) Assign tin properties.
boolean	compareWildCard(String wildCard, 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	equals(Object o) Compare this object with another
boolean	exists(IGPValue pGPValue) Checks if a data element exists.
void	expandDataElement(IDataElement pInDE, IDEBrowseOptions pBrowseOptions) Expands a given data element.
Object	getCatalog() Gets the catalog object.
static String	getClsid() getClsid.
Object	getGxObject(IDataElement pDataTlement) Gets the GxObject for a data element.
Object	getGxObjectFromLocation(String catalogPath, IGPDataType pDataType) Gets the GxObject from a catalog path.
IArray	getGxObjects(String catalogPath) Returns an array of GxObjects for a catalog path.
IName	getNameObject(IDataElement pDataElement) Gets the name object for data element.
IName	getNameObjectFromLocation(String locationMoniker, IGPDataType pDataType) Gets the name object from a catalog path.
String	getWorkspace() Sets the current workspace.
int	hashCode() the hashcode for this object
boolean	isEqualArray(IArray pObjects1, IArray pObjects2) Check if field arrays are equal.
boolean	isRefreshCatalogParent() Indicates whether to refresh catalog parent.
IDataElement	makeDataElement(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(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(String catalogPath, IGPDataType pDataType) Returns the dataset by catalog path.
ILayer	openLayerFromLocation(String catalogPath) Returns the layer based upon the given catalog path.
void	parseContainer(String catalogPath, String[] pContainer) Returns the container of a catalog path.
void	parseName(String catalogPath, 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(String workPath) Sets the current workspace.

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

DEUtilities

public DEUtilities()
            throws IOException,
                   UnknownHostException

Constructs a DEUtilities using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DEUtilities

public DEUtilities(Object obj)
            throws IOException

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

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

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

assignTinProperties

public void assignTinProperties(ITin pTin,
                                IDataElement pDataElement)
                         throws IOException,
                                AutomationException

Assign tin properties.

Product Availability

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

Specified by:

assignTinProperties in interface IDEUtilities

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqualArray

public boolean isEqualArray(IArray pObjects1,
                            IArray pObjects2)
                     throws IOException,
                            AutomationException

Check if field arrays are equal.

Product Availability

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

Specified by:

isEqualArray in interface IDEUtilities

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspace

public void setWorkspace(String workPath)
                  throws IOException,
                         AutomationException

Sets the current workspace.

Product Availability

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

Specified by:

setWorkspace in interface IDEUtilities

Parameters:

workPath - The workPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public String getWorkspace()
                    throws IOException,
                           AutomationException

Sets the current workspace.

Product Availability

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

Specified by:

getWorkspace in interface IDEUtilities

Returns:

The workPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCatalog

public Object getCatalog()
                  throws IOException,
                         AutomationException

Gets the catalog object.

Product Availability

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

Specified by:

getCatalog in interface IDEUtilities

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRefreshCatalogParent

public boolean isRefreshCatalogParent()
                               throws IOException,
                                      AutomationException

Indicates whether to refresh catalog parent.

Product Availability

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

Specified by:

isRefreshCatalogParent in interface IDEUtilities

Returns:

The pRefresh

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefreshCatalogParent

public void setRefreshCatalogParent(boolean pRefresh)
                             throws IOException,
                                    AutomationException

Indicates whether to refresh catalog parent.

Product Availability

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

Specified by:

setRefreshCatalogParent in interface IDEUtilities

Parameters:

pRefresh - The pRefresh (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeDataElement

public IDataElement makeDataElement(String catalogPath,
                                    IDEBrowseOptions pBrowseOptions,
                                    IGPDataType pDataType)
                             throws IOException,
                                    AutomationException

Makes a data element from path.

Product Availability

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

Specified by:

makeDataElement in interface IDEUtilities

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeDataElementFromNameObject

public IDataElement makeDataElementFromNameObject(IName name)
                                           throws IOException,
                                                  AutomationException

Makes a data element from name object.

Product Availability

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

Specified by:

makeDataElementFromNameObject in interface IDEUtilities

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandDataElement

public void expandDataElement(IDataElement pInDE,
                              IDEBrowseOptions pBrowseOptions)
                       throws IOException,
                              AutomationException

Expands a given data element.

Product Availability

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

Specified by:

expandDataElement in interface IDEUtilities

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDataset

public IDataset openDataset(IDataElement pDataElement)
                     throws IOException,
                            AutomationException

Returns the dataset for the given data element.

Product Availability

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

Specified by:

openDataset in interface IDEUtilities

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openLayerFromLocation

public ILayer openLayerFromLocation(String catalogPath)
                             throws IOException,
                                    AutomationException

Returns the layer based upon the given catalog path.

Product Availability

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

Specified by:

openLayerFromLocation in interface IDEUtilities

Parameters:

catalogPath - The catalogPath (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDatasetFromLocation

public IDataset openDatasetFromLocation(String catalogPath,
                                        IGPDataType pDataType)
                                 throws IOException,
                                        AutomationException

Returns the dataset by catalog path.

Product Availability

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

Specified by:

openDatasetFromLocation in interface IDEUtilities

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshCatalog

public void refreshCatalog(IDataElement pSourceDataElement)
                    throws IOException,
                           AutomationException

Refreshs catalog for the parent of the given data element.

Product Availability

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

Specified by:

refreshCatalog in interface IDEUtilities

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete(IGPValue pGPValue)
            throws IOException,
                   AutomationException

Deletes the data element.

Product Availability

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

Specified by:

delete in interface IDEUtilities

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rename

public void rename(IGPValue pSourceGPValue,
                   IGPValue pTargetGPValue)
            throws IOException,
                   AutomationException

Renames the data element.

Product Availability

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

Specified by:

rename in interface IDEUtilities

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IGPValue pSourceGPValue,
                 IGPValue pTargetGPValue)
          throws IOException,
                 AutomationException

Copys the data element.

Product Availability

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

Specified by:

copy in interface IDEUtilities

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exists

public boolean exists(IGPValue pGPValue)
               throws IOException,
                      AutomationException

Checks if a data element exists.

Product Availability

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

Specified by:

exists in interface IDEUtilities

Parameters:

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

Returns:

The exists

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compareWildCard

public boolean compareWildCard(String wildCard,
                               String data)
                        throws IOException,
                               AutomationException

Compares a wildcard string against a given value.

Product Availability

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

Specified by:

compareWildCard in interface IDEUtilities

Parameters:

wildCard - The wildCard (in)

data - The data (in)

Returns:

The matched

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameObject

public IName getNameObject(IDataElement pDataElement)
                    throws IOException,
                           AutomationException

Gets the name object for data element.

Product Availability

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

Specified by:

getNameObject in interface IDEUtilities

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameObjectFromLocation

public IName getNameObjectFromLocation(String locationMoniker,
                                       IGPDataType pDataType)
                                throws IOException,
                                       AutomationException

Gets the name object from a catalog path.

Product Availability

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

Specified by:

getNameObjectFromLocation in interface IDEUtilities

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGxObjectFromLocation

public Object getGxObjectFromLocation(String catalogPath,
                                      IGPDataType pDataType)
                               throws IOException,
                                      AutomationException

Gets the GxObject from a catalog path.

Product Availability

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

Specified by:

getGxObjectFromLocation in interface IDEUtilities

Parameters:

catalogPath - The catalogPath (in)

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

parseName

public void parseName(String catalogPath,
                      String[] pName)
               throws IOException,
                      AutomationException

Returns the name of a catalog path.

Product Availability

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

Specified by:

parseName in interface IDEUtilities

Parameters:

catalogPath - The catalogPath (in)

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

parseContainer

public void parseContainer(String catalogPath,
                           String[] pContainer)
                    throws IOException,
                           AutomationException

Returns the container of a catalog path.

Product Availability

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

Specified by:

parseContainer in interface IDEUtilities

Parameters:

catalogPath - The catalogPath (in)

pContainer - The pContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

releaseInternals

public void releaseInternals()
                      throws IOException,
                             AutomationException

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

Product Availability

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

Specified by:

releaseInternals in interface IDEUtilities

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGxObject

public Object getGxObject(IDataElement pDataTlement)
                   throws IOException,
                          AutomationException

Gets the GxObject for a data element.

Product Availability

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

Specified by:

getGxObject in interface IDEUtilities

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGxObjects

public IArray getGxObjects(String catalogPath)
                    throws IOException,
                           AutomationException

Returns an array of GxObjects for a catalog path.

Product Availability

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

Specified by:

getGxObjects in interface IDEUtilities

Parameters:

catalogPath - The catalogPath (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeDataElements

public IArray makeDataElements(String catalogPath,
                               IDEBrowseOptions pBrowseOptions)
                        throws IOException,
                               AutomationException

Returns an array of data elements for a catalog path.

Product Availability

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

Specified by:

makeDataElements in interface IDEUtilities

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.