com.esri.arcgis.location
Class GPAddressLocatorStyle

java.lang.Object
  com.esri.arcgis.location.GPAddressLocatorStyle

All Implemented Interfaces:

IGPValue, com.esri.arcgis.interop.RemoteObjRef, IGPAddressLocatorStyle, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPAddressLocatorStyle
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPAddressLocatorStyle, IGPValue, IClone, IPersistStream, IXMLSerialize, Externalizable

The Address Locator Style Element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

GPAddressLocatorStyle()
Constructs a GPAddressLocatorStyle using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	empty() Clears the value object.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IFields	getAddressFields() Fields needed to do geocoding with an address locator created with this style.
IDETable	getAliasTable() Table mapped as the place name alias table.
String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getDefaultAliasFieldNames() Default field names for the place name alias table.
Object	getDefaultFieldNames(int tableIndex, int fieldIndex) Default field names for the indicated reference data field.
Object	getDefaultInputFieldNames(String addressFieldName) Default field names for the indicated address field of an address locator created with this style.
IDETable	getMappedTable(String refDataTable) Table mapped to the indicated reference data table.
IFields	getMatchFields() Fields output by an address locator created with this style.
String	getName() Name of the locator style.
IFields	getReferenceDataFields(int index) Reference data fields for the indicated reference data table.
IArray	getReferenceDataFilters(int index) Filters for the indicated reference data table.
IArray	getReferenceDataFilterUIDs(int index) Filters for the indicated reference data table.
int	getReferenceDataTableCount() Number of reference data tables needed for the style.
String	getReferenceDataTableName(int index) Display name of the indicated reference data table.
IFields	getSimpleStandardizeFields() Fields needed to do address standardization.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
void	isDirty() isDirty
boolean	isEmpty() Indicates if the value object is empty.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isSupportsPlaceNameAliasTable() Indicates if the locator style supports a place name alias table.
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	setAddressFieldsByRef(IFields addressFields) Fields needed to do geocoding with an address locator created with this style.
void	setAliasTableByRef(IDETable aliasTable) Table mapped as the place name alias table.
IGPMessage	setAsText(String text) Provides the value of the value object with the given string value.
void	setDefaultAliasFieldNames(Object defaultAliasFieldNames) Default field names for the place name alias table.
void	setDefaultFieldNamesByRef(int tableIndex, int fieldIndex, Object defaultNames) Default field names for the indicated reference data field.
void	setDefaultInputFieldNames(String addressFieldName, Object defaultNames) Default field names for the indicated address field of an address locator created with this style.
void	setMappedTableByRef(String refDataTable, IDETable table) Table mapped to the indicated reference data table.
void	setMatchFieldsByRef(IFields matchFields) Fields output by an address locator created with this style.
void	setName(String name) Name of the locator style.
void	setReferenceDataFieldsByRef(int index, IFields fields) Reference data fields for the indicated reference data table.
void	setReferenceDataFilterUIDsByRef(int index, IArray filters) Filters for the indicated reference data table.
void	setReferenceDataTableCount(int count) Number of reference data tables needed for the style.
void	setReferenceDataTableName(int index, String name) Display name of the indicated reference data table.
void	setSimpleStandardizeFieldsByRef(IFields standardizeFields) Fields needed to do address standardization.
void	setSupportsPlaceNameAliasTable(boolean supportsPNAT) Indicates if the locator style supports a place name alias table.
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

GPAddressLocatorStyle

public GPAddressLocatorStyle()
                      throws IOException,
                             UnknownHostException

Constructs a GPAddressLocatorStyle using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPAddressLocatorStyle

public GPAddressLocatorStyle(Object obj)
                      throws IOException

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

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

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

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the locator style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IGPAddressLocatorStyle

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the locator style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IGPAddressLocatorStyle

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSimpleStandardizeFields

public IFields getSimpleStandardizeFields()
                                   throws IOException,
                                          AutomationException

Fields needed to do address standardization.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSimpleStandardizeFields in interface IGPAddressLocatorStyle

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSimpleStandardizeFieldsByRef

public void setSimpleStandardizeFieldsByRef(IFields standardizeFields)
                                     throws IOException,
                                            AutomationException

Fields needed to do address standardization.

Product Availability

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

Specified by:

setSimpleStandardizeFieldsByRef in interface IGPAddressLocatorStyle

Parameters:

standardizeFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddressFields

public IFields getAddressFields()
                         throws IOException,
                                AutomationException

Fields needed to do geocoding with an address locator created with this style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAddressFields in interface IGPAddressLocatorStyle

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddressFieldsByRef

public void setAddressFieldsByRef(IFields addressFields)
                           throws IOException,
                                  AutomationException

Fields needed to do geocoding with an address locator created with this style.

Product Availability

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

Specified by:

setAddressFieldsByRef in interface IGPAddressLocatorStyle

Parameters:

addressFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldNames

public Object getDefaultInputFieldNames(String addressFieldName)
                                 throws IOException,
                                        AutomationException

Default field names for the indicated address field of an address locator created with this style.

Product Availability

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

Specified by:

getDefaultInputFieldNames in interface IGPAddressLocatorStyle

Parameters:

