com.esri.arcgis.carto
Interface IDisplayRelationshipClass

All Superinterfaces:
Serializable
All Known Implementing Classes:
CadAnnotationLayer, CadFeatureLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, RasterLayer, StandaloneTable

public interface IDisplayRelationshipClass
extends Serializable

Provides access to members that are used to set up joins.

Description

This interface is used to to manage joins on a layer.

Remarks

ArcMap provides two ways to associate data stored in tables with the features in the layer: joins and relates.

When you join a table to the layer’s attribute table, you append the fields from the table to the layer’s table. Joins can be used for one-to one or many-to-one relationships between a layer and a table.

Relating the layer’s table with another table defines a relationship between the two tables, but it doesn’t append the fields of the table to the layer’s table. Relates can be used for one-to-many or many-to-many relationships between a layer and a table.

Use IDisplayRelationshipClass to set up and manage joins between a layer and other tables. Use IRelationshipClassCollection and IRelationshipClassCollectionEdit to manage relates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void displayRelationshipClass(IRelationshipClass relClass, int joinType)
          Sets a join based on the specified relationship class and join type.
 int getJoinType()
          Join type for the most recent join performed.
 IRelationshipClass getRelationshipClass()
          Relationship class that defines how the tables are joined.
 

Method Detail

getJoinType

int getJoinType()
                throws IOException,
                       AutomationException
Join type for the most recent join performed.

Description

Indicates the type of the most recent join.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriJoinType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelationshipClass

IRelationshipClass getRelationshipClass()
                                        throws IOException,
                                               AutomationException
Relationship class that defines how the tables are joined.

Description

The relationship class that defines the tables that are joined.

Remarks

You can also use IFeatureLayerDefinition::RelationshipClass to get a reference to the relationship class that defines a layer join.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IRelationshipClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

displayRelationshipClass

void displayRelationshipClass(IRelationshipClass relClass,
                              int joinType)
                              throws IOException,
                                     AutomationException
Sets a join based on the specified relationship class and join type.

Description

RelClass can be either a file or memory based relationship class, but must be defined on the base feature class.

Remarks

This method internally initializes a RelQueryTable to perform a join. relClass can be can be either a predefined relationship class in a geodatabase or an in memory relationship class. For more information on relationship clases, see IRelationshipClass

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
relClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
joinType - A com.esri.arcgis.geodatabase.esriJoinType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.