com.esri.arcgis.geoprocessing
Class GpFieldMappingsObject

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

All Implemented Interfaces:

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

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

Geoprocessing FieldMapping object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GpFieldMappingsObject()
Constructs a GpFieldMappingsObject using ArcGIS Engine.

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

Method Summary

void	addFieldMap(Object pFieldMap) Add a fieldmap to the mapping object
void	addTable(String table) Add a table to the mapping object
boolean	equals(Object o) Compare this object with another
String	exportToString() Get the string representation of the field mappings object
int	findFieldMapIndex(String fieldName) Find the index of a fieldmap
static String	getClsid() getClsid.
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
int	hashCode() the hashcode for this 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GpFieldMappingsObject

public GpFieldMappingsObject()
                      throws IOException,
                             UnknownHostException

Constructs a GpFieldMappingsObject using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GpFieldMappingsObject

public GpFieldMappingsObject(Object obj)
                      throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setFieldMappingByRef

public void setFieldMappingByRef(IGPFieldMapping ppFieldMapping)
                          throws IOException,
                                 AutomationException

The true FieldMapping object

Product Availability

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

Specified by:

setFieldMappingByRef in interface IGpFieldMappingsObject

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

public IGPFieldMapping getFieldMapping()
                                throws IOException,
                                       AutomationException

The true FieldMapping object

Product Availability

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

Specified by:

getFieldMapping in interface IGpFieldMappingsObject

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

public 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.

Specified by:

addTable in interface IGpFieldMappingsObject

Parameters:

table - The table (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldValidationWorkspace

public 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.

Specified by:

setFieldValidationWorkspace in interface IGpFieldMappingsObject

Parameters:

workspace - The workspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldValidationWorkspace

public String getFieldValidationWorkspace()
                                   throws IOException,
                                          AutomationException

Set the workspace for the mapping object

Product Availability

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

Specified by:

getFieldValidationWorkspace in interface IGpFieldMappingsObject

Returns:

The workspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

public Object getFields()
                 throws IOException,
                        AutomationException

Get the output fields of the mapping object

Product Availability

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

Specified by:

getFields in interface IGpFieldMappingsObject

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldCount

public 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.

Specified by:

getFieldCount in interface IGpFieldMappingsObject

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Remove fieldmaps from the mapping object

Product Availability

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

Specified by:

removeAll in interface IGpFieldMappingsObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFieldMap

public 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.

Specified by:

addFieldMap in interface IGpFieldMappingsObject

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

public 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.

Specified by:

getFieldMap in interface IGpFieldMappingsObject

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

public 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.

Specified by:

replaceFieldMap in interface IGpFieldMappingsObject

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

public 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.

Specified by:

removeFieldMap in interface IGpFieldMappingsObject

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFieldMapIndex

public int findFieldMapIndex(String fieldName)
                      throws IOException,
                             AutomationException

Find the index of a fieldmap

Product Availability

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

Specified by:

findFieldMapIndex in interface IGpFieldMappingsObject

Parameters:

fieldName - The fieldName (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromString

public 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.

Specified by:

loadFromString in interface IGpFieldMappingsObject

Parameters:

valueText - The valueText (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportToString

public 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.

Specified by:

exportToString in interface IGpFieldMappingsObject

Returns:

The valueText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.