addressFieldName - The addressFieldName (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultInputFieldNames

public void setDefaultInputFieldNames(String addressFieldName,
                                      Object defaultNames)
                               throws IOException,
                                      AutomationException

Default field names for the indicated address field of an address locator created with this style.

Product Availability

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

Specified by:

setDefaultInputFieldNames in interface IGPAddressLocatorStyle

Parameters:

addressFieldName - The addressFieldName (in)

defaultNames - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMatchFields

public IFields getMatchFields()
                       throws IOException,
                              AutomationException

Fields output by an address locator created with this style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMatchFields in interface IGPAddressLocatorStyle

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMatchFieldsByRef

public void setMatchFieldsByRef(IFields matchFields)
                         throws IOException,
                                AutomationException

Fields output by an address locator created with this style.

Product Availability

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

Specified by:

setMatchFieldsByRef in interface IGPAddressLocatorStyle

Parameters:

matchFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDataTableCount

public int getReferenceDataTableCount()
                               throws IOException,
                                      AutomationException

Number of reference data tables needed for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceDataTableCount in interface IGPAddressLocatorStyle

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceDataTableCount

public void setReferenceDataTableCount(int count)
                                throws IOException,
                                       AutomationException

Number of reference data tables needed for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReferenceDataTableCount in interface IGPAddressLocatorStyle

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDataTableName

public String getReferenceDataTableName(int index)
                                 throws IOException,
                                        AutomationException

Display name of the indicated reference data table.

Product Availability

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

Specified by:

getReferenceDataTableName in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceDataTableName

public void setReferenceDataTableName(int index,
                                      String name)
                               throws IOException,
                                      AutomationException

Display name of the indicated reference data table.

Product Availability

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

Specified by:

setReferenceDataTableName in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDataFilters

public IArray getReferenceDataFilters(int index)
                               throws IOException,
                                      AutomationException

Filters for the indicated reference data table.

Product Availability

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

Specified by:

getReferenceDataFilters in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDataFilterUIDs

public IArray getReferenceDataFilterUIDs(int index)
                                  throws IOException,
                                         AutomationException

Filters for the indicated reference data table.

Product Availability

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

Specified by:

getReferenceDataFilterUIDs in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceDataFilterUIDsByRef

public void setReferenceDataFilterUIDsByRef(int index,
                                            IArray filters)
                                     throws IOException,
                                            AutomationException

Filters for the indicated reference data table.

Product Availability

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

Specified by:

setReferenceDataFilterUIDsByRef in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

filters - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDataFields

public IFields getReferenceDataFields(int index)
                               throws IOException,
                                      AutomationException

Reference data fields for the indicated reference data table.

Product Availability

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

Specified by:

getReferenceDataFields in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceDataFieldsByRef

public void setReferenceDataFieldsByRef(int index,
                                        IFields fields)
                                 throws IOException,
                                        AutomationException

Reference data fields for the indicated reference data table.

Product Availability

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

Specified by:

setReferenceDataFieldsByRef in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultFieldNames

public Object getDefaultFieldNames(int tableIndex,
                                   int fieldIndex)
                            throws IOException,
                                   AutomationException

Default field names for the indicated reference data field.

Product Availability

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

Specified by:

getDefaultFieldNames in interface IGPAddressLocatorStyle

Parameters:

tableIndex - The tableIndex (in)

fieldIndex - The fieldIndex (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultFieldNamesByRef

public void setDefaultFieldNamesByRef(int tableIndex,
                                      int fieldIndex,
                                      Object defaultNames)
                               throws IOException,
                                      AutomationException

Default field names for the indicated reference data field.

Product Availability

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

Specified by:

setDefaultFieldNamesByRef in interface IGPAddressLocatorStyle

Parameters:

tableIndex - The tableIndex (in)

fieldIndex - The fieldIndex (in)

defaultNames - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMappedTable

public IDETable getMappedTable(String refDataTable)
                        throws IOException,
                               AutomationException

Table mapped to the indicated reference data table.

Product Availability

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

Specified by:

getMappedTable in interface IGPAddressLocatorStyle

Parameters:

refDataTable - The refDataTable (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IDETable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMappedTableByRef

public void setMappedTableByRef(String refDataTable,
                                IDETable table)
                         throws IOException,
                                AutomationException

Table mapped to the indicated reference data table.

Product Availability

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

Specified by:

setMappedTableByRef in interface IGPAddressLocatorStyle

Parameters:

refDataTable - The refDataTable (in)

table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsPlaceNameAliasTable

public boolean isSupportsPlaceNameAliasTable()
                                      throws IOException,
                                             AutomationException

Indicates if the locator style supports a place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsPlaceNameAliasTable in interface IGPAddressLocatorStyle

Returns:

The supportsPNAT

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsPlaceNameAliasTable

public void setSupportsPlaceNameAliasTable(boolean supportsPNAT)
                                    throws IOException,
                                           AutomationException

Indicates if the locator style supports a place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSupportsPlaceNameAliasTable in interface IGPAddressLocatorStyle

Parameters:

supportsPNAT - The supportsPNAT (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultAliasFieldNames

public Object getDefaultAliasFieldNames()
                                 throws IOException,
                                        AutomationException

Default field names for the place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultAliasFieldNames in interface IGPAddressLocatorStyle

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultAliasFieldNames

public void setDefaultAliasFieldNames(Object defaultAliasFieldNames)
                               throws IOException,
                                      AutomationException

Default field names for the place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultAliasFieldNames in interface IGPAddressLocatorStyle

Parameters:

defaultAliasFieldNames - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAliasTable

public IDETable getAliasTable()
                       throws IOException,
                              AutomationException

Table mapped as the place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAliasTable in interface IGPAddressLocatorStyle

Returns:

A reference to a com.esri.arcgis.geodatabase.IDETable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAliasTableByRef

public void setAliasTableByRef(IDETable aliasTable)
                        throws IOException,
                               AutomationException

Table mapped as the place name alias table.

Product Availability

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

Specified by:

setAliasTableByRef in interface IGPAddressLocatorStyle

Parameters:

aliasTable - A reference to a com.esri.arcgis.geodatabase.IDETable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws IOException,
                                        AutomationException

The data type of the value object.

Product Availability

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

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPDataType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

Specified by:

empty in interface IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException

Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

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.

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