com.esri.arcgis.search
Interface IGPItemInfoHelper

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPItemInfoHelper

public interface IGPItemInfoHelper
extends Serializable

Provides access to helper functions for item info.


Method Summary
 void convertExtentToWGS84(IItemInfo[] pItemInfo)
          Converts the coordinates of the item info extent to WGS84.
 void extractItemInfoFromMetadata(IMetadata pMetadata, IItemInfo[] pItemInfo)
          Extract user defined Item Info from metadata.
 IItemInfos getItemInfoByCatalogPath(String catalogPath)
          Create item infos from a catalog path.
 IItemInfo getItemInfoByCatalogPathAndType(String catalogPath, IGPDataType pDataType)
          Create item info from Catalog path.
 IItemInfo getItemInfoByDataElement(IDataElement pDE)
          Provides access to ItemInfo Helper object.
 IItemInfo getItemInfoByDataElement2(IDataElement pDE, int geoType)
          Create item info from Data Element and Geometry Types.
 IItemInfo getItemInfoByDataset(IDataset pDataset)
          Create item info from Dataset.
 IItemInfo getItemInfoByDatasetName(IDatasetName pDatasetName)
          Create item info from DatesetName.
 IItemInfo getItemInfoByGPLayer(IGPLayer pGPLayer)
          Create item infos from layer.
 void updateItemInfoByCatalogPathAndType(String catalogPath, IGPDataType pDataType, IItemInfo[] pItemInfo)
          Update the item info of the specified object.
 void updateItemInfoByDataElement(IDataElement pDE, IItemInfo[] pItemInfo)
          Update the item info of the specified object.
 void updateItemInfoByDataset(IDataset pDataset, IItemInfo[] pItemInfo)
          Update the item info of the specified object.
 void updateItemInfoByDatasetName(IDatasetName pDatasetName, IItemInfo[] pItemInfo)
          Update the item info of the specified object.
 void updateItemInfoByGPLayer(IGPLayer pGPLayer, IItemInfo[] pItemInfo)
          Update the item info of the specified object.
 void updateItemInfoByMetadata(IMetadata pMetadata, IItemInfo[] pItemInfo)
          Update the item info of the specified object.
 

Method Detail

getItemInfoByDataElement

IItemInfo getItemInfoByDataElement(IDataElement pDE)
                                   throws IOException,
                                          AutomationException
Provides access to ItemInfo Helper object. User can get item info from it.

Parameters:
pDE - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IItemInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfoByDataElement2

IItemInfo getItemInfoByDataElement2(IDataElement pDE,
                                    int geoType)
                                    throws IOException,
                                           AutomationException
Create item info from Data Element and Geometry Types.

Parameters:
pDE - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)
geoType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IItemInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfoByDataset

IItemInfo getItemInfoByDataset(IDataset pDataset)
                               throws IOException,
                                      AutomationException
Create item info from Dataset.

Parameters:
pDataset - A reference to a com.esri.arcgis.geodatabase.IDataset (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IItemInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfoByDatasetName

IItemInfo getItemInfoByDatasetName(IDatasetName pDatasetName)
                                   throws IOException,
                                          AutomationException
Create item info from DatesetName.

Parameters:
pDatasetName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IItemInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfoByCatalogPathAndType

IItemInfo getItemInfoByCatalogPathAndType(String catalogPath,
                                          IGPDataType pDataType)
                                          throws IOException,
                                                 AutomationException
Create item info from 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.IItemInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfoByCatalogPath

IItemInfos getItemInfoByCatalogPath(String catalogPath)
                                    throws IOException,
                                           AutomationException
Create item infos from a catalog path.

Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IItemInfos
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfoByGPLayer

IItemInfo getItemInfoByGPLayer(IGPLayer pGPLayer)
                               throws IOException,
                                      AutomationException
Create item infos from layer.

Parameters:
pGPLayer - A reference to a com.esri.arcgis.datasourcesfile.IGPLayer (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IItemInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateItemInfoByMetadata

void updateItemInfoByMetadata(IMetadata pMetadata,
                              IItemInfo[] pItemInfo)
                              throws IOException,
                                     AutomationException
Update the item info of the specified object.

Parameters:
pMetadata - A reference to a com.esri.arcgis.geodatabase.IMetadata (in)
pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateItemInfoByDataElement

void updateItemInfoByDataElement(IDataElement pDE,
                                 IItemInfo[] pItemInfo)
                                 throws IOException,
                                        AutomationException
Update the item info of the specified object.

Parameters:
pDE - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)
pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateItemInfoByDataset

void updateItemInfoByDataset(IDataset pDataset,
                             IItemInfo[] pItemInfo)
                             throws IOException,
                                    AutomationException
Update the item info of the specified object.

Parameters:
pDataset - A reference to a com.esri.arcgis.geodatabase.IDataset (in)
pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateItemInfoByDatasetName

void updateItemInfoByDatasetName(IDatasetName pDatasetName,
                                 IItemInfo[] pItemInfo)
                                 throws IOException,
                                        AutomationException
Update the item info of the specified object.

Parameters:
pDatasetName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateItemInfoByCatalogPathAndType

void updateItemInfoByCatalogPathAndType(String catalogPath,
                                        IGPDataType pDataType,
                                        IItemInfo[] pItemInfo)
                                        throws IOException,
                                               AutomationException
Update the item info of the specified object.

Parameters:
catalogPath - The catalogPath (in)
pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateItemInfoByGPLayer

void updateItemInfoByGPLayer(IGPLayer pGPLayer,
                             IItemInfo[] pItemInfo)
                             throws IOException,
                                    AutomationException
Update the item info of the specified object.

Parameters:
pGPLayer - A reference to a com.esri.arcgis.datasourcesfile.IGPLayer (in)
pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractItemInfoFromMetadata

void extractItemInfoFromMetadata(IMetadata pMetadata,
                                 IItemInfo[] pItemInfo)
                                 throws IOException,
                                        AutomationException
Extract user defined Item Info from metadata.

Parameters:
pMetadata - A reference to a com.esri.arcgis.geodatabase.IMetadata (in)
pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertExtentToWGS84

void convertExtentToWGS84(IItemInfo[] pItemInfo)
                          throws IOException,
                                 AutomationException
Converts the coordinates of the item info extent to WGS84.

Parameters:
pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.