com.esri.arcgis.geoprocessing
Interface IGPFieldMapping

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPFieldMapping

public interface IGPFieldMapping
extends Serializable

Provides access to the field map object.

Product Availability

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

Method Summary

void	addFieldMap(IGPFieldMap fieldMap) Add an internal field map.
int	findFieldMap(String fieldName) Add an internal field map.
int	getCount() Get the count of the internal field maps.
IGPFieldMap	getFieldMap(int index) Get a specific internal field map.
IFields	getFields() Get the mapped fields.
void	initialize(IArray dETables, IWorkspace workspace) Initializes the field map object using the field information from the given table/workspace.
void	removeAll() Remove all of the internal field maps.
void	removeFieldMap(int index) Remove an internal field map.
void	replaceFieldMap(int index, IGPFieldMap fieldMap) Replace a specific internal field map.

Method Detail

initialize

void initialize(IArray dETables,
                IWorkspace workspace)
                throws IOException,
                       AutomationException

Initializes the field map object using the field information from the given table/workspace.

Product Availability

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

Parameters:

dETables - A reference to a com.esri.arcgis.system.IArray (in)

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

IFields getFields()
                  throws IOException,
                         AutomationException

Get the mapped fields.

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.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Remove all of the internal field maps.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

Get the count of the internal field maps.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldMap

IGPFieldMap getFieldMap(int index)
                        throws IOException,
                               AutomationException

Get a specific internal field map.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPFieldMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceFieldMap

void replaceFieldMap(int index,
                     IGPFieldMap fieldMap)
                     throws IOException,
                            AutomationException

Replace a specific internal field map.

Product Availability

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

Parameters:

index - The index (in)

fieldMap - A reference to a com.esri.arcgis.geoprocessing.IGPFieldMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFieldMap

void addFieldMap(IGPFieldMap fieldMap)
                 throws IOException,
                        AutomationException

Add an internal field map.

Product Availability

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

Parameters:

fieldMap - A reference to a com.esri.arcgis.geoprocessing.IGPFieldMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFieldMap

int findFieldMap(String fieldName)
                 throws IOException,
                        AutomationException

Add an internal field map.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFieldMap

void removeFieldMap(int index)
                    throws IOException,
                           AutomationException

Remove an internal field map.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.