com.esri.arcgis.geodatabase
Class TopologyRule

java.lang.Object
  com.esri.arcgis.geodatabase.TopologyRule

All Implemented Interfaces:

IRule, ITopologyRule, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class TopologyRule
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRule, ITopologyRule, IXMLSerialize, IClone, IPersistStream, Externalizable

Esri Topology Rule object.

Remarks

The TopologyRule class is used to define the permissible spatial relationships between features within a topology. Topology rules can be defined with a single feature class or between two feature classes. Topology rules can also be defined to the subtype level of a feature class. Topology rules have an origin and a destination feature class, either of which can be set to the subtype level. Depending on the type of topology rule that is implemented, the destination feature class properties may be irrelevant.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

TopologyRule()
Constructs a TopologyRule using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	errorShapeTypes(boolean[] multipoints, boolean[] polylines, boolean[] polygons) Indicates the shape types of errors for the topology rule.
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
int	getCategory() The name associated with the validation rule.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getDestinationClassID() Destination ClassID of the topology rule.
int	getDestinationSubtype() Destination subtype of the topology rule.
String	getGUID() GUID of the topology rule.
String	getHelpstring() The helpstring associated with the validation rule.
int	getID() The ID of the validation rule.
String	getName() Name of the topology rule.
int	getOriginClassID() Origin ClassID of the topology rule.
int	getOriginSubtype() Origin subtype of the topology rule.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getTopologyRuleType() Topology rule type of the topology rule.
int	getType() The type associated with the validation rule.
int	hashCode() the hashcode for this object
boolean	isAllDestinationSubtypes() Indicates if all destination subtypes are specified for the topology rule.
boolean	isAllOriginSubtypes() Indicates if all origin subtypes are specified for the topology rule.
boolean	isDestinationSubtypeSpecified() Indicates if a destination subtype has been specified.
void	isDirty() isDirty
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	isOriginSubtypeSpecified() Indicates if an origin subtype has been specified.
boolean	isTriggerErrorEvents() Indicates if error events are triggered for the topology rule.
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	setAllDestinationSubtypes(boolean allSubtypes) Indicates if all destination subtypes are specified for the topology rule.
void	setAllOriginSubtypes(boolean allSubtypes) Indicates if all origin subtypes are specified for the topology rule.
void	setCategory(int groupBitmap) The name associated with the validation rule.
void	setDestinationClassID(int classID) Destination ClassID of the topology rule.
void	setDestinationSubtype(int subType) Destination subtype of the topology rule.
void	setHelpstring(String helpstring) The helpstring associated with the validation rule.
void	setID(int iD) The ID of the validation rule.
void	setName(String name) Name of the topology rule.
void	setOriginClassID(int classID) Origin ClassID of the topology rule.
void	setOriginSubtype(int subType) Origin subtype of the topology rule.
void	setTopologyRuleType(int ruleType) Topology rule type of the topology rule.
void	setTriggerErrorEvents(boolean errorEvents) Indicates if error events are triggered for the topology rule.
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

TopologyRule

public TopologyRule()
             throws IOException,
                    UnknownHostException

Constructs a TopologyRule using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TopologyRule

public TopologyRule(Object obj)
             throws IOException

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

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

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

getCategory

public int getCategory()
                throws IOException,
                       AutomationException

The name associated with the validation rule.

Description

Category sets the name associated with the rule. Not currently used by any ArcGIS application.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IRule

Returns:

The groupBitmap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(int groupBitmap)
                 throws IOException,
                        AutomationException

The name associated with the validation rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCategory in interface IRule

Parameters:

groupBitmap - The groupBitmap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpstring

public String getHelpstring()
                     throws IOException,
                            AutomationException

The helpstring associated with the validation rule.

Description

Helpstring property sets the helpstring for the given rule. Not currently used by any ArcGIS application.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHelpstring in interface IRule

Returns:

The helpstring

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHelpstring

public void setHelpstring(String helpstring)
                   throws IOException,
                          AutomationException

The helpstring associated with the validation rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHelpstring in interface IRule

Parameters:

