com.esri.arcgis.geoprocessing
Interface IGpFieldMappingsObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

GpFieldMappingsObject

public interface IGpFieldMappingsObject
extends Serializable

Provides access to the properties of a Geoprocessing FieldMapping object.

Product Availability

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

Method Summary

void	addFieldMap(Object pFieldMap) Add a fieldmap to the mapping object
void	addTable(String table) Add a table to the mapping object
String	exportToString() Get the string representation of the field mappings object
int	findFieldMapIndex(String fieldName) Find the index of a fieldmap
int	getFieldCount() Get the count of fieldmaps within the mapping object
Object	getFieldMap(int index) Get a fieldmap from the mapping object
IGPFieldMapping	getFieldMapping() The true FieldMapping object
Object	getFields() Get the output fields of the mapping object
String	getFieldValidationWorkspace() Set the workspace for the mapping object
void	loadFromString(String valueText) Initialize the field map by text string
void	removeAll() Remove fieldmaps from the mapping object
void	removeFieldMap(int index) Remove a fieldmap from the mapping object
void	replaceFieldMap(int index, Object pFieldMap) Replace a fieldmap within the mapping object
void	setFieldMappingByRef(IGPFieldMapping ppFieldMapping) The true FieldMapping object
void	setFieldValidationWorkspace(String workspace) Set the workspace for the mapping object

Method Detail

setFieldMappingByRef

void setFieldMappingByRef(IGPFieldMapping ppFieldMapping)
                          throws IOException,
                                 AutomationException

The true FieldMapping object

Product Availability

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

Parameters:

ppFieldMapping - A reference to a com.esri.arcgis.geoprocessing.IGPFieldMapping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldMapping

IGPFieldMapping getFieldMapping()
                                throws IOException,
                                       AutomationException

The true FieldMapping object

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addTable

void addTable(String table)
              throws IOException,
                     AutomationException

Add a table to the mapping object

Product Availability

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

Parameters:

table - The table (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldValidationWorkspace

void setFieldValidationWorkspace(String workspace)
                                 throws IOException,
                                        AutomationException

Set the workspace for the mapping object

Product Availability

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

Parameters:

workspace - The workspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldValidationWorkspace

String getFieldValidationWorkspace()
                                   throws IOException,
                                          AutomationException

Set the workspace for the mapping object

Product Availability

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

Returns:

The workspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

Object getFields()
                 throws IOException,
                        AutomationException

Get the output fields of the mapping object

Product Availability

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

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldCount

int getFieldCount()
                  throws IOException,
                         AutomationException

Get the count of fieldmaps within the mapping object

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Remove fieldmaps from the mapping object

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.

addFieldMap

void addFieldMap(Object pFieldMap)
                 throws IOException,
                        AutomationException

Add a fieldmap to the mapping object

Product Availability

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

Parameters:

pFieldMap - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldMap

Object getFieldMap(int index)
                   throws IOException,
                          AutomationException

Get a fieldmap from the mapping object

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceFieldMap

void replaceFieldMap(int index,
                     Object pFieldMap)
                     throws IOException,
                            AutomationException

Replace a fieldmap within the mapping object

Product Availability

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

Parameters:

index - The index (in)

pFieldMap - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFieldMap

void removeFieldMap(int index)
                    throws IOException,
                           AutomationException

Remove a fieldmap from the mapping object

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.

findFieldMapIndex

int findFieldMapIndex(String fieldName)
                      throws IOException,
                             AutomationException

Find the index of a fieldmap

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.

loadFromString

void loadFromString(String valueText)
                    throws IOException,
                           AutomationException

Initialize the field map by text string

Product Availability

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

Parameters:

valueText - The valueText (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportToString

String exportToString()
                      throws IOException,
                             AutomationException

Get the string representation of the field mappings object

Product Availability

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

Returns:

The valueText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.