com.esri.arcgis.search
Class GPItemIndexer

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IGPItemIndexer, IGPItemIndexer2, IGPMultithreadedItemIndexer, IItemIndexer, java.io.Serializable

public class GPItemIndexer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemIndexer, IGPItemIndexer, IGPItemIndexer2, IGPMultithreadedItemIndexer

COM Class 'GPItemIndexer'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriSearch.tlb'

Description 'GPItemIndexer object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.search.IItemIndexer

IID, IIDb1213e5f_d10a_45dc_9413_6c39cfe1254e, xxDummy

Fields inherited from interface com.esri.arcgis.search.IGPItemIndexer2

IID, IIDe76ace8c_074c_4b5c_84b1_04ed7c5b2a7c, xxDummy

Fields inherited from interface com.esri.arcgis.search.IGPItemIndexer

IID289ea2b6_d185_40f7_b1e7_b2234ae1c9f6

Fields inherited from interface com.esri.arcgis.search.IGPMultithreadedItemIndexer

IID, IIDdb185959_c37d_4b82_a6d4_cdde04c8373b, xxDummy

Constructor Summary

GPItemIndexer()
Constructs a GPItemIndexer using ArcGIS Engine.

GPItemIndexer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPItemIndexer theGPItemIndexer = (GPItemIndexer) obj;

Method Summary

void	addItemInfo(IItemInfo pItemInfo, boolean replaceItems, java.lang.String indexPath, java.lang.String sDEConnection, java.lang.String[] pGuid) Add ItemInfo to Index File.
void	buildIndex(IIndexingConfiguration pConfig, IItemIndex pIItemIndex) Build index with indexing helper.
void	deleteItemInfo(java.lang.String indexPath, java.lang.String pGuid) Delete ItemInfo from Index File.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
int	getCount() Total indexed items count.
java.lang.String	getIndexerName() Name of the indexer.
java.lang.String	getIndexFolder() Name of the index folder.
java.lang.String	getIndexName() Name of the index.
IItemIndex	getItemIndex() The native item index.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getSDEConnection() SDE Connection file.
IName	getServerObjectName() The ArcGIS server object to perform index creation.
int	getThreadCount() The number of instances for index creation.
int	hashCode() the hashcode for this object
void	indexItem(java.lang.String path) Index Item without children with passed in catalogpath.
void	indexItems(IStringArray pPaths, boolean replaceIndex, boolean recursive, java.lang.String indexPath, ITrackCancel pTrackCancel) Indexes items from an array of data sources.
void	indexItems(java.lang.String path, boolean replaceIndex, boolean recursive, boolean useStaging, java.lang.String indexPath, boolean useQueue) The Build ItemInfos..
boolean	isAncestorRegistered(IItemInfo pItemInfo) Indicates whether the ancestor of this ItemInfo has been registered to be indexed.
boolean	isHasBeenIndexed(IItemInfo pItemInfo) Indicates whether the current item has been indexed.
boolean	isSkipConnections() Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.
boolean	isSkipMosaicItems() Indicates whether to skip mosaic dataset items when indexing.
boolean	isUseQueue() Indicates whether queue is used during index.
boolean	isUseStaging() Indicates whether staging is used during index.
void	release() Release a GPItemIndexer.
void	setIndexerName(java.lang.String pName) Name of the indexer.
void	setIndexFolder(java.lang.String pFolderName) Name of the index folder.
void	setIndexName(java.lang.String pName) Name of the index.
void	setSDEConnection(java.lang.String pName) SDE Connection file.
void	setServerObjectNameByRef(IName ppName) The ArcGIS server object to perform index creation.
void	setSkipConnections(boolean pSkipConnections) Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.
void	setSkipMosaicItems(boolean pSkipMosaicItems) Indicates whether to skip mosaic dataset items when indexing.
void	setThreadCount(int pThreadCount) The number of instances for index creation.
void	setUseQueue(boolean useQueue) Indicates whether queue is used during index.
void	setUseStaging(boolean pUseStaging) Indicates whether staging is used during index.
void	updateItemInfo(IItemInfo pItemInfo) Update the index.
void	updateThumbnailInIndex(java.lang.String path) Update Thumbnail of a ItemInfo by passing in a catalogpath.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GPItemIndexer

