com.esri.arcgis.catalogUI
Class GxItemIndexer

java.lang.Object
  com.esri.arcgis.catalogUI.GxItemIndexer

All Implemented Interfaces:

IGxItemIndexer, com.esri.arcgis.interop.RemoteObjRef, IItemIndexer, Serializable

public class GxItemIndexer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemIndexer, IGxItemIndexer

Provides access to members of GxIndexer.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

GxItemIndexer()
Constructs a GxItemIndexer using ArcGIS Engine.

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

Method Summary

void	buildIndex(IIndexingConfiguration pConfig, IItemIndex pIItemIndex) Build index with indexing helper.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCount() Total indexed items count.
String	getIndexerName() Name of the indexer.
int	hashCode() the hashcode for this object
void	indexChildren(IGxObject pObject) Index the children of the current object.
void	indexObject(IGxObject pObject) Index the current object.
boolean	isAncestorRegistered(IGxObject pGxObject) Indicates whether the ancestor of this GxObject has been registered to be indexed.
boolean	isHasBeenIndexed(IGxObject pGxObject) Indicates whether the current object has been indexed.
void	setIndexerName(String pName) Name of the indexer.
void	updateIndex(IItemInfo pItemInfo) Update the index.
void	updateThumbnailInIndex(IGxObject pObject) Update current object's thumbnail in index.

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

GxItemIndexer

public GxItemIndexer()
              throws IOException,
                     UnknownHostException

Constructs a GxItemIndexer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxItemIndexer

public GxItemIndexer(Object obj)
              throws IOException

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

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

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

getIndexerName

public String getIndexerName()
                      throws IOException,
                             AutomationException

Name of the indexer.

Specified by:

getIndexerName in interface IItemIndexer

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexerName

public void setIndexerName(String pName)
                    throws IOException,
                           AutomationException

Name of the indexer.

Specified by:

setIndexerName in interface IItemIndexer

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

buildIndex

public void buildIndex(IIndexingConfiguration pConfig,
                       IItemIndex pIItemIndex)
                throws IOException,
                       AutomationException

Build index with indexing helper.

Specified by:

buildIndex in interface IItemIndexer

Parameters:

pConfig - A reference to a com.esri.arcgis.search.IIndexingConfiguration (in)

pIItemIndex - A reference to a com.esri.arcgis.search.IItemIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

Total indexed items count.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getCount in interface IGxItemIndexer

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAncestorRegistered

public boolean isAncestorRegistered(IGxObject pGxObject)
                             throws IOException,
                                    AutomationException

Indicates whether the ancestor of this GxObject has been registered to be indexed.

Product Availability

Available with ArcGIS Desktop.

Specified by:

isAncestorRegistered in interface IGxItemIndexer

Parameters:

pGxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

The pRegistered

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasBeenIndexed

public boolean isHasBeenIndexed(IGxObject pGxObject)
                         throws IOException,
                                AutomationException

Indicates whether the current object has been indexed.

Product Availability

Available with ArcGIS Desktop.

Specified by:

isHasBeenIndexed in interface IGxItemIndexer

Parameters:

pGxObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

The pIndexed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateIndex

public void updateIndex(IItemInfo pItemInfo)
                 throws IOException,
                        AutomationException

Update the index.

Product Availability

Available with ArcGIS Desktop.

Specified by:

updateIndex in interface IGxItemIndexer

Parameters:

pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

indexObject

public void indexObject(IGxObject pObject)
                 throws IOException,
                        AutomationException

Index the current object.

Product Availability

Available with ArcGIS Desktop.

Specified by:

indexObject in interface IGxItemIndexer

Parameters:

pObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

indexChildren

public void indexChildren(IGxObject pObject)
                   throws IOException,
                          AutomationException

Index the children of the current object.

Product Availability

Available with ArcGIS Desktop.

Specified by:

indexChildren in interface IGxItemIndexer

Parameters:

pObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateThumbnailInIndex

public void updateThumbnailInIndex(IGxObject pObject)
                            throws IOException,
                                   AutomationException

Update current object's thumbnail in index.

Product Availability

Available with ArcGIS Desktop.

Specified by:

updateThumbnailInIndex in interface IGxItemIndexer

Parameters:

pObject - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.