com.esri.arcgis.search
Class IndexingOptions

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IIndexingOptions, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class IndexingOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIndexingOptions, IXMLSerialize, IPersistStream, IPersist, Externalizable

Indexing Options object.

See Also:

Serialized Form

Constructor Summary

IndexingOptions()
Constructs a IndexingOptions using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getFullIndexInterval() Full index interval.
int	getIncrementalIndexInterval() Incremental index interval.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getStartTime() Index start time.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setFullIndexInterval(int pInterval) Full index interval.
void	setIncrementalIndexInterval(int pInterval) Incremental index interval.
void	setStartTime(String startTime) Index start time.
void	writeExternal(ObjectOutput out)

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

IndexingOptions

public IndexingOptions()
                throws IOException,
                       UnknownHostException

Constructs a IndexingOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

IndexingOptions

public IndexingOptions(Object obj)
                throws IOException

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

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

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

getIncrementalIndexInterval

public int getIncrementalIndexInterval()
                                throws IOException,
                                       AutomationException

Incremental index interval.

Specified by:

getIncrementalIndexInterval in interface IIndexingOptions

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 IIndexingOptions

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 IIndexingOptions

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 IIndexingOptions

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 IIndexingOptions

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 IIndexingOptions

Parameters:

startTime - The startTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException