Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geoprocessing
Interface IDEUtilities

All Superinterfaces:
Serializable
All Known Implementing Classes:
DEUtilities
public interface IDEUtilities
extends Serializable

Provides access to the Data Element Utilities.

Product Availability

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

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

Method Detail

assignTinProperties

void assignTinProperties(ITin pTin,
                         IDataElement pDataElement)
                         throws IOException,
                                AutomationException
Assign tin properties.

Product Availability

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

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

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.

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

void setWorkspace(String workPath)
                  throws IOException,
                         AutomationException
Sets the current workspace.

Product Availability

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

Parameters:
workPath - The workPath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspace

String getWorkspace()
                    throws IOException,
                           AutomationException
Sets the current workspace.

Product Availability

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

Returns:
The workPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCatalog

Object getCatalog()
                  throws IOException,
                         AutomationException
Gets the catalog object.

Product Availability

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

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRefreshCatalogParent

boolean isRefreshCatalogParent()
                               throws IOException,
                                      AutomationException
Indicates whether to refresh catalog parent.

Product Availability

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

Returns:
The pRefresh
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRefreshCatalogParent

void setRefreshCatalogParent(boolean pRefresh)
                             throws IOException,
                                    AutomationException
Indicates whether to refresh catalog parent.

Product Availability

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

Parameters:
pRefresh - The pRefresh (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeDataElement

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

void delete(IGPValue pGPValue)
            throws IOException,
                   AutomationException
Deletes the data element.

Product Availability

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

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

void rename(IGPValue pSourceGPValue,
            IGPValue pTargetGPValue)
            throws IOException,
                   AutomationException
Renames the data element.

Product Availability

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

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

void copy(IGPValue pSourceGPValue,
          IGPValue pTargetGPValue)
          throws IOException,
                 AutomationException
Copys the data element.

Product Availability

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

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

boolean exists(IGPValue pGPValue)
               throws IOException,
                      AutomationException
Checks if a data element exists.

Product Availability

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGxObject

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.

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

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.

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

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.

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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD