com.esri.arcgis.geoprocessing
Class GpFieldMapObject

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

All Implemented Interfaces:

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

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

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

Description 'Geoprocessing FieldMap 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.IGpFieldMapObject

DISPID_1_GET_NAME, DISPID_1_PUTREF_NAME, DISPID_10_NAME, DISPID_11_GET_NAME, DISPID_12_NAME, DISPID_13_NAME, DISPID_14_NAME, DISPID_15_NAME, DISPID_16_NAME, DISPID_2_GET_NAME, DISPID_2_PUT_NAME, DISPID_3_GET_NAME, DISPID_3_PUT_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_6_NAME, DISPID_7_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IID7afa67b8_09f0_4d5c_ae19_f2b7b3c8a167, xxDummy

Constructor Summary

GpFieldMapObject()
Constructs a GpFieldMapObject using ArcGIS Engine.

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

Method Summary

void	addInputField(java.lang.String table, java.lang.String field, java.lang.Object pStartTextValue, java.lang.Object pEndTextValue) Add a sub-field.
boolean	equals(java.lang.Object o) Compare this object with another
int	findInputFieldIndex(java.lang.String table, java.lang.String field) Find a given sub-field
static java.lang.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.
java.lang.String	getInputFieldName(int index) Get a sub-field.
java.lang.String	getInputTableName(int index) Get a sub-field table.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getJoinDelimiter() Join delimiter for the sub-fields.
java.lang.String	getMergeRule() Merge rule for the sub-fields.
java.lang.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	release() Release a GpFieldMapObject.
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(java.lang.String delimiter) Join delimiter for the sub-fields.
void	setMergeRule(java.lang.String rule) Merge rule for the sub-fields.
void	setOutputField(java.lang.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

Constructor Detail

GpFieldMapObject

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

Constructs a GpFieldMapObject using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GpFieldMapObject

public GpFieldMapObject(java.lang.Object obj)
                 throws java.io.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:

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

Specified by:

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

setFieldMapByRef

public void setFieldMapByRef(IGPFieldMap ppFieldMap)
                      throws java.io.IOException,
                             AutomationException

The true FieldMap object

Specified by:

setFieldMapByRef in interface IGpFieldMapObject

Parameters:

ppFieldMap - A reference to a com.esri.arcgis.geoprocessing.IGPFieldMap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldMap

public IGPFieldMap getFieldMap()
                        throws java.io.IOException,
                               AutomationException

The true FieldMap object

Specified by:

getFieldMap in interface IGpFieldMapObject

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMergeRule

public void setMergeRule(java.lang.String rule)
                  throws java.io.IOException,
                         AutomationException

Merge rule for the sub-fields.

Specified by:

setMergeRule in interface IGpFieldMapObject

Parameters:

rule - The rule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMergeRule

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

Merge rule for the sub-fields.

Specified by:

getMergeRule in interface IGpFieldMapObject

Returns:

The rule

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJoinDelimiter

public void setJoinDelimiter(java.lang.String delimiter)
                      throws java.io.IOException,
                             AutomationException

Join delimiter for the sub-fields.

Specified by:

setJoinDelimiter in interface IGpFieldMapObject

Parameters:

delimiter - The delimiter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJoinDelimiter

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

Join delimiter for the sub-fields.

Specified by:

getJoinDelimiter in interface IGpFieldMapObject

Returns:

The delimiter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputField

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

Get the properties field

Specified by:

getOutputField in interface IGpFieldMapObject

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.

setOutputField

public void setOutputField(java.lang.Object ppField)
                    throws java.io.IOException,
                           AutomationException

Get the properties field

Specified by:

setOutputField in interface IGpFieldMapObject

Parameters:

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

addInputField

public void addInputField(java.lang.String table,
                          java.lang.String field,
                          java.lang.Object pStartTextValue,
                          java.lang.Object pEndTextValue)
                   throws java.io.IOException,
                          AutomationException

Add a sub-field.

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:

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

AutomationException - If the ArcObject component throws an exception.

getInputTableName

public java.lang.String getInputTableName(int index)
                                   throws java.io.IOException,
                                          AutomationException

Get a sub-field table.

Specified by:

getInputTableName in interface IGpFieldMapObject

Parameters:

index - The index (in)

Returns:

The pTable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInputFieldName

public java.lang.String getInputFieldName(int index)
                                   throws java.io.IOException,
                                          AutomationException

Get a sub-field.

Specified by:

getInputFieldName in interface IGpFieldMapObject

Parameters:

index - The index (in)

Returns:

The pField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStartTextPosition

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

Get a sub-field start text position.

Specified by:

getStartTextPosition in interface IGpFieldMapObject

Parameters:

index - The index (in)

Returns:

The pStart

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEndTextPosition

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

Get a sub-field end text position.

Specified by:

getEndTextPosition in interface IGpFieldMapObject

Parameters:

index - The index (in)

Returns:

The pEnd

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInputFieldCount

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

Get the count of sub-fields.

Specified by:

getInputFieldCount in interface IGpFieldMapObject

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

Specified by:

removeAll in interface IGpFieldMapObject

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeInputField

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

Remove a given sub-field

Specified by:

removeInputField in interface IGpFieldMapObject

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findInputFieldIndex

public int findInputFieldIndex(java.lang.String table,
                               java.lang.String field)
                        throws java.io.IOException,
                               AutomationException

Find a given sub-field

Specified by:

findInputFieldIndex in interface IGpFieldMapObject

Parameters:

table - The table (in)

field - The field (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartTextPosition

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

Set a sub-field start text position.

Specified by:

setStartTextPosition in interface IGpFieldMapObject

Parameters:

index - The index (in)

start - The start (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEndTextPosition

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

Set a sub-field end text position.

Specified by:

setEndTextPosition in interface IGpFieldMapObject

Parameters:

index - The index (in)

end - The end (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.