com.esri.arcgis.geoprocessing
Interface IGpFieldMappingsObject

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GpFieldMappingsObject, IGpFieldMappingsObjectProxy

public interface IGpFieldMappingsObject
extends java.io.Serializable

COM Interface 'IGpFieldMappingsObject'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to the properties of a Geoprocessing FieldMapping object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	DISPID_1_GET_NAME
static java.lang.String	DISPID_1_PUTREF_NAME
static java.lang.String	DISPID_10_NAME
static java.lang.String	DISPID_11_NAME
static java.lang.String	DISPID_12_NAME
static java.lang.String	DISPID_13_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_3_PUT_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_6_NAME
static java.lang.String	DISPID_7_NAME
static java.lang.String	DISPID_8_NAME
static java.lang.String	DISPID_9_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID3fdf95a7_b0d6_446a_be8b_f2d75e801da8
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addFieldMap(java.lang.Object pFieldMap) Add a fieldmap to the mapping object
void	addTable(java.lang.String table) Add a table to the mapping object
java.lang.String	exportToString() Get the string representation of the field mappings object
int	findFieldMapIndex(java.lang.String fieldName) Find the index of a fieldmap
int	getFieldCount() Get the count of fieldmaps within the mapping object
java.lang.Object	getFieldMap(int index) Get a fieldmap from the mapping object
IGPFieldMapping	getFieldMapping() The true FieldMapping object
java.lang.Object	getFields() Get the output fields of the mapping object
java.lang.String	getFieldValidationWorkspace() Set the workspace for the mapping object
void	loadFromString(java.lang.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, java.lang.Object pFieldMap) Replace a fieldmap within the mapping object
void	setFieldMappingByRef(IGPFieldMapping ppFieldMapping) The true FieldMapping object
void	setFieldValidationWorkspace(java.lang.String workspace) Set the workspace for the mapping object

Field Detail

IID3fdf95a7_b0d6_446a_be8b_f2d75e801da8

static final int IID3fdf95a7_b0d6_446a_be8b_f2d75e801da8

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID_1_PUTREF_NAME

static final java.lang.String DISPID_1_PUTREF_NAME

See Also:

Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_PUT_NAME

static final java.lang.String DISPID_3_PUT_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_6_NAME

static final java.lang.String DISPID_6_NAME

See Also:

Constant Field Values

DISPID_7_NAME

static final java.lang.String DISPID_7_NAME

See Also:

Constant Field Values

DISPID_8_NAME

static final java.lang.String DISPID_8_NAME

See Also:

Constant Field Values

DISPID_9_NAME

static final java.lang.String DISPID_9_NAME

See Also:

Constant Field Values

DISPID_10_NAME

static final java.lang.String DISPID_10_NAME

See Also:

Constant Field Values

DISPID_11_NAME

static final java.lang.String DISPID_11_NAME

See Also:

Constant Field Values

DISPID_12_NAME

static final java.lang.String DISPID_12_NAME

See Also:

Constant Field Values

DISPID_13_NAME

static final java.lang.String DISPID_13_NAME

See Also:

Constant Field Values

Method Detail

setFieldMappingByRef

void setFieldMappingByRef(IGPFieldMapping ppFieldMapping)
                          throws java.io.IOException,
                                 AutomationException

The true FieldMapping object

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldMapping

IGPFieldMapping getFieldMapping()
                                throws java.io.IOException,
                                       AutomationException

The true FieldMapping object

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addTable

void addTable(java.lang.String table)
              throws java.io.IOException,
                     AutomationException

Add a table to the mapping object

Parameters:

table - The table (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldValidationWorkspace

void setFieldValidationWorkspace(java.lang.String workspace)
                                 throws java.io.IOException,
                                        AutomationException

Set the workspace for the mapping object

Parameters:

workspace - The workspace (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldValidationWorkspace

java.lang.String getFieldValidationWorkspace()
                                             throws java.io.IOException,
                                                    AutomationException

Set the workspace for the mapping object

Returns:

The workspace

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

java.lang.Object getFields()
                           throws java.io.IOException,
                                  AutomationException

Get the output fields of the mapping object

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldCount

int getFieldCount()
                  throws java.io.IOException,
                         AutomationException

Get the count of fieldmaps within the mapping object

Returns:

The pCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws java.io.IOException,
                      AutomationException

Remove fieldmaps from the mapping object

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFieldMap

void addFieldMap(java.lang.Object pFieldMap)
                 throws java.io.IOException,
                        AutomationException

Add a fieldmap to the mapping object

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldMap

java.lang.Object getFieldMap(int index)
                             throws java.io.IOException,
                                    AutomationException

Get a fieldmap from the mapping object

Parameters:

index - The index (in)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceFieldMap

void replaceFieldMap(int index,
                     java.lang.Object pFieldMap)
                     throws java.io.IOException,
                            AutomationException

Replace a fieldmap within the mapping object

Parameters:

index - The index (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFieldMap

void removeFieldMap(int index)
                    throws java.io.IOException,
                           AutomationException

Remove a fieldmap from the mapping object

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFieldMapIndex

int findFieldMapIndex(java.lang.String fieldName)
                      throws java.io.IOException,
                             AutomationException

Find the index of a fieldmap

Parameters:

fieldName - The fieldName (in)

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromString

void loadFromString(java.lang.String valueText)
                    throws java.io.IOException,
                           AutomationException

Initialize the field map by text string

Parameters:

valueText - The valueText (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportToString

java.lang.String exportToString()
                                throws java.io.IOException,
                                       AutomationException

Get the string representation of the field mappings object

Returns:

The valueText

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.