com.esri.arcgis.search
Class GPItemIndexer

java.lang.Object
  extended by com.esri.arcgis.search.GPItemIndexer
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IGPItemIndexer, IItemIndexer, Serializable

public class GPItemIndexer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemIndexer, IGPItemIndexer

GPItemIndexer object.

See Also:
Serialized Form

Constructor Summary
GPItemIndexer()
          Constructs a GPItemIndexer using ArcGIS Engine.
GPItemIndexer(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, String indexPath, String sDEConnection, String[] pGuid)
          Add ItemInfo to Index File.
 void buildIndex(IIndexingConfiguration pConfig, IItemIndex pIItemIndex)
          Build index with indexing helper.
 void deleteItemInfo(String indexPath, String pGuid)
          Delete ItemInfo from Index File.
 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.
 String getIndexFolder()
          Name of the index folder.
 String getIndexName()
          Name of the index.
 String getSDEConnection()
          SDE Connection file.
 int hashCode()
          the hashcode for this object
 void indexItem(String path)
          Index Item without children with passed in catalogpath.
 void indexItems(String path, boolean replaceIndex, boolean recursive, boolean useStaging, 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 isUseQueue()
          Indicates whether queue is used during index.
 boolean isUseStaging()
          Indicates whether staging is used during index.
 void setIndexerName(String pName)
          Name of the indexer.
 void setIndexFolder(String pFolderName)
          Name of the index folder.
 void setIndexName(String pName)
          Name of the index.
 void setSDEConnection(String pName)
          SDE Connection file.
 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(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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

GPItemIndexer

public GPItemIndexer()
              throws IOException,
                     UnknownHostException
Constructs a GPItemIndexer using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GPItemIndexer

public GPItemIndexer(Object obj)
              throws 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:
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.

indexItems

public void indexItems(String path,
                       boolean replaceIndex,
                       boolean recursive,
                       boolean useStaging,
                       String indexPath,
                       boolean useQueue)
                throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addItemInfo

public void addItemInfo(IItemInfo pItemInfo,
                        boolean replaceItems,
                        String indexPath,
                        String sDEConnection,
                        String[] pGuid)
                 throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteItemInfo

public void deleteItemInfo(String indexPath,
                           String pGuid)
                    throws IOException,
                           AutomationException
Delete ItemInfo from Index File.

Specified by:
deleteItemInfo in interface IGPItemIndexer
Parameters:
indexPath - The indexPath (in)
pGuid - The pGuid (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateItemInfo

public void updateItemInfo(IItemInfo pItemInfo)
                    throws IOException,
                           AutomationException
Update the index.

Specified by:
updateItemInfo in interface IGPItemIndexer
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.

indexItem

public void indexItem(String path)
               throws IOException,
                      AutomationException
Index Item without children with passed in catalogpath.

Specified by:
indexItem in interface IGPItemIndexer
Parameters:
path - The path (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateThumbnailInIndex

public void updateThumbnailInIndex(String path)
                            throws IOException,
                                   AutomationException
Update Thumbnail of a ItemInfo by passing in a catalogpath.

Specified by:
updateThumbnailInIndex in interface IGPItemIndexer
Parameters:
path - The path (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.

Specified by:
getCount in interface IGPItemIndexer
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAncestorRegistered

public boolean isAncestorRegistered(IItemInfo pItemInfo)
                             throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasBeenIndexed

public boolean isHasBeenIndexed(IItemInfo pItemInfo)
                         throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseStaging

public boolean isUseStaging()
                     throws IOException,
                            AutomationException
Indicates whether staging is used during index.

Specified by:
isUseStaging in interface IGPItemIndexer
Returns:
The pUseStaging
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseStaging

public void setUseStaging(boolean pUseStaging)
                   throws IOException,
                          AutomationException
Indicates whether staging is used during index.

Specified by:
setUseStaging in interface IGPItemIndexer
Parameters:
pUseStaging - The pUseStaging (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseQueue

public boolean isUseQueue()
                   throws IOException,
                          AutomationException
Indicates whether queue is used during index.

Specified by:
isUseQueue in interface IGPItemIndexer
Returns:
The useQueue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseQueue

public void setUseQueue(boolean useQueue)
                 throws IOException,
                        AutomationException
Indicates whether queue is used during index.

Specified by:
setUseQueue in interface IGPItemIndexer
Parameters:
useQueue - The useQueue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIndexFolder

public String getIndexFolder()
                      throws IOException,
                             AutomationException
Name of the index folder.

Specified by:
getIndexFolder in interface IGPItemIndexer
Returns:
The pFolderName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIndexFolder

public void setIndexFolder(String pFolderName)
                    throws IOException,
                           AutomationException
Name of the index folder.

Specified by:
setIndexFolder in interface IGPItemIndexer
Parameters:
pFolderName - The pFolderName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIndexName

public String getIndexName()
                    throws IOException,
                           AutomationException
Name of the index.

Specified by:
getIndexName in interface IGPItemIndexer
Returns:
The pName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIndexName

public void setIndexName(String pName)
                  throws IOException,
                         AutomationException
Name of the index.

Specified by:
setIndexName in interface IGPItemIndexer
Parameters:
pName - The pName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSDEConnection

public String getSDEConnection()
                        throws IOException,
                               AutomationException
SDE Connection file.

Specified by:
getSDEConnection in interface IGPItemIndexer
Returns:
The pName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSDEConnection

public void setSDEConnection(String pName)
                      throws IOException,
                             AutomationException
SDE Connection file.

Specified by:
setSDEConnection in interface IGPItemIndexer
Parameters:
pName - The pName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.