helpstring - The helpstring (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws IOException,
                 AutomationException

The ID of the validation rule.

Description

ID property returns the id for the given rule.

Remarks

This property will always return -1 for rules in geodatabases created in versions of ArcGIS later than 9.3.1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getID in interface IRule

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int iD)
           throws IOException,
                  AutomationException

The ID of the validation rule.

Description

ID property sets the id for the given rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setID in interface IRule

Parameters:

iD - The iD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type associated with the validation rule.

Description

Type property returns the esriRuleType enumeration type of the given rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IRule

Returns:

A com.esri.arcgis.geodatabase.esriRuleType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the topology rule.

Remarks

The Name property can be used to assign a user specified string to each rule. By default, the Name property is empty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ITopologyRule

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 topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ITopologyRule

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGUID

public String getGUID()
               throws IOException,
                      AutomationException

GUID of the topology rule.

Remarks

Each topology rule is uniquely identified by a GUID. It is assigned when the rule is added to the topology using ITopologyRuleContainer::AddRule. The GUID can be used to get the topology rule using ITopologyRuleContainer::RulebyGUID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGUID in interface ITopologyRule

Returns:

The gUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginClassID

public int getOriginClassID()
                     throws IOException,
                            AutomationException

Origin ClassID of the topology rule.

Remarks

The OriginClassID of the topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOriginClassID in interface ITopologyRule

Returns:

The classID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOriginClassID

public void setOriginClassID(int classID)
                      throws IOException,
                             AutomationException

Origin ClassID of the topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOriginClassID in interface ITopologyRule

Parameters:

classID - The classID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginSubtype

public int getOriginSubtype()
                     throws IOException,
                            AutomationException

Origin subtype of the topology rule.

Remarks

The origin subtype of the topology rule. If AllOriginSubtypes is set to True, the OriginSubtype is ignored. If OriginSubtype is set to -1, AllOriginSubtypes will return True. If the assigned value does not correspond to a valid subtype, and error will be raised when the rule is added to the Topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOriginSubtype in interface ITopologyRule

Returns:

The subType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOriginSubtype

public void setOriginSubtype(int subType)
                      throws IOException,
                             AutomationException

Origin subtype of the topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOriginSubtype in interface ITopologyRule

Parameters:

subType - The subType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationClassID

public int getDestinationClassID()
                          throws IOException,
                                 AutomationException

Destination ClassID of the topology rule.

Remarks

The DestinationClassID of the topology rule. If the topology rule is a single feature class type, the DestinationClassID does not need to be set, it will be equal to the OriginClassID by default. If DestinationClassID is specified, it will be ignored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDestinationClassID in interface ITopologyRule

Returns:

The classID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationClassID

public void setDestinationClassID(int classID)
                           throws IOException,
                                  AutomationException

Destination ClassID of the topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDestinationClassID in interface ITopologyRule

Parameters:

classID - The classID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationSubtype

public int getDestinationSubtype()
                          throws IOException,
                                 AutomationException

Destination subtype of the topology rule.

Remarks

The destination subtype of the topology rule. If AllDestinationSubtypes is set to True, the DestinationSubtype is ignored. If DestinationSubtype is set to -1, AllDestinationSubtypes will return True. If the assigned value does not correspond to a valid subtype, an error will be raised when the rule is added to the Topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDestinationSubtype in interface ITopologyRule

Returns:

The subType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDestinationSubtype

public void setDestinationSubtype(int subType)
                           throws IOException,
                                  AutomationException

Destination subtype of the topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDestinationSubtype in interface ITopologyRule

Parameters:

subType - The subType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopologyRuleType

public int getTopologyRuleType()
                        throws IOException,
                               AutomationException

Topology rule type of the topology rule.

Remarks

A value from the esriTopologyRuleType enumeration that represents the rule's type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTopologyRuleType in interface ITopologyRule

Returns:

A com.esri.arcgis.geodatabase.esriTopologyRuleType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTopologyRuleType

public void setTopologyRuleType(int ruleType)
                         throws IOException,
                                AutomationException

Topology rule type of the topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTopologyRuleType in interface ITopologyRule

Parameters:

ruleType - A com.esri.arcgis.geodatabase.esriTopologyRuleType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTriggerErrorEvents

