com.esri.arcgis.carto

Class RelateDescription

java.lang.Object

com.esri.arcgis.carto.RelateDescription

All Implemented Interfaces:

IRelateDescription, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class RelateDescription
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRelateDescription, IXMLSerialize, IXMLVersionSupport, IPersistStream, IPersist, java.io.Externalizable

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

Description 'A colcass that describes a relate for QueryRelatedRows.' 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.carto.IRelateDescription

IID, IIDbadfd2ed_2776_4b21_879a_b99b2ea582a6, 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.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, 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
RelateDescription() Constructs a RelateDescription using ArcGIS Engine.
RelateDescription(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RelateDescription theRelateDescription = (RelateDescription) obj;

Method Summary

Modifier and Type	Method and Description
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IGeometryResultOptions	getGeometryResultOptions() Indicates whether we need to modify Geometry.
IGeoTransformation	getGeoTransformation() Geo transformation required to transform the geometry if the requested GCS is different from the source.
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	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
ISpatialReference	getOutputSpatialReference() Spatial reference of the output geometry in the related records.
ITimeReference	getOutputTimeReference() Output time reference for the time fields.
java.lang.String	getRelatedTableDefinitionExpression() Definition expression of the related table for which related records are being requested.
java.lang.String	getRelatedTableFields() Table fields that need to be returned as a part of the relate results.
int	getRelationshipID() Relationship ID that uniquely idenentifies a relate to a table.
int	getResultFormat() Result format that indicates the type of content in the result.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isIncludeGeometry() Indicates whether we should include Geometry.
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	setGeometryResultOptionsByRef(IGeometryResultOptions geometryOptions) Indicates whether we need to modify Geometry.
void	setGeoTransformationByRef(IGeoTransformation geotransform) Geo transformation required to transform the geometry if the requested GCS is different from the source.
void	setIncludeGeometry(boolean includeGeometry) Indicates whether we should include Geometry.
void	setOutputSpatialReferenceByRef(ISpatialReference spatialReference) Spatial reference of the output geometry in the related records.
void	setOutputTimeReferenceByRef(ITimeReference timeReference) Output time reference for the time fields.
void	setRelatedTableDefinitionExpression(java.lang.String expression) Definition expression of the related table for which related records are being requested.
void	setRelatedTableFields(java.lang.String tableFields) Table fields that need to be returned as a part of the relate results.
void	setRelationshipID(int relationshipID) Relationship ID that uniquely idenentifies a relate to a table.
void	setResultFormat(int resultFormat) Result format that indicates the type of content in the result.
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

RelateDescription

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

Constructs a RelateDescription using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RelateDescription

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

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

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

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

getRelationshipID

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

Relationship ID that uniquely idenentifies a relate to a table.

Specified by:

getRelationshipID in interface IRelateDescription

Returns:

The relationshipID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelationshipID

public void setRelationshipID(int relationshipID)
                       throws java.io.IOException,
                              AutomationException

Relationship ID that uniquely idenentifies a relate to a table.

Specified by:

setRelationshipID in interface IRelateDescription

Parameters:

relationshipID - The relationshipID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelatedTableDefinitionExpression

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

Definition expression of the related table for which related records are being requested.

Specified by:

getRelatedTableDefinitionExpression in interface IRelateDescription

Returns:

The expression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelatedTableDefinitionExpression

public void setRelatedTableDefinitionExpression(java.lang.String expression)
                                         throws java.io.IOException,
                                                AutomationException

Definition expression of the related table for which related records are being requested.

Specified by:

setRelatedTableDefinitionExpression in interface IRelateDescription

Parameters:

expression - The expression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelatedTableFields

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

Table fields that need to be returned as a part of the relate results.

Specified by:

getRelatedTableFields in interface IRelateDescription

Returns:

The tableFields

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelatedTableFields

public void setRelatedTableFields(java.lang.String tableFields)
                           throws java.io.IOException,
                                  AutomationException

Table fields that need to be returned as a part of the relate results.

Specified by:

setRelatedTableFields in interface IRelateDescription

Parameters:

tableFields - The tableFields (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
                                    throws java.io.IOException,
                                           AutomationException

Spatial reference of the output geometry in the related records.

Specified by:

setOutputSpatialReferenceByRef in interface IRelateDescription

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException

Spatial reference of the output geometry in the related records.

Specified by:

getOutputSpatialReference in interface IRelateDescription

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeoTransformation

public IGeoTransformation getGeoTransformation()
                                        throws java.io.IOException,
                                               AutomationException

Geo transformation required to transform the geometry if the requested GCS is different from the source.

Specified by:

getGeoTransformation in interface IRelateDescription

Returns:

A reference to a com.esri.arcgis.geometry.IGeoTransformation

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeoTransformationByRef

public void setGeoTransformationByRef(IGeoTransformation geotransform)
                               throws java.io.IOException,
                                      AutomationException

Geo transformation required to transform the geometry if the requested GCS is different from the source.

Specified by:

setGeoTransformationByRef in interface IRelateDescription

Parameters:

geotransform - A reference to a com.esri.arcgis.geometry.IGeoTransformation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResultFormat

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

Result format that indicates the type of content in the result.

Specified by:

getResultFormat in interface IRelateDescription

Returns:

A com.esri.arcgis.carto.esriRelateResultFormat constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResultFormat

public void setResultFormat(int resultFormat)
                     throws java.io.IOException,
                            AutomationException

Result format that indicates the type of content in the result.

Specified by:

setResultFormat in interface IRelateDescription

Parameters:

resultFormat - A com.esri.arcgis.carto.esriRelateResultFormat constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIncludeGeometry

public void setIncludeGeometry(boolean includeGeometry)
                        throws java.io.IOException,
                               AutomationException

Indicates whether we should include Geometry.

Specified by:

setIncludeGeometry in interface IRelateDescription

Parameters:

includeGeometry - The includeGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIncludeGeometry

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

Indicates whether we should include Geometry.

Specified by:

isIncludeGeometry in interface IRelateDescription

Returns:

The includeGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryResultOptionsByRef

public void setGeometryResultOptionsByRef(IGeometryResultOptions geometryOptions)
                                   throws java.io.IOException,
                                          AutomationException

Indicates whether we need to modify Geometry.

Specified by:

setGeometryResultOptionsByRef in interface IRelateDescription

Parameters:

geometryOptions - A reference to a com.esri.arcgis.geodatabase.IGeometryResultOptions (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometryResultOptions

public IGeometryResultOptions getGeometryResultOptions()
                                                throws java.io.IOException,
                                                       AutomationException

Indicates whether we need to modify Geometry.

Specified by:

getGeometryResultOptions in interface IRelateDescription

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputTimeReferenceByRef

public void setOutputTimeReferenceByRef(ITimeReference timeReference)
                                 throws java.io.IOException,
                                        AutomationException

Output time reference for the time fields.

Specified by:

setOutputTimeReferenceByRef in interface IRelateDescription

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputTimeReference

public ITimeReference getOutputTimeReference()
                                      throws java.io.IOException,
                                             AutomationException

Output time reference for the time fields.

Specified by:

getOutputTimeReference in interface IRelateDescription

Returns:

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

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.

getMinNamespaceSupported

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

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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