com.esri.arcgis.carto
Interface IJoinTableSourceDescription

All Superinterfaces:
Serializable
All Known Implementing Classes:
JoinTableSourceDescription

public interface IJoinTableSourceDescription
extends Serializable

Provides access to the available properties of a Join Table Source Description object.

Product Availability

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


Method Summary
 int getJoinType()
          Type of join.
 IMapServerSourceDescription getLeftSourceDescription()
          Data Source for left table.
 String getLeftTableKey()
          Field name from the left table that will be used for join.
 IMapServerSourceDescription getRightSourceDescription()
          Data Source for right table.
 String getRightTableKey()
          Field name from the right table that will be used for join.
 void setJoinType(int pJoinType)
          Type of join.
 void setLeftSourceDescription(IMapServerSourceDescription ppLeftSourceDescription)
          Data Source for left table.
 void setLeftTableKey(String pLeftTableKey)
          Field name from the left table that will be used for join.
 void setRightSourceDescription(IMapServerSourceDescription ppRightSourceDescription)
          Data Source for right table.
 void setRightTableKey(String pRightTableKey)
          Field name from the right table that will be used for join.
 

Method Detail

getLeftSourceDescription

IMapServerSourceDescription getLeftSourceDescription()
                                                     throws IOException,
                                                            AutomationException
Data Source for left table.

Product Availability

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

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

setLeftSourceDescription

void setLeftSourceDescription(IMapServerSourceDescription ppLeftSourceDescription)
                              throws IOException,
                                     AutomationException
Data Source for left table.

Product Availability

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

Parameters:
ppLeftSourceDescription - A reference to a com.esri.arcgis.carto.IMapServerSourceDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRightSourceDescription

IMapServerSourceDescription getRightSourceDescription()
                                                      throws IOException,
                                                             AutomationException
Data Source for right table.

Product Availability

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

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

setRightSourceDescription

void setRightSourceDescription(IMapServerSourceDescription ppRightSourceDescription)
                               throws IOException,
                                      AutomationException
Data Source for right table.

Product Availability

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

Parameters:
ppRightSourceDescription - A reference to a com.esri.arcgis.carto.IMapServerSourceDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeftTableKey

String getLeftTableKey()
                       throws IOException,
                              AutomationException
Field name from the left table that will be used for join.

Remarks

Only name of indexed field can be specifiedl

Product Availability

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

Returns:
The pLeftTableKey
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeftTableKey

void setLeftTableKey(String pLeftTableKey)
                     throws IOException,
                            AutomationException
Field name from the left table that will be used for join.

Product Availability

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

Parameters:
pLeftTableKey - The pLeftTableKey (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRightTableKey

String getRightTableKey()
                        throws IOException,
                               AutomationException
Field name from the right table that will be used for join.

Remarks

Only name of indexed field can be specifiedl

Product Availability

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

Returns:
The pRightTableKey
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRightTableKey

void setRightTableKey(String pRightTableKey)
                      throws IOException,
                             AutomationException
Field name from the right table that will be used for join.

Product Availability

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

Parameters:
pRightTableKey - The pRightTableKey (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJoinType

int getJoinType()
                throws IOException,
                       AutomationException
Type of join.

Product Availability

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

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

setJoinType

void setJoinType(int pJoinType)
                 throws IOException,
                        AutomationException
Type of join.

Product Availability

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

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