public boolean isTriggerErrorEvents()
                             throws IOException,
                                    AutomationException

Indicates if error events are triggered for the topology rule.

Remarks

The TriggerErrorEvents property is not currently in use and is reserved for future use.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isTriggerErrorEvents in interface ITopologyRule

Returns:

The errorEvents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTriggerErrorEvents

public void setTriggerErrorEvents(boolean errorEvents)
                           throws IOException,
                                  AutomationException

Indicates if error events are triggered for the topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTriggerErrorEvents in interface ITopologyRule

Parameters:

errorEvents - The errorEvents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

errorShapeTypes

public void errorShapeTypes(boolean[] multipoints,
                            boolean[] polylines,
                            boolean[] polygons)
                     throws IOException,
                            AutomationException

Indicates the shape types of errors for the topology rule.

Remarks

The ErrorShapeTypes method returns the supported error geometries for the specific topology rule. Topology rules do not support multipoints, this parameter equates to points. Every topology rule supports the creation of point topology errors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

errorShapeTypes in interface ITopologyRule

Parameters:

multipoints - The multipoints (out: use single element array)

polylines - The polylines (out: use single element array)

polygons - The polygons (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllOriginSubtypes

public boolean isAllOriginSubtypes()
                            throws IOException,
                                   AutomationException

Indicates if all origin subtypes are specified for the topology rule.

Remarks

AllOriginSubtypes specifies if the rule applies to all subtypes in the origin feature class. By default AllOriginSubtypes is False and the OriginSubtype property is set to -1. If the origin class contains subtypes, and these values are not changed, adding the rule to a topology will fail.

AllOriginSubtypes is set to the opposite value of OriginSubtypeSpecified. If the topology rule is a single feature class type, AllOriginSubtypes is set to True once the rule is added to the Topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAllOriginSubtypes in interface ITopologyRule

Returns:

The allSubtypes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllOriginSubtypes

public void setAllOriginSubtypes(boolean allSubtypes)
                          throws IOException,
                                 AutomationException

Indicates if all origin subtypes are specified for the topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAllOriginSubtypes in interface ITopologyRule

Parameters:

allSubtypes - The allSubtypes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllDestinationSubtypes

public boolean isAllDestinationSubtypes()
                                 throws IOException,
                                        AutomationException

Indicates if all destination subtypes are specified for the topology rule.

Remarks

AllDestinationSubtypes specifies if the rule applies to all subtypes in the destination feature class. By default AllDestinationSubtypes is False and the DestinationSubtype property is set to -1. If the destination class contains subtypes, and these values are not changed, adding the rule to a topology will fail.

AllDestinationSubtypes is set to the opposite value of DestinationSubtypeSpecified. If the topology rule is a single feature class type, AllDestinationSubtypes is set to True once the rule is added to the Topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAllDestinationSubtypes in interface ITopologyRule

Returns:

The allSubtypes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllDestinationSubtypes

public void setAllDestinationSubtypes(boolean allSubtypes)
                               throws IOException,
                                      AutomationException

Indicates if all destination subtypes are specified for the topology rule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAllDestinationSubtypes in interface ITopologyRule

Parameters:

allSubtypes - The allSubtypes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOriginSubtypeSpecified

public boolean isOriginSubtypeSpecified()
                                 throws IOException,
                                        AutomationException

Indicates if an origin subtype has been specified.

Remarks

OriginSubtypeSpecified will return True whenever the rule has been specified at the subtype level with the use of ITopologyRule::OriginSubtype. OriginSubtypeSpecified is the opposite of AllOriginSubtypes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOriginSubtypeSpecified in interface ITopologyRule

Returns:

The subtypeSpecified

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDestinationSubtypeSpecified

public boolean isDestinationSubtypeSpecified()
                                      throws IOException,
                                             AutomationException

Indicates if a destination subtype has been specified.

Remarks

DestinationSubtypeSpecified will return True whenever the rule has been specified at the subtype level with the use of ITopologyRule::DestinationSubtype. DestinationSubtypeSpecified is the opposite of AllDestinationSubtypes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDestinationSubtypeSpecified in interface ITopologyRule

Returns:

The subtypeSpecified

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.

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.

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