public GPItemIndexer()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a GPItemIndexer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPItemIndexer

public GPItemIndexer(java.lang.Object obj)
              throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GPItemIndexer.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getIndexerName

public java.lang.String getIndexerName()
                                throws java.io.IOException,
                                       AutomationException

Name of the indexer.

Specified by:

getIndexerName in interface IItemIndexer

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexerName

public void setIndexerName(java.lang.String pName)
                    throws java.io.IOException,
                           AutomationException

Name of the indexer.

Specified by:

setIndexerName in interface IItemIndexer

Parameters:

pName - The pName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

buildIndex

public void buildIndex(IIndexingConfiguration pConfig,
                       IItemIndex pIItemIndex)
                throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

indexItems

public void indexItems(java.lang.String path,
                       boolean replaceIndex,
                       boolean recursive,
                       boolean useStaging,
                       java.lang.String indexPath,
                       boolean useQueue)
                throws java.io.IOException,
                       AutomationException

The Build ItemInfos..

Specified by:

indexItems in interface IGPItemIndexer

Parameters:

path - The path (in)

replaceIndex - The replaceIndex (in)

recursive - The recursive (in)

useStaging - The useStaging (in)

indexPath - The indexPath (in)

useQueue - The useQueue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addItemInfo

public void addItemInfo(IItemInfo pItemInfo,
                        boolean replaceItems,
                        java.lang.String indexPath,
                        java.lang.String sDEConnection,
                        java.lang.String[] pGuid)
                 throws java.io.IOException,
                        AutomationException

Add ItemInfo to Index File.

Specified by:

addItemInfo in interface IGPItemIndexer

Parameters:

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

replaceItems - The replaceItems (in)

indexPath - The indexPath (in)

sDEConnection - The sDEConnection (in)

