com.esri.arcgis.search
Class DataSourceConfiguration

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

All Implemented Interfaces:

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

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

DataSource Configuration object.

See Also:

Serialized Form

Constructor Summary

DataSourceConfiguration()
Constructs a DataSourceConfiguration using ArcGIS Engine.

DataSourceConfiguration(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DataSourceConfiguration theDataSourceConfiguration = (DataSourceConfiguration) 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.
String	getPath() Catalogpath of Data source.
int	getRepeatInterval() Repeat interval of indexing.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getStartTime() Indexing start time.
int	getType() Data source type.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isRecursive() Indicates whether it is revursive index.
boolean	isReplaceItems() Indicates whether it replaces existing index.
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	setPath(String path) Catalogpath of Data source.
void	setRecursive(boolean recursive) Indicates whether it is revursive index.
void	setRepeatInterval(int repeatInterval) Repeat interval of indexing.
void	setReplaceItems(boolean replaceItems) Indicates whether it replaces existing index.
void	setStartTime(String startTime) Indexing start time.
void	setType(int type) Data source type.
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

DataSourceConfiguration

public DataSourceConfiguration()
                        throws IOException,
                               UnknownHostException

Constructs a DataSourceConfiguration using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DataSourceConfiguration

public DataSourceConfiguration(Object obj)
                        throws IOException

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

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

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

getType

public int getType()
            throws IOException,
                   AutomationException

Data source type.

Specified by:

getType in interface IDataSourceConfiguration

Returns:

A com.esri.arcgis.search.esriDataSourceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int type)
             throws IOException,
                    AutomationException

Data source type.

Specified by:

setType in interface IDataSourceConfiguration

Parameters:

type - A com.esri.arcgis.search.esriDataSourceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException

Catalogpath of Data source.

Specified by:

getPath in interface IDataSourceConfiguration

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(String path)
             throws IOException,
                    AutomationException

Catalogpath of Data source.

Specified by:

setPath in interface IDataSourceConfiguration

Parameters:

path - The path (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 it is revursive index.

Specified by:

isRecursive in interface IDataSourceConfiguration

Returns:

The recursive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecursive

public void setRecursive(boolean recursive)
                  throws IOException,
                         AutomationException

Indicates whether it is revursive index.

Specified by:

setRecursive in interface IDataSourceConfiguration

Parameters:

recursive - The recursive (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 it replaces existing index.

Specified by:

isReplaceItems in interface IDataSourceConfiguration

Returns:

The replaceItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplaceItems

public void setReplaceItems(boolean replaceItems)
                     throws IOException,
                            AutomationException

Indicates whether it replaces existing index.

Specified by:

setReplaceItems in interface IDataSourceConfiguration

Parameters:

replaceItems - The replaceItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTime

public String getStartTime()
                    throws IOException,
                           AutomationException

Indexing start time.

Specified by:

getStartTime in interface IDataSourceConfiguration

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

Indexing start time.

Specified by:

setStartTime in interface IDataSourceConfiguration

Parameters:

startTime - The startTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRepeatInterval

public int getRepeatInterval()
                      throws IOException,
                             AutomationException

Repeat interval of indexing.

Specified by:

getRepeatInterval in interface IDataSourceConfiguration

Returns:

The repeatInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRepeatInterval

public void setRepeatInterval(int repeatInterval)
                       throws IOException,
                              AutomationException

Repeat interval of indexing.

Specified by:

setRepeatInterval in interface IDataSourceConfiguration

Parameters:

repeatInterval - The repeatInterval (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