com.esri.arcgis.editor
Interface IAttributeTransfer

All Superinterfaces:

Serializable

All Known Implementing Classes:

IAttributeTransferProxy

public interface IAttributeTransfer
extends Serializable

Provides access to members that control the behavior of the attribute transfer tools.

When To Use

Use this interface to perform an Attribute Transfer via the Transfer method. This method requires a fieldmap which can either be created programmatically or retrieved from the Attribute Transfer environment if set by the dialog on the Spatial Adjustment menu.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	deleteFieldMap(IFieldMap pFieldMap) Delete a field map.
IFieldMap	findFieldMap(IObjectClass pSourceTable, IObjectClass pTargetTable) Finds a stored field mapping.
void	getName(String[] pName) Name of the current attribute type.
void	setFieldMapByRef(IFieldMap rhs1) Adds a field map.
void	transfer(IFieldMap pFieldMap, IRow pSourceRow, IRow pTargetRow, boolean[] pSuccessful) Transfer attributes between rows based on the field map.

Method Detail

getName

void getName(String[] pName)
             throws IOException,
                    AutomationException

Name of the current attribute type.

Product Availability

Available with ArcGIS Desktop.

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldMapByRef

void setFieldMapByRef(IFieldMap rhs1)
                      throws IOException,
                             AutomationException

Adds a field map. This will overwrite any existing field map with the same pair of source and target object classes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - A reference to a com.esri.arcgis.editor.IFieldMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteFieldMap

void deleteFieldMap(IFieldMap pFieldMap)
                    throws IOException,
                           AutomationException

Delete a field map.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pFieldMap - A reference to a com.esri.arcgis.editor.IFieldMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFieldMap

IFieldMap findFieldMap(IObjectClass pSourceTable,
                       IObjectClass pTargetTable)
                       throws IOException,
                              AutomationException

Finds a stored field mapping. A field map with any source or target can be found by place a null for the argument.

Remarks

A layer feature class (IFeatureClass) is a type of IObjectClass and can be used for these required objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transfer

void transfer(IFieldMap pFieldMap,
              IRow pSourceRow,
              IRow pTargetRow,
              boolean[] pSuccessful)
              throws IOException,
                     AutomationException

Transfer attributes between rows based on the field map.

Remarks

Features (IFeature) are a type of IRow object and may be used for these required objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pFieldMap - A reference to a com.esri.arcgis.editor.IFieldMap (in)

pSourceRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pTargetRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pSuccessful - The pSuccessful (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.