pGuid - The pGuid (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteItemInfo

public void deleteItemInfo(java.lang.String indexPath,
                           java.lang.String pGuid)
                    throws java.io.IOException,
                           AutomationException

Delete ItemInfo from Index File.

Specified by:

deleteItemInfo in interface IGPItemIndexer

Parameters:

indexPath - The indexPath (in)

pGuid - The pGuid (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateItemInfo

public void updateItemInfo(IItemInfo pItemInfo)
                    throws java.io.IOException,
                           AutomationException

Update the index.

Specified by:

updateItemInfo in interface IGPItemIndexer

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

indexItem

public void indexItem(java.lang.String path)
               throws java.io.IOException,
                      AutomationException

Index Item without children with passed in catalogpath.

Specified by:

indexItem in interface IGPItemIndexer

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateThumbnailInIndex

public void updateThumbnailInIndex(java.lang.String path)
                            throws java.io.IOException,
                                   AutomationException

Update Thumbnail of a ItemInfo by passing in a catalogpath.

Specified by:

updateThumbnailInIndex in interface IGPItemIndexer

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException

Total indexed items count.

Specified by:

getCount in interface IGPItemIndexer

Returns:

The pCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAncestorRegistered

public boolean isAncestorRegistered(IItemInfo pItemInfo)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

isAncestorRegistered in interface IGPItemIndexer

Parameters:

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

Returns:

The pRegistered

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasBeenIndexed

public boolean isHasBeenIndexed(IItemInfo pItemInfo)
                         throws java.io.IOException,
                                AutomationException

Indicates whether the current item has been indexed.

Specified by:

isHasBeenIndexed in interface IGPItemIndexer

Parameters:

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

Returns:

The pIndexed

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseStaging

public boolean isUseStaging()
                     throws java.io.IOException,
                            AutomationException

Indicates whether staging is used during index.

Specified by:

isUseStaging in interface IGPItemIndexer

Returns:

The pUseStaging

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseStaging

public void setUseStaging(boolean pUseStaging)
                   throws java.io.IOException,
                          AutomationException

Indicates whether staging is used during index.

Specified by:

setUseStaging in interface IGPItemIndexer

Parameters:

pUseStaging - The pUseStaging (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseQueue

public boolean isUseQueue()
                   throws java.io.IOException,
                          AutomationException

Indicates whether queue is used during index.

Specified by:

isUseQueue in interface IGPItemIndexer

Returns:

The useQueue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseQueue

public void setUseQueue(boolean useQueue)
                 throws java.io.IOException,
                        AutomationException

Indicates whether queue is used during index.

Specified by:

setUseQueue in interface IGPItemIndexer

Parameters:

useQueue - The useQueue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexFolder

public java.lang.String getIndexFolder()
                                throws java.io.IOException,
                                       AutomationException

Name of the index folder.

Specified by:

getIndexFolder in interface IGPItemIndexer

Returns:

The pFolderName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexFolder

public void setIndexFolder(java.lang.String pFolderName)
                    throws java.io.IOException,
                           AutomationException

Name of the index folder.

Specified by:

setIndexFolder in interface IGPItemIndexer

Parameters:

pFolderName - The pFolderName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexName

public java.lang.String getIndexName()
                              throws java.io.IOException,
                                     AutomationException

Name of the index.

Specified by:

getIndexName in interface IGPItemIndexer

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexName

public void setIndexName(java.lang.String pName)
                  throws java.io.IOException,
                         AutomationException

Name of the index.

Specified by:

setIndexName in interface IGPItemIndexer

Parameters:

pName - The pName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSDEConnection

public java.lang.String getSDEConnection()
                                  throws java.io.IOException,
                                         AutomationException

SDE Connection file.

Specified by:

getSDEConnection in interface IGPItemIndexer

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSDEConnection

public void setSDEConnection(java.lang.String pName)
                      throws java.io.IOException,
                             AutomationException

SDE Connection file.

Specified by:

setSDEConnection in interface IGPItemIndexer

Parameters:

pName - The pName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSkipConnections

public boolean isSkipConnections()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.

Specified by:

isSkipConnections in interface IGPItemIndexer2

Returns:

The pSkipConnections

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSkipConnections

public void setSkipConnections(boolean pSkipConnections)
                        throws java.io.IOException,
                               AutomationException

Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.

Specified by:

setSkipConnections in interface IGPItemIndexer2

Parameters:

pSkipConnections - The pSkipConnections (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSkipMosaicItems

public boolean isSkipMosaicItems()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether to skip mosaic dataset items when indexing.

Specified by:

isSkipMosaicItems in interface IGPItemIndexer2

Returns:

The pSkipMosaicItems

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSkipMosaicItems

public void setSkipMosaicItems(boolean pSkipMosaicItems)
                        throws java.io.IOException,
                               AutomationException

Indicates whether to skip mosaic dataset items when indexing.

Specified by:

setSkipMosaicItems in interface IGPItemIndexer2

Parameters:

pSkipMosaicItems - The pSkipMosaicItems (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemIndex

public IItemIndex getItemIndex()
                        throws java.io.IOException,
                               AutomationException

The native item index.

Specified by:

getItemIndex in interface IGPItemIndexer2

Returns:

A reference to a com.esri.arcgis.search.IItemIndex

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThreadCount

public int getThreadCount()
                   throws java.io.IOException,
                          AutomationException

The number of instances for index creation.

Specified by:

getThreadCount in interface IGPMultithreadedItemIndexer

Returns:

The pThreadCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThreadCount

public void setThreadCount(int pThreadCount)
                    throws java.io.IOException,
                           AutomationException

The number of instances for index creation.

Specified by:

setThreadCount in interface IGPMultithreadedItemIndexer

Parameters:

pThreadCount - The pThreadCount (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerObjectName

public IName getServerObjectName()
                          throws java.io.IOException,
                                 AutomationException

The ArcGIS server object to perform index creation.

Specified by:

getServerObjectName in interface IGPMultithreadedItemIndexer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerObjectNameByRef

public void setServerObjectNameByRef(IName ppName)
                              throws java.io.IOException,
                                     AutomationException

The ArcGIS server object to perform index creation.

Specified by:

setServerObjectNameByRef in interface IGPMultithreadedItemIndexer

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

indexItems

public void indexItems(IStringArray pPaths,
                       boolean replaceIndex,
                       boolean recursive,
                       java.lang.String indexPath,
                       ITrackCancel pTrackCancel)
                throws java.io.IOException,
                       AutomationException

Indexes items from an array of data sources.

Specified by:

indexItems in interface IGPMultithreadedItemIndexer

Parameters:

pPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

replaceIndex - The replaceIndex (in)

recursive - The recursive (in)

indexPath - The indexPath (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.