com.esri.arcgis.geoprocessing
Class GpFieldMapObject

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

All Implemented Interfaces:

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

public class GpFieldMapObject
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGpFieldMapObject

Geoprocessing FieldMap object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GpFieldMapObject()
Constructs a GpFieldMapObject using ArcGIS Engine.

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

Method Summary

void	addInputField(String table, String field, Object pStartTextValue, Object pEndTextValue) Add a sub-field.
boolean	equals(Object o) Compare this object with another
int	findInputFieldIndex(String table, String field) Find a given sub-field
static String	getClsid() getClsid.
int	getEndTextPosition(int index) Get a sub-field end text position.
IGPFieldMap	getFieldMap() The true FieldMap object
int	getInputFieldCount() Get the count of sub-fields.
String	getInputFieldName(int index) Get a sub-field.
String	getInputTableName(int index) Get a sub-field table.
String	getJoinDelimiter() Join delimiter for the sub-fields.
String	getMergeRule() Merge rule for the sub-fields.
Object	getOutputField() Get the properties field
int	getStartTextPosition(int index) Get a sub-field start text position.
int	hashCode() the hashcode for this object
void	removeAll() Remove all sub-fields.
void	removeInputField(int index) Remove a given sub-field
void	setEndTextPosition(int index, int end) Set a sub-field end text position.
void	setFieldMapByRef(IGPFieldMap ppFieldMap) The true FieldMap object
void	setJoinDelimiter(String delimiter) Join delimiter for the sub-fields.
void	setMergeRule(String rule) Merge rule for the sub-fields.
void	setOutputField(Object ppField) Get the properties field
void	setStartTextPosition(int index, int start) Set a sub-field start text position.

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

GpFieldMapObject

public GpFieldMapObject()
                 throws IOException,
                        UnknownHostException

Constructs a GpFieldMapObject using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GpFieldMapObject

public GpFieldMapObject(Object obj)
                 throws IOException

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

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

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

setFieldMapByRef

public void setFieldMapByRef(IGPFieldMap ppFieldMap)
                      throws IOException,
                             AutomationException

The true FieldMap object

Product Availability

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

Specified by:

setFieldMapByRef in interface IGpFieldMapObject

Parameters:

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

getFieldMap

public IGPFieldMap getFieldMap()
                        throws IOException,
                               AutomationException

The true FieldMap object

Product Availability

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

Specified by:

getFieldMap in interface IGpFieldMapObject

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.

setMergeRule

public void setMergeRule(String rule)
                  throws IOException,
                         AutomationException

Merge rule for the sub-fields.

Product Availability

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

Specified by:

setMergeRule in interface IGpFieldMapObject

Parameters:

rule - The rule (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMergeRule

public String getMergeRule()
                    throws IOException,
                           AutomationException

Merge rule for the sub-fields.

Product Availability

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

Specified by:

getMergeRule in interface IGpFieldMapObject

Returns:

The rule

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoinDelimiter

public void setJoinDelimiter(String delimiter)
                      throws IOException,
                             AutomationException

Join delimiter for the sub-fields.

Product Availability

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

Specified by:

setJoinDelimiter in interface IGpFieldMapObject

Parameters:

delimiter - The delimiter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinDelimiter

public String getJoinDelimiter()
                        throws IOException,
                               AutomationException

Join delimiter for the sub-fields.

Product Availability

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

Specified by:

getJoinDelimiter in interface IGpFieldMapObject

Returns:

The delimiter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputField

public Object getOutputField()
                      throws IOException,
                             AutomationException

Get the properties field

Product Availability

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

Specified by:

getOutputField in interface IGpFieldMapObject

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputField

public void setOutputField(Object ppField)
                    throws IOException,
                           AutomationException

Get the properties field

Product Availability

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

Specified by:

setOutputField in interface IGpFieldMapObject

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addInputField

public void addInputField(String table,
                          String field,
                          Object pStartTextValue,
                          Object pEndTextValue)
                   throws IOException,
                          AutomationException

Add a sub-field.

Product Availability

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

Specified by:

addInputField in interface IGpFieldMapObject

Parameters:

table - The table (in)

field - The field (in)

pStartTextValue - A Variant (in, optional, pass null if not required)

pEndTextValue - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputTableName

public String getInputTableName(int index)
                         throws IOException,
                                AutomationException

Get a sub-field table.

Product Availability

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

Specified by:

getInputTableName in interface IGpFieldMapObject

Parameters:

index - The index (in)

Returns:

The pTable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputFieldName

public String getInputFieldName(int index)
                         throws IOException,
                                AutomationException

Get a sub-field.

Product Availability

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

Specified by:

getInputFieldName in interface IGpFieldMapObject

Parameters:

index - The index (in)

Returns:

The pField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTextPosition

public int getStartTextPosition(int index)
                         throws IOException,
                                AutomationException

Get a sub-field start text position.

Product Availability

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

Specified by:

getStartTextPosition in interface IGpFieldMapObject

Parameters:

index - The index (in)

Returns:

The pStart

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTextPosition

public int getEndTextPosition(int index)
                       throws IOException,
                              AutomationException

Get a sub-field end text position.

Product Availability

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

Specified by:

getEndTextPosition in interface IGpFieldMapObject

Parameters:

index - The index (in)

Returns:

The pEnd

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputFieldCount

public int getInputFieldCount()
                       throws IOException,
                              AutomationException

Get the count of sub-fields.

Product Availability

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

Specified by:

getInputFieldCount in interface IGpFieldMapObject

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 all sub-fields.

Product Availability

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

Specified by:

removeAll in interface IGpFieldMapObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeInputField

public void removeInputField(int index)
                      throws IOException,
                             AutomationException

Remove a given sub-field

Product Availability

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

Specified by:

removeInputField in interface IGpFieldMapObject

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findInputFieldIndex

public int findInputFieldIndex(String table,
                               String field)
                        throws IOException,
                               AutomationException

Find a given sub-field

Product Availability

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

Specified by:

findInputFieldIndex in interface IGpFieldMapObject

Parameters:

table - The table (in)

field - The field (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTextPosition

public void setStartTextPosition(int index,
                                 int start)
                          throws IOException,
                                 AutomationException

Set a sub-field start text position.

Product Availability

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

Specified by:

setStartTextPosition in interface IGpFieldMapObject

Parameters:

index - The index (in)

start - The start (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTextPosition

public void setEndTextPosition(int index,
                               int end)
                        throws IOException,
                               AutomationException

Set a sub-field end text position.

Product Availability

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

Specified by:

setEndTextPosition in interface IGpFieldMapObject

Parameters:

index - The index (in)

end - The end (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.