com.esri.arcgis.carto
Interface IMapTableInfo

All Superinterfaces:

Serializable

All Known Subinterfaces:

IStandaloneTableInfo

All Known Implementing Classes:

MapLayerInfo, StandaloneTableInfo

public interface IMapTableInfo
extends Serializable

Provides access to the Table Info.

Product Availability

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

Method Summary

String	getDisplayField() Primary display field.
IFields	getFields() Array of attribute fields contained in the table.
int	getHTMLPopupType() Indicates if the layer has HTML popups enabled.
int	getID() The table ID.
String	getName() Descriptive name of the table.
String	getOIDFieldName() The name of the OID Field.
IRelateInfos	getRelateInfos() Array of relates associated to the table.
boolean	isHasAttachments() Indicates if the layer has attachments.
boolean	isHasSubtype() Indicates if the layer has Subtype.

Method Detail

getID

int getID()
          throws IOException,
                 AutomationException

The table ID. This is a unique ID among layers and tables, and is used to identify the table in a number of methods.

Product Availability

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

Returns:

The tableID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Descriptive name of the table.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

IFields getFields()
                  throws IOException,
                         AutomationException

Array of attribute fields contained in the table.

Remarks

Note: ObjectID field is always included even when the field is invisible in the source map document.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelateInfos

IRelateInfos getRelateInfos()
                            throws IOException,
                                   AutomationException

Array of relates associated to the table.

Remarks

In order for MapServer to advertise a relationship, both source and destination layer/standalone table must be added to the source map document. For example, Layer A is related to Table B in the GeoDatabase; Layer A is added to the map while Table B is not, in this scenario, MapServer will not publicize this relationship and therefore QueryRelatedRows function cannot be used to get related row(s) for feature from Layer A.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IRelateInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasAttachments

boolean isHasAttachments()
                         throws IOException,
                                AutomationException

Indicates if the layer has attachments.

Product Availability

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

Returns:

The hasAttachments

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHTMLPopupType

int getHTMLPopupType()
                     throws IOException,
                            AutomationException

Indicates if the layer has HTML popups enabled.

Remarks

StandaloneTable does not support HTMLPopup

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriServerHTMLPopupType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayField

String getDisplayField()
                       throws IOException,
                              AutomationException

Primary display field.

Remarks

When DisplayExpression is used in the source map document, MapServer returns the first field used in the expression.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

String getOIDFieldName()
                       throws IOException,
                              AutomationException

The name of the OID Field.

Product Availability

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

Returns:

The oIDFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasSubtype

boolean isHasSubtype()
                     throws IOException,
                            AutomationException

Indicates if the layer has Subtype.

Remarks

Note: in case when the subtype field name is invisible in the source map document, HasSubtype will return False even though the layer has Subtypes.

Product Availability

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

Returns:

The hasSubtype

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.