com.esri.arcgis.search
Class IndexingConfiguration

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IIndexingConfiguration, Serializable

public class IndexingConfiguration
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIndexingConfiguration

Provide access to the IndexingConfiguration object.

See Also:

Serialized Form

Constructor Summary

IndexingConfiguration()
Constructs a IndexingConfiguration using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getFilter() File extensions to be filtered out.
int	getFullIndexInterval() Full index interval.
int	getIncrementalIndexInterval() Incremental index interval.
IStringArray	getPaths() The target paths to be indexed.
String	getStartTime() Index start time.
int	hashCode() the hashcode for this object
boolean	isPaused() Indicates whether to pause indexing until instructed to resume.
boolean	isRecursive() Indicates whether to recursively get the children of target path.
boolean	isReplaceIndex() Indicates whether to replace existing index.
boolean	isReplaceItems() Indicates whether to replace existing items.
boolean	isSkipConnections() Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.
boolean	isWasRunning() Indicates whether the indexer was running when it was paused.
void	setFilter(String pFilter) File extensions to be filtered out.
void	setFullIndexInterval(int pInterval) Full index interval.
void	setIncrementalIndexInterval(int pInterval) Incremental index interval.
void	setIsPaused(boolean pPaused) Indicates whether to pause indexing until instructed to resume.
void	setPaths(IStringArray ppPaths) The target paths to be indexed.
void	setRecursive(boolean pRecursive) Indicates whether to recursively get the children of target path.
void	setReplaceIndex(boolean pReplaceIndex) Indicates whether to replace existing index.
void	setReplaceItems(boolean pReplaceItems) Indicates whether to replace existing items.
void	setSkipConnections(boolean pSkip) Indicates whether to skip connection files (sde, ags, wcs, wms, etc) copied to non-default locations.
void	setStartTime(String startTime) Index start time.
void	setWasRunning(boolean pRunning) Indicates whether the indexer was running when it was paused.

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

IndexingConfiguration

public IndexingConfiguration()
                      throws IOException,
                             UnknownHostException

Constructs a IndexingConfiguration using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

IndexingConfiguration

public IndexingConfiguration(Object obj)
                      throws IOException

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

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

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

getPaths

public IStringArray getPaths()
                      throws IOException,
                             AutomationException

The target paths to be indexed.

Specified by:

getPaths in interface IIndexingConfiguration

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.

setPaths

public void setPaths(IStringArray ppPaths)
              throws IOException,
                     AutomationException

The target paths to be indexed.

Specified by:

setPaths in interface IIndexingConfiguration

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public String getFilter()
                 throws IOException,
                        AutomationException

File extensions to be filtered out.

Specified by:

getFilter in interface IIndexingConfiguration

Returns:

The pFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilter

public void setFilter(String pFilter)
               throws IOException,
                      AutomationException

File extensions to be filtered out.

Specified by:

setFilter in interface IIndexingConfiguration

Parameters:

pFilter - The pFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRecursive

public boolean isRecursive()
                    throws IOException,
                           AutomationException

Indicates whether to recursively get the children of target path.

Specified by:

isRecursive in interface IIndexingConfiguration

Returns:

The pRecursive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecursive

public void setRecursive(boolean pRecursive)
                  throws IOException,
                         AutomationException

Indicates whether to recursively get the children of target path.

Specified by:

setRecursive in interface IIndexingConfiguration

Parameters:

pRecursive - The pRecursive (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReplaceIndex

public boolean isReplaceIndex()
                       throws IOException,
                              AutomationException

Indicates whether to replace existing index.

Specified by:

isReplaceIndex in interface IIndexingConfiguration

Returns:

The pReplaceIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplaceIndex

public void setReplaceIndex(boolean pReplaceIndex)
                     throws IOException,
                            AutomationException

Indicates whether to replace existing index.

Specified by:

setReplaceIndex in interface IIndexingConfiguration

Parameters:

pReplaceIndex - The pReplaceIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReplaceItems

public boolean isReplaceItems()
                       throws IOException,
                              AutomationException

Indicates whether to replace existing items.

Specified by:

isReplaceItems in interface IIndexingConfiguration

Returns:

The pReplaceItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplaceItems

public void setReplaceItems(boolean pReplaceItems)
                     throws IOException,
                            AutomationException

Indicates whether to replace existing items.

Specified by:

setReplaceItems in interface IIndexingConfiguration

Parameters:

pReplaceItems - The pReplaceItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncrementalIndexInterval

public int getIncrementalIndexInterval()
                                throws IOException,
                                       AutomationException

Incremental index interval.

Specified by:

getIncrementalIndexInterval in interface IIndexingConfiguration

Returns:

The pInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIncrementalIndexInterval

public void setIncrementalIndexInterval(int pInterval)
                                 throws IOException,
                                        AutomationException

Incremental index interval.

Specified by:

setIncrementalIndexInterval in interface IIndexingConfiguration

Parameters:

pInterval - The pInterval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullIndexInterval

public int getFullIndexInterval()
                         throws IOException,
                                AutomationException

Full index interval.

Specified by:

getFullIndexInterval in interface IIndexingConfiguration

Returns:

The pInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullIndexInterval

public void setFullIndexInterval(int pInterval)
                          throws IOException,
                                 AutomationException

Full index interval.

Specified by:

setFullIndexInterval in interface IIndexingConfiguration

Parameters:

pInterval - The pInterval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTime

public String getStartTime()
                    throws IOException,
                           AutomationException

Index start time.

Specified by:

getStartTime in interface IIndexingConfiguration

Returns:

The startTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTime

public void setStartTime(String startTime)
                  throws IOException,
                         AutomationException

Index start time.

Specified by:

setStartTime in interface IIndexingConfiguration

Parameters:

startTime - The startTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSkipConnections

public boolean isSkipConnections()
                          throws IOException,
                                 AutomationException

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

Specified by:

isSkipConnections in interface IIndexingConfiguration

Returns:

The pSkip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSkipConnections

public void setSkipConnections(boolean pSkip)
                        throws IOException,
                               AutomationException

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

Specified by:

setSkipConnections in interface IIndexingConfiguration

Parameters:

pSkip - The pSkip (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPaused

public boolean isPaused()
                 throws IOException,
                        AutomationException

Indicates whether to pause indexing until instructed to resume.

Specified by:

isPaused in interface IIndexingConfiguration

Returns:

The pPaused

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPaused

public void setIsPaused(boolean pPaused)
                 throws IOException,
                        AutomationException

Indicates whether to pause indexing until instructed to resume.

Specified by:

setIsPaused in interface IIndexingConfiguration

Parameters:

pPaused - The pPaused (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWasRunning

public boolean isWasRunning()
                     throws IOException,
                            AutomationException

Indicates whether the indexer was running when it was paused.

Specified by:

isWasRunning in interface IIndexingConfiguration

Returns:

The pRunning

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWasRunning

public void setWasRunning(boolean pRunning)
                   throws IOException,
                          AutomationException

Indicates whether the indexer was running when it was paused.

Specified by:

setWasRunning in interface IIndexingConfiguration

Parameters:

pRunning - The pRunning (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.