com.esri.arcgis.search
Class ItemIndex

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IItemIndex, IItemIndex2, IItemIndex3, IItemIndexAdmin, java.io.Serializable

public class ItemIndex
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemIndex, IItemIndex2, IItemIndex3, IItemIndexAdmin

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

Description 'Provides access to the ItemIndex 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.IItemIndex3

IID, IID2a2148d1_4653_4658_b4d6_a50bf3b7ea78, xxDummy

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

IIDfcaf5f49_fda4_4dd6_87e9_743e139dbbcb

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

IIDacf9354c_05db_4a70_b5f3_48d2822cb400

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

IID, IIDcb225681_c42d_4a5f_b26e_f4a790cef7a7, xxDummy

Constructor Summary

ItemIndex()
Constructs a ItemIndex using ArcGIS Engine.

ItemIndex(java.lang.Object obj)
Construct a ItemIndex using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addIndex(java.lang.String indexDirectory, boolean dedup) Adds another index.
void	addItemInfo(IItemInfo pItemInfo) Add item info to index.
IStringArray	compare(java.lang.String indexDirectory) Compares with another index.
void	deleteItemInfo(java.lang.String catalogPath) Delete item info from index.
void	deleteItemInfos(java.lang.String catalogPath) Delete item infos from index.
void	endIndexing() Start indexing.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.String	getIndexFolder() Name of the index folder.
java.lang.String	getIndexName() Name of the index.
int	getItemInfoCount() Check index exists or not.
IStringArray	getItemsMissingThumbnails() The CatalogPaths without thumbnail info.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	hashCode() the hashcode for this object
boolean	isItemInfoExists(java.lang.String catalogPath) Check a particular iteminfo exists or not.
boolean	isPrefixExists(java.lang.String prefix) Indicates whether if a give prefix matches any catalog path.
boolean	isUseStaging() Use staging during index.
void	release() Release a ItemIndex.
void	setIndexFolder(java.lang.String pFolderName) Name of the index folder.
void	setIndexName(java.lang.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(java.lang.String catalogPath, IThumbnailInfo pThumbInfo) Update thumbnail info in index.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemIndex

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

Constructs a ItemIndex using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ItemIndex

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems ItemIndex theItemIndex = (ItemIndex) obj;

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 ItemIndex.

Specified by:

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

addItemInfo

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

Add item info to index.

Specified by:

addItemInfo in interface IItemIndex

Parameters:

pItemInfo - A reference to a com.esri.arcgis.search.IItemInfo (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 catalogPath)
                    throws java.io.IOException,
                           AutomationException

Delete item info from index.

Specified by:

deleteItemInfo in interface IItemIndex

Parameters:

catalogPath - The catalogPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteItemInfos

public void deleteItemInfos(java.lang.String catalogPath)
                     throws java.io.IOException,
                            AutomationException

Delete item infos from index.

Specified by:

deleteItemInfos in interface IItemIndex

Parameters:

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

Specified by:

updateItemInfo in interface IItemIndex

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isItemInfoExists

public boolean isItemInfoExists(java.lang.String catalogPath)
                         throws java.io.IOException,
                                AutomationException

Check a particular iteminfo exists or not.

Specified by:

isItemInfoExists in interface IItemIndex

Parameters:

catalogPath - The catalogPath (in)

Returns:

The bExsiting

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemInfoCount

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

Check index exists or not.

Specified by:

getItemInfoCount in interface IItemIndex

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateThumbnail

public void updateThumbnail(java.lang.String catalogPath,
                            IThumbnailInfo pThumbInfo)
                     throws java.io.IOException,
                            AutomationException

Update thumbnail info in index.

Specified by:

updateThumbnail in interface IItemIndex2

Parameters:

catalogPath - The catalogPath (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemsMissingThumbnails

public IStringArray getItemsMissingThumbnails()
                                       throws java.io.IOException,
                                              AutomationException

The CatalogPaths without thumbnail info.

Specified by:

getItemsMissingThumbnails in interface IItemIndex2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(java.lang.String indexDirectory,
                     boolean dedup)
              throws java.io.IOException,
                     AutomationException

Adds another index.

Specified by:

addIndex in interface IItemIndex3

Parameters:

indexDirectory - The indexDirectory (in)

dedup - The dedup (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPrefixExists

public boolean isPrefixExists(java.lang.String prefix)
                       throws java.io.IOException,
                              AutomationException

Indicates whether if a give prefix matches any catalog path.

Specified by:

isPrefixExists in interface IItemIndex3

Parameters:

prefix - The prefix (in)

Returns:

The pbExsits

Throws:

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

AutomationException - If the ArcObject component throws an exception.

compare

public IStringArray compare(java.lang.String indexDirectory)
                     throws java.io.IOException,
                            AutomationException

Compares with another index.

Specified by:

compare in interface IItemIndex3

Parameters:

indexDirectory - The indexDirectory (in)

Returns:

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

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 IItemIndexAdmin

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 IItemIndexAdmin

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 IItemIndexAdmin

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 IItemIndexAdmin

Parameters:

pName - The pName (in)

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

Use staging during index.

Specified by:

isUseStaging in interface IItemIndexAdmin

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

Use staging during index.

Specified by:

setUseStaging in interface IItemIndexAdmin

Parameters:

pUseStaging - The pUseStaging (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startIndexing

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

Start indexing.

Specified by:

startIndexing in interface IItemIndexAdmin

Parameters:

replaceIndex - The replaceIndex (in)

replaceItems - The replaceItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

endIndexing

public void endIndexing()
                 throws java.io.IOException,
                        AutomationException

Start indexing.

Specified by:

endIndexing in interface IItemIndexAdmin

Throws:

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

AutomationException - If the ArcObject component throws an exception.