com.esri.arcgis.geoprocessing
Class GpFieldMappingsObject

java.lang.Object
  com.esri.arcgis.geoprocessing.GpFieldMappingsObject

All Implemented Interfaces:

IGpFieldMappingsObject, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GpFieldMappingsObject
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGpFieldMappingsObject

COM Class 'GpFieldMappingsObject'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description '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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geoprocessing.IGpFieldMappingsObject

DISPID_1_GET_NAME, DISPID_1_PUTREF_NAME, DISPID_10_NAME, DISPID_11_NAME, DISPID_12_NAME, DISPID_13_NAME, DISPID_2_NAME, DISPID_3_GET_NAME, DISPID_3_PUT_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_6_NAME, DISPID_7_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IID3fdf95a7_b0d6_446a_be8b_f2d75e801da8, xxDummy

Constructor Summary

GpFieldMappingsObject()
Constructs a GpFieldMappingsObject using ArcGIS Engine.

GpFieldMappingsObject(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpFieldMappingsObject theGpFieldMappingsObject = (GpFieldMappingsObject) obj;

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
boolean	equals(java.lang.Object o) Compare this object with another
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
static java.lang.String	getClsid() getClsid.
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
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	hashCode() the hashcode for this object
void	loadFromString(java.lang.String valueText) Initialize the field map by text string
void	release() Release a GpFieldMappingsObject.
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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GpFieldMappingsObject

public GpFieldMappingsObject()
                      throws java.io.IOException,
                             java.net.UnknownHostException

Constructs a GpFieldMappingsObject using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GpFieldMappingsObject

public GpFieldMappingsObject(java.lang.Object obj)
                      throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpFieldMappingsObject theGpFieldMappingsObject = (GpFieldMappingsObject) obj;

Construct a GpFieldMappingsObject using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GpFieldMappingsObject.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GpFieldMappingsObject.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setFieldMappingByRef

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

The true FieldMapping object

Specified by:

setFieldMappingByRef in interface IGpFieldMappingsObject

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

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

The true FieldMapping object

Specified by:

getFieldMapping in interface IGpFieldMappingsObject

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

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

Add a table to the mapping object

Specified by:

addTable in interface IGpFieldMappingsObject

Parameters:

table - The table (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldValidationWorkspace

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

Set the workspace for the mapping object

Specified by:

setFieldValidationWorkspace in interface IGpFieldMappingsObject

Parameters:

workspace - The workspace (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldValidationWorkspace

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

Set the workspace for the mapping object

Specified by:

getFieldValidationWorkspace in interface IGpFieldMappingsObject

Returns:

The workspace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

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

Get the output fields of the mapping object

Specified by:

getFields in interface IGpFieldMappingsObject

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

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

Get the count of fieldmaps within the mapping object

Specified by:

getFieldCount in interface IGpFieldMappingsObject

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Remove fieldmaps from the mapping object

Specified by:

removeAll in interface IGpFieldMappingsObject

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addFieldMap

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

Add a fieldmap to the mapping object

Specified by:

addFieldMap in interface IGpFieldMappingsObject

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

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

Get a fieldmap from the mapping object

Specified by:

getFieldMap in interface IGpFieldMappingsObject

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

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

Replace a fieldmap within the mapping object

Specified by:

replaceFieldMap in interface IGpFieldMappingsObject

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

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

Remove a fieldmap from the mapping object

Specified by:

removeFieldMap in interface IGpFieldMappingsObject

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findFieldMapIndex

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

Find the index of a fieldmap

Specified by:

findFieldMapIndex in interface IGpFieldMappingsObject

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

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

Initialize the field map by text string

Specified by:

loadFromString in interface IGpFieldMappingsObject

Parameters:

valueText - The valueText (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exportToString

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

Get the string representation of the field mappings object

Specified by:

exportToString in interface IGpFieldMappingsObject

Returns:

The valueText

Throws:

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

AutomationException - If the ArcObject component throws an exception.