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, java.io.Externalizable, java.io.Serializable

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

COM Class 'TopologyRule'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Esri Topology Rule object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabase.IRule

IID, IID236f4de4_4761_11d2_9932_0000f80372b4, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ITopologyRule

IID, IIDa53b59a5_2efc_41c4_9769_c0faa13e62e9, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

Constructors

Constructor and Description
TopologyRule() Constructs a TopologyRule using ArcGIS Engine.
TopologyRule(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TopologyRule theTopologyRule = (TopologyRule) obj;

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.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 java.lang.String	getClsid() getClsid.
int	getDestinationClassID() Destination ClassID of the topology rule.
int	getDestinationSubtype() Destination subtype of the topology rule.
java.lang.String	getGUID() GUID of the topology rule.
java.lang.String	getHelpstring() The helpstring associated with the validation rule.
int	getID() The ID of the validation rule.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.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(java.io.ObjectInput in)
void	release() Release this COM object reference
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(java.lang.String helpstring) The helpstring associated with the validation rule.
void	setID(int iD) The ID of the validation rule.
void	setName(java.lang.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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

TopologyRule

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

Constructs a TopologyRule using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TopologyRule

public TopologyRule(java.lang.Object obj)
             throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getCategory

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

The name associated with the validation rule.

Specified by:

getCategory in interface IRule

Returns:

The groupBitmap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(int groupBitmap)
                 throws java.io.IOException,
                        AutomationException

The name associated with the validation rule.

Specified by:

setCategory in interface IRule

Parameters:

groupBitmap - The groupBitmap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpstring

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

The helpstring associated with the validation rule.

Specified by:

getHelpstring in interface IRule

Returns:

The helpstring

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHelpstring

public void setHelpstring(java.lang.String helpstring)
                   throws java.io.IOException,
                          AutomationException

The helpstring associated with the validation rule.

Specified by:

setHelpstring in interface IRule

Parameters:

helpstring - The helpstring (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

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

The ID of the validation rule.

Specified by:

getID in interface IRule

Returns:

The iD

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int iD)
           throws java.io.IOException,
                  AutomationException

The ID of the validation rule.

Specified by:

setID in interface IRule

Parameters:

iD - The iD (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type associated with the validation rule.

Specified by:

getType in interface IRule

Returns:

A com.esri.arcgis.geodatabase.esriRuleType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Name of the topology rule.

Specified by:

getName in interface ITopologyRule

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

Name of the topology rule.

Specified by:

setName in interface ITopologyRule

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGUID

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

GUID of the topology rule.

Specified by:

getGUID in interface ITopologyRule

Returns:

The gUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOriginClassID

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

Origin ClassID of the topology rule.

Specified by:

getOriginClassID in interface ITopologyRule

Returns:

The classID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOriginClassID

public void setOriginClassID(int classID)
                      throws java.io.IOException,
                             AutomationException

Origin ClassID of the topology rule.

Specified by:

setOriginClassID in interface ITopologyRule

Parameters:

classID - The classID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOriginSubtype

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

Origin subtype of the topology rule.

Specified by:

getOriginSubtype in interface ITopologyRule

Returns:

The subType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOriginSubtype

public void setOriginSubtype(int subType)
                      throws java.io.IOException,
                             AutomationException

Origin subtype of the topology rule.

Specified by:

setOriginSubtype in interface ITopologyRule

Parameters:

subType - The subType (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestinationClassID

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

Destination ClassID of the topology rule.

Specified by:

getDestinationClassID in interface ITopologyRule

Returns:

The classID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDestinationClassID

public void setDestinationClassID(int classID)
                           throws java.io.IOException,
                                  AutomationException

Destination ClassID of the topology rule.

Specified by:

setDestinationClassID in interface ITopologyRule

Parameters:

classID - The classID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestinationSubtype

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

Destination subtype of the topology rule.

Specified by:

getDestinationSubtype in interface ITopologyRule

Returns:

The subType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDestinationSubtype

public void setDestinationSubtype(int subType)
                           throws java.io.IOException,
                                  AutomationException

Destination subtype of the topology rule.

Specified by:

setDestinationSubtype in interface ITopologyRule

Parameters:

subType - The subType (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTopologyRuleType

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

Topology rule type of the topology rule.

Specified by:

getTopologyRuleType in interface ITopologyRule

Returns:

A com.esri.arcgis.geodatabase.esriTopologyRuleType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTopologyRuleType

public void setTopologyRuleType(int ruleType)
                         throws java.io.IOException,
                                AutomationException

Topology rule type of the topology rule.

Specified by:

setTopologyRuleType in interface ITopologyRule

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTriggerErrorEvents

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

Indicates if error events are triggered for the topology rule.

Specified by:

isTriggerErrorEvents in interface ITopologyRule

Returns:

The errorEvents

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTriggerErrorEvents

public void setTriggerErrorEvents(boolean errorEvents)
                           throws java.io.IOException,
                                  AutomationException

Indicates if error events are triggered for the topology rule.

Specified by:

setTriggerErrorEvents in interface ITopologyRule

Parameters:

errorEvents - The errorEvents (in)

Throws:

java.io.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 java.io.IOException,
                            AutomationException

Indicates the shape types of errors for the topology rule.

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:

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

AutomationException - If the ArcObject component throws an exception.

isAllOriginSubtypes

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

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

Specified by:

isAllOriginSubtypes in interface ITopologyRule

Returns:

The allSubtypes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllOriginSubtypes

public void setAllOriginSubtypes(boolean allSubtypes)
                          throws java.io.IOException,
                                 AutomationException

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

Specified by:

setAllOriginSubtypes in interface ITopologyRule

Parameters:

allSubtypes - The allSubtypes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAllDestinationSubtypes

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

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

Specified by:

isAllDestinationSubtypes in interface ITopologyRule

Returns:

The allSubtypes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllDestinationSubtypes

public void setAllDestinationSubtypes(boolean allSubtypes)
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

setAllDestinationSubtypes in interface ITopologyRule

Parameters:

allSubtypes - The allSubtypes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOriginSubtypeSpecified

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

Indicates if an origin subtype has been specified.

Specified by:

isOriginSubtypeSpecified in interface ITopologyRule

Returns:

The subtypeSpecified

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDestinationSubtypeSpecified

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

Indicates if a destination subtype has been specified.

Specified by:

isDestinationSubtypeSpecified in interface ITopologyRule

Returns:

The subtypeSpecified

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

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

Serializes an object to XML.

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

Deserializes an object from XML.

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.

esri_clone

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

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

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

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

Indicates if 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:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

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

Indicates if 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:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException