com.esri.arcgis.editor
Interface IFieldMap

All Superinterfaces:

Serializable

All Known Implementing Classes:

IFieldMapProxy

public interface IFieldMap
extends Serializable

Provides access to members that control the behavior of the field mapping tools.

Remarks

A FieldMap contains a number source and target fields for use in attribute transfer.

To create a new FieldMap, instantiate a new FieldMap object then set its source and target feature class via the SourceClass and TargetClass properties. Next set each source and target pair via the SetFieldMap method.

Source/Target field pairs can be can be queried via the FieldMap property, which returns an IEnumFieldMap object containing the field pairs.

A source/target field pair can be removed from a FieldMap by using the DeleteFieldMap method. Only the source field is specified.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	deleteFieldMap(boolean sourceLayer, IField pField) Delete an individual field map (source or destination).
IEnumFieldMap	getFieldMap() Enum of field maps.
IObjectClass	getSourceClass() Source class (required) for field mapping.
IField	getSourceField(IField pTargetField) The source field for the provided target field.
IObjectClass	getTargetClass() Target class (required) for field mapping.
IField	getTargetField(IField pSourceField) The target field for the provided source field.
boolean	isEmpty() Indicates if any field mappings have been set.
void	setFieldMap(IField pSourceField, IField pTargetField) Establishes a field mapping between the source and target fields.
void	setSourceClassByRef(IObjectClass ppSourceTable) Source class (required) for field mapping.
void	setTargetClassByRef(IObjectClass ppTargetTable) Target class (required) for field mapping.

Method Detail

setSourceClassByRef

void setSourceClassByRef(IObjectClass ppSourceTable)
                         throws IOException,
                                AutomationException

Source class (required) for field mapping.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

ppSourceTable - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceClass

IObjectClass getSourceClass()
                            throws IOException,
                                   AutomationException

Source class (required) for field mapping.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetClassByRef

void setTargetClassByRef(IObjectClass ppTargetTable)
                         throws IOException,
                                AutomationException

Target class (required) for field mapping.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

ppTargetTable - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetClass

IObjectClass getTargetClass()
                            throws IOException,
                                   AutomationException

Target class (required) for field mapping.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldMap

void setFieldMap(IField pSourceField,
                 IField pTargetField)
                 throws IOException,
                        AutomationException

Establishes a field mapping between the source and target fields.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pSourceField - A reference to a com.esri.arcgis.geodatabase.IField (in)

pTargetField - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteFieldMap

void deleteFieldMap(boolean sourceLayer,
                    IField pField)
                    throws IOException,
                           AutomationException

Delete an individual field map (source or destination).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

sourceLayer - The sourceLayer (in)

pField - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldMap

IEnumFieldMap getFieldMap()
                          throws IOException,
                                 AutomationException

Enum of field maps.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.editor.IEnumFieldMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceField

IField getSourceField(IField pTargetField)
                      throws IOException,
                             AutomationException

The source field for the provided target field.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pTargetField - A reference to a com.esri.arcgis.geodatabase.IField (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetField

IField getTargetField(IField pSourceField)
                      throws IOException,
                             AutomationException

The target field for the provided source field.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pSourceField - A reference to a com.esri.arcgis.geodatabase.IField (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if any field mappings have been set.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pIsEmpty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.