com.esri.arcgis.search
Class GPItemInfoHelper

java.lang.Object
  com.esri.arcgis.search.GPItemInfoHelper

All Implemented Interfaces:

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

public class GPItemInfoHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPItemInfoHelper

Item Info Helper.

See Also:

Serialized Form

Constructor Summary

GPItemInfoHelper()
Constructs a GPItemInfoHelper using ArcGIS Engine.

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

Method Summary

void	convertExtentToWGS84(IItemInfo[] pItemInfo) Converts the coordinates of the item info extent to WGS84.
boolean	equals(Object o) Compare this object with another
void	extractItemInfoFromMetadata(IMetadata pMetadata, IItemInfo[] pItemInfo) Extract user defined Item Info from metadata.
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

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

GPItemInfoHelper

public GPItemInfoHelper()
                 throws IOException,
                        UnknownHostException

Constructs a GPItemInfoHelper using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPItemInfoHelper

public GPItemInfoHelper(Object obj)
                 throws IOException

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

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

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

getItemInfoByDataElement

public IItemInfo getItemInfoByDataElement(IDataElement pDE)
                                   throws IOException,
                                          AutomationException

Provides access to ItemInfo Helper object. User can get item info from it.

Specified by:

getItemInfoByDataElement in interface IGPItemInfoHelper

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

public IItemInfo getItemInfoByDataElement2(IDataElement pDE,
                                           int geoType)
                                    throws IOException,
                                           AutomationException

Create item info from Data Element and Geometry Types.

Specified by:

getItemInfoByDataElement2 in interface IGPItemInfoHelper

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

public IItemInfo getItemInfoByDataset(IDataset pDataset)
                               throws IOException,
                                      AutomationException

Create item info from Dataset.

Specified by:

getItemInfoByDataset in interface IGPItemInfoHelper

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

public IItemInfo getItemInfoByDatasetName(IDatasetName pDatasetName)
                                   throws IOException,
                                          AutomationException

Create item info from DatesetName.

Specified by:

getItemInfoByDatasetName in interface IGPItemInfoHelper

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

public IItemInfo getItemInfoByCatalogPathAndType(String catalogPath,
                                                 IGPDataType pDataType)
                                          throws IOException,
                                                 AutomationException

Create item info from Catalog path.

Specified by:

getItemInfoByCatalogPathAndType in interface IGPItemInfoHelper

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

public IItemInfos getItemInfoByCatalogPath(String catalogPath)
                                    throws IOException,
                                           AutomationException

Create item infos from a catalog path.

Specified by:

getItemInfoByCatalogPath in interface IGPItemInfoHelper

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

public IItemInfo getItemInfoByGPLayer(IGPLayer pGPLayer)
                               throws IOException,
                                      AutomationException

Create item infos from layer.

Specified by:

getItemInfoByGPLayer in interface IGPItemInfoHelper

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

public void updateItemInfoByMetadata(IMetadata pMetadata,
                                     IItemInfo[] pItemInfo)
                              throws IOException,
                                     AutomationException

Update the item info of the specified object.

Specified by:

updateItemInfoByMetadata in interface IGPItemInfoHelper

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

public void updateItemInfoByDataElement(IDataElement pDE,
                                        IItemInfo[] pItemInfo)
                                 throws IOException,
                                        AutomationException

Update the item info of the specified object.

Specified by:

updateItemInfoByDataElement in interface IGPItemInfoHelper

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

public void updateItemInfoByDataset(IDataset pDataset,
                                    IItemInfo[] pItemInfo)
                             throws IOException,
                                    AutomationException

Update the item info of the specified object.

Specified by:

updateItemInfoByDataset in interface IGPItemInfoHelper

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

public void updateItemInfoByDatasetName(IDatasetName pDatasetName,
                                        IItemInfo[] pItemInfo)
                                 throws IOException,
                                        AutomationException

Update the item info of the specified object.

Specified by:

updateItemInfoByDatasetName in interface IGPItemInfoHelper

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

public void updateItemInfoByCatalogPathAndType(String catalogPath,
                                               IGPDataType pDataType,
                                               IItemInfo[] pItemInfo)
                                        throws IOException,
                                               AutomationException

Update the item info of the specified object.

Specified by:

updateItemInfoByCatalogPathAndType in interface IGPItemInfoHelper

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

public void updateItemInfoByGPLayer(IGPLayer pGPLayer,
                                    IItemInfo[] pItemInfo)
                             throws IOException,
                                    AutomationException

Update the item info of the specified object.

Specified by:

updateItemInfoByGPLayer in interface IGPItemInfoHelper

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

public void extractItemInfoFromMetadata(IMetadata pMetadata,
                                        IItemInfo[] pItemInfo)
                                 throws IOException,
                                        AutomationException

Extract user defined Item Info from metadata.

Specified by:

extractItemInfoFromMetadata in interface IGPItemInfoHelper

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

public void convertExtentToWGS84(IItemInfo[] pItemInfo)
                          throws IOException,
                                 AutomationException

Converts the coordinates of the item info extent to WGS84.

Specified by:

convertExtentToWGS84 in interface IGPItemInfoHelper

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.