com.esri.arcgis.search
Class GPItemIndex

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IItemIndex, IItemIndex2, IItemIndexAdmin, Serializable

public class GPItemIndex
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemIndex2, IItemIndexAdmin

IndexingHelper object.

See Also:

Serialized Form

Field Summary

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

IID, IIDacf9354c_05db_4a70_b5f3_48d2822cb400, xxDummy

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

IID, IIDcb225681_c42d_4a5f_b26e_f4a790cef7a7, xxDummy

Constructor Summary

GPItemIndex()
Constructs a GPItemIndex using ArcGIS Engine.

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

Method Summary

void	addItemInfo(IItemInfo pItemInfo) Add item info to index.
void	deleteItemInfo(String catalogPath) Delete item info from index.
void	deleteItemInfos(String catalogPath) Delete item infos from index.
void	endIndexing() Start indexing.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getIndexFolder() Name of the index folder.
String	getIndexName() Name of the index.
int	getItemInfoCount() Indicates whether to check index exists or not.
IStringArray	getItemsMissingThumbnails() The CatalogPaths without thumbnail info.
int	hashCode() the hashcode for this object
boolean	isItemInfoExists(String catalogPath) Indicates whether to check a particular iteminfo exists or not.
boolean	isUseStaging() Use staging during index.
void	setIndexFolder(String pFolderName) Name of the index folder.
void	setIndexName(String pName) Name of the index.
void	setUseStaging(boolean pUseStaging) Use staging during index.
void	startIndexing(boolean replaceIndex, boolean replaceItems) Start indexing.
void	updateItemInfo(IItemInfo pItemInfo) Update the specified item info in index.
void	updateThumbnail(String catalogPath, IThumbnailInfo thumbInfo) Update thumbnail info 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

GPItemIndex

public GPItemIndex()
            throws IOException,
                   UnknownHostException

Constructs a GPItemIndex using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPItemIndex

public GPItemIndex(Object obj)
            throws IOException

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

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

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

updateThumbnail

public void updateThumbnail(String catalogPath,
                            IThumbnailInfo thumbInfo)
                     throws IOException,
                            AutomationException

Update thumbnail info in index.

Specified by:

updateThumbnail in interface IItemIndex2

Parameters:

catalogPath - The catalogPath (in)

thumbInfo - A reference to a com.esri.arcgis.geodatabase.IThumbnailInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemsMissingThumbnails

public IStringArray getItemsMissingThumbnails()
                                       throws IOException,
                                              AutomationException

The CatalogPaths without thumbnail info.

Specified by:

getItemsMissingThumbnails in interface IItemIndex2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addItemInfo

public void addItemInfo(IItemInfo pItemInfo)
                 throws IOException,
                        AutomationException

Add item info to index.

Specified by:

addItemInfo in interface IItemIndex

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.

deleteItemInfo

public void deleteItemInfo(String catalogPath)
                    throws IOException,
                           AutomationException

Delete item info from index.

Specified by:

deleteItemInfo in interface IItemIndex

Parameters:

catalogPath - The catalogPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteItemInfos

public void deleteItemInfos(String catalogPath)
                     throws IOException,
                            AutomationException

Delete item infos from index.

Specified by:

deleteItemInfos in interface IItemIndex

Parameters:

catalogPath - The catalogPath (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 specified item info in index.

Specified by:

updateItemInfo in interface IItemIndex

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.

isItemInfoExists

public boolean isItemInfoExists(String catalogPath)
                         throws IOException,
                                AutomationException

Indicates whether to check a particular iteminfo exists or not.

Specified by:

isItemInfoExists in interface IItemIndex

Parameters:

catalogPath - The catalogPath (in)

Returns:

The bExsiting

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemInfoCount

public int getItemInfoCount()
                     throws IOException,
                            AutomationException

Indicates whether to check index exists or not.

Specified by:

getItemInfoCount in interface IItemIndex

Returns:

The count

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 IItemIndexAdmin

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 IItemIndexAdmin

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 IItemIndexAdmin

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 IItemIndexAdmin

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseStaging

public boolean isUseStaging()
                     throws IOException,
                            AutomationException

Use staging during index.

Specified by:

isUseStaging in interface IItemIndexAdmin

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

Use staging during index.

Specified by:

setUseStaging in interface IItemIndexAdmin

Parameters:

pUseStaging - The pUseStaging (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startIndexing

public void startIndexing(boolean replaceIndex,
                          boolean replaceItems)
                   throws IOException,
                          AutomationException

Start indexing.

Specified by:

startIndexing in interface IItemIndexAdmin

Parameters:

replaceIndex - The replaceIndex (in)

replaceItems - The replaceItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endIndexing

public void endIndexing()
                 throws IOException,
                        AutomationException

Start indexing.

Specified by:

endIndexing in interface IItemIndexAdmin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.