com.esri.arcgis.geoprocessing
Interface IGpFieldMapObject

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GpFieldMapObject, IGpFieldMapObjectProxy

public interface IGpFieldMapObject
extends java.io.Serializable

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

Description: 'Provides access to the properties of a 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 =

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_GET_NAME
static java.lang.String	DISPID_12_NAME
static java.lang.String	DISPID_13_NAME
static java.lang.String	DISPID_14_NAME
static java.lang.String	DISPID_15_NAME
static java.lang.String	DISPID_16_NAME
static java.lang.String	DISPID_2_GET_NAME
static java.lang.String	DISPID_2_PUT_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_3_PUT_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_5_PUT_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	IID7afa67b8_09f0_4d5c_ae19_f2b7b3c8a167
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addInputField(java.lang.String table, java.lang.String field, java.lang.Object pStartTextValue, java.lang.Object pEndTextValue) Add a sub-field.
int	findInputFieldIndex(java.lang.String table, java.lang.String field) Find a given sub-field
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.
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.
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.

Field Detail

IID7afa67b8_09f0_4d5c_ae19_f2b7b3c8a167

static final int IID7afa67b8_09f0_4d5c_ae19_f2b7b3c8a167

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_PUT_NAME

static final java.lang.String DISPID_2_PUT_NAME

See Also:

Constant Field Values

DISPID_2_GET_NAME

static final java.lang.String DISPID_2_GET_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_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_5_PUT_NAME

static final java.lang.String DISPID_5_PUT_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_GET_NAME

static final java.lang.String DISPID_11_GET_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

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME

See Also:

Constant Field Values

DISPID_15_NAME

static final java.lang.String DISPID_15_NAME

See Also:

Constant Field Values

DISPID_16_NAME

static final java.lang.String DISPID_16_NAME

See Also:

Constant Field Values

Method Detail

setFieldMapByRef

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

The true FieldMap object

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

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

The true FieldMap object

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

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

Merge rule for the sub-fields.

Parameters:

rule - The rule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMergeRule

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

Merge rule for the sub-fields.

Returns:

The rule

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJoinDelimiter

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

Join delimiter for the sub-fields.

Parameters:

delimiter - The delimiter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJoinDelimiter

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

Join delimiter for the sub-fields.

Returns:

The delimiter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputField

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

Get the properties field

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

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

Get the properties field

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

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.

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

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

Get a sub-field table.

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

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

Get a sub-field.

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

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

Get a sub-field start text position.

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

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

Get a sub-field end text position.

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

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

Get the count of sub-fields.

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeInputField

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

Remove a given sub-field

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findInputFieldIndex

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

Find a given sub-field

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

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

Set a sub-field start text position.

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

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

Set a sub-field end text position.

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.