com.esri.arcgis.location
Class GPAddressLocatorStyle

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

All Implemented Interfaces:

IClone, IGPAddressLocatorStyle, IGPValue, IPersist, IPersistStream, IXMLSerialize, java.io.Serializable

public class GPAddressLocatorStyle

extends java.lang.Object

implements IGPAddressLocatorStyle, IGPValue, IClone, IPersistStream, IXMLSerialize

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(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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(java.lang.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.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGPAddressLocatorStyle	getAsIGPAddressLocatorStyle() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGPValue	getAsIGPValue() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IXMLSerialize	getAsIXMLSerialize() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IGPDataType	getDataType() Provides the data type of the value object.
java.lang.Object	getDefaultAliasFieldNames() Default field names for the place name alias table.
java.lang.Object	getDefaultFieldNames(int tableIndex, int fieldIndex) Default field names for the indicated reference data field.
java.lang.Object	getDefaultInputFieldNames(java.lang.String addressFieldName) Default field names for the indicated address field of an address locator created with this style.
IDETable	getMappedTable(java.lang.String refDataTable) Table mapped to the indicated reference data table.
IFields	getMatchFields() Fields output by an address locator created with this style.
java.lang.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.
java.lang.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) Supported Platforms
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
boolean	isEmpty() Indicates if the value object empty.
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isIdentical(IClone other) Returns TRUE when 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) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
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(java.lang.String text) Provides the value of the value object with the given string value.
void	setDefaultAliasFieldNames(java.lang.Object defaultAliasFieldNames) Default field names for the place name alias table.
void	setDefaultFieldNamesByRef(int tableIndex, int fieldIndex, java.lang.Object defaultNames) Default field names for the indicated reference data field.
void	setDefaultInputFieldNames(java.lang.String addressFieldName, java.lang.Object defaultNames) Default field names for the indicated address field of an address locator created with this style.
void	setMappedTableByRef(java.lang.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(java.lang.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, java.lang.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPAddressLocatorStyle

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

Constructs a GPAddressLocatorStyle using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPAddressLocatorStyle

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
GPAddressLocatorStyle theGPAddressLocatorStyle = (GPAddressLocatorStyle) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIGPAddressLocatorStyle

public IGPAddressLocatorStyle getAsIGPAddressLocatorStyle()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGPValue

public IGPValue getAsIGPValue()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIXMLSerialize

public IXMLSerialize getAsIXMLSerialize()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IGPAddressLocatorStyle

Name of the locator style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IGPAddressLocatorStyle

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IGPAddressLocatorStyle

Name of the locator style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IGPAddressLocatorStyle

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSimpleStandardizeFields

public IFields getSimpleStandardizeFields()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IGPAddressLocatorStyle

Fields needed to do address standardization.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSimpleStandardizeFields in interface IGPAddressLocatorStyle

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSimpleStandardizeFieldsByRef

public void setSimpleStandardizeFieldsByRef(IFields standardizeFields)
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IGPAddressLocatorStyle

Fields needed to do address standardization.

Specified by:

setSimpleStandardizeFieldsByRef in interface IGPAddressLocatorStyle

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAddressFields

public IFields getAddressFields()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IGPAddressLocatorStyle

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAddressFields in interface IGPAddressLocatorStyle

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAddressFieldsByRef

public void setAddressFieldsByRef(IFields addressFields)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IGPAddressLocatorStyle

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

Specified by:

setAddressFieldsByRef in interface IGPAddressLocatorStyle

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldNames

public java.lang.Object getDefaultInputFieldNames(java.lang.String addressFieldName)
                                           throws java.io.IOException,
                                                  AutomationException

Description copied from interface: IGPAddressLocatorStyle

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultInputFieldNames in interface IGPAddressLocatorStyle

Parameters:

addressFieldName - The addressFieldName (in)

Returns:

A Variant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDefaultInputFieldNames

public void setDefaultInputFieldNames(java.lang.String addressFieldName,
                                      java.lang.Object defaultNames)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IGPAddressLocatorStyle

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultInputFieldNames in interface IGPAddressLocatorStyle

Parameters:

addressFieldName - The addressFieldName (in)

defaultNames - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMatchFields

public IFields getMatchFields()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IGPAddressLocatorStyle

Fields output by an address locator created with this style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMatchFields in interface IGPAddressLocatorStyle

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMatchFieldsByRef

public void setMatchFieldsByRef(IFields matchFields)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IGPAddressLocatorStyle

Fields output by an address locator created with this style.

Specified by:

setMatchFieldsByRef in interface IGPAddressLocatorStyle

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReferenceDataTableCount

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

Description copied from interface: IGPAddressLocatorStyle

Number of reference data tables needed for the style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceDataTableCount in interface IGPAddressLocatorStyle

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReferenceDataTableCount

public void setReferenceDataTableCount(int count)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IGPAddressLocatorStyle

Number of reference data tables needed for the style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReferenceDataTableCount in interface IGPAddressLocatorStyle

Parameters:

count - The count (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getReferenceDataTableName

public java.lang.String getReferenceDataTableName(int index)
                                           throws java.io.IOException,
                                                  AutomationException

Description copied from interface: IGPAddressLocatorStyle

Display name of the indicated reference data table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceDataTableName in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReferenceDataTableName

public void setReferenceDataTableName(int index,
                                      java.lang.String name)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IGPAddressLocatorStyle

Display name of the indicated reference data table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReferenceDataTableName in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getReferenceDataFilters

public IArray getReferenceDataFilters(int index)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IGPAddressLocatorStyle

Filters for the indicated reference data table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceDataFilters in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getReferenceDataFilterUIDs

public IArray getReferenceDataFilterUIDs(int index)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IGPAddressLocatorStyle

Filters for the indicated reference data table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceDataFilterUIDs in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setReferenceDataFilterUIDsByRef

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

Description copied from interface: IGPAddressLocatorStyle

Filters for the indicated reference data table.

Specified by:

setReferenceDataFilterUIDsByRef in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReferenceDataFields

public IFields getReferenceDataFields(int index)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IGPAddressLocatorStyle

Reference data fields for the indicated reference data table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceDataFields in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setReferenceDataFieldsByRef

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

Description copied from interface: IGPAddressLocatorStyle

Reference data fields for the indicated reference data table.

Specified by:

setReferenceDataFieldsByRef in interface IGPAddressLocatorStyle

Parameters:

index - The index (in)

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDefaultFieldNames

public java.lang.Object getDefaultFieldNames(int tableIndex,
                                             int fieldIndex)
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IGPAddressLocatorStyle

Default field names for the indicated reference data field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultFieldNames in interface IGPAddressLocatorStyle

Parameters:

tableIndex - The tableIndex (in)

fieldIndex - The fieldIndex (in)

Returns:

A Variant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDefaultFieldNamesByRef

public void setDefaultFieldNamesByRef(int tableIndex,
                                      int fieldIndex,
                                      java.lang.Object defaultNames)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IGPAddressLocatorStyle

Default field names for the indicated reference data field.

Specified by:

setDefaultFieldNamesByRef in interface IGPAddressLocatorStyle

Parameters:

tableIndex - The tableIndex (in)

fieldIndex - The fieldIndex (in)

defaultNames - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMappedTable

public IDETable getMappedTable(java.lang.String refDataTable)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IGPAddressLocatorStyle

Table mapped to the indicated reference data table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMappedTable in interface IGPAddressLocatorStyle

Parameters:

refDataTable - The refDataTable (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMappedTableByRef

public void setMappedTableByRef(java.lang.String refDataTable,
                                IDETable table)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IGPAddressLocatorStyle

Table mapped to the indicated reference data table.

Specified by:

setMappedTableByRef in interface IGPAddressLocatorStyle

Parameters:

refDataTable - The refDataTable (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsPlaceNameAliasTable

public boolean isSupportsPlaceNameAliasTable()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IGPAddressLocatorStyle

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsPlaceNameAliasTable in interface IGPAddressLocatorStyle

Returns:

The supportsPNAT

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSupportsPlaceNameAliasTable

public void setSupportsPlaceNameAliasTable(boolean supportsPNAT)
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IGPAddressLocatorStyle

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSupportsPlaceNameAliasTable in interface IGPAddressLocatorStyle

Parameters:

supportsPNAT - The supportsPNAT (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultAliasFieldNames

public java.lang.Object getDefaultAliasFieldNames()
                                           throws java.io.IOException,
                                                  AutomationException

Description copied from interface: IGPAddressLocatorStyle

Default field names for the place name alias table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultAliasFieldNames in interface IGPAddressLocatorStyle

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultAliasFieldNames

public void setDefaultAliasFieldNames(java.lang.Object defaultAliasFieldNames)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IGPAddressLocatorStyle

Default field names for the place name alias table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultAliasFieldNames in interface IGPAddressLocatorStyle

Parameters:

defaultAliasFieldNames - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAliasTable

public IDETable getAliasTable()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IGPAddressLocatorStyle

Table mapped as the place name alias table.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAliasTable in interface IGPAddressLocatorStyle

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAliasTableByRef

public void setAliasTableByRef(IDETable aliasTable)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IGPAddressLocatorStyle

Table mapped as the place name alias table.

Specified by:

setAliasTableByRef in interface IGPAddressLocatorStyle

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDataType

public IGPDataType getDataType()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IGPValue

Provides the data type of the value object.

Remarks

The DataType property returns the DataType object associated with this Value object.

Specified by:

getDataType in interface IGPValue

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGPValue

Indicates if the value object empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

AutomationException - If the ArcObject component throws an exception.

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

empty

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

Description copied from interface: IGPValue

Clears the value object.

Remarks

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

Specified by:

empty in interface IGPValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsText

public java.lang.String getAsText()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IGPValue

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.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IGPValue

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

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IXMLSerialize

Serializes an object to XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IXMLSerialize

Deserializes an object from XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.