com.esri.arcgis.geoprocessing
Interface IGpFieldMapObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

GpFieldMapObject

public interface IGpFieldMapObject
extends Serializable

Provides access to the properties of a Geoprocessing FieldMap object.

Product Availability

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

Method Summary

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

Method Detail

setFieldMapByRef

void setFieldMapByRef(IGPFieldMap ppFieldMap)
                      throws IOException,
                             AutomationException

The true FieldMap object

Product Availability

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

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

IGPFieldMap getFieldMap()
                        throws IOException,
                               AutomationException

The true FieldMap object

Product Availability

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

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

void setMergeRule(String rule)
                  throws IOException,
                         AutomationException

Merge rule for the sub-fields.

Product Availability

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

Parameters:

rule - The rule (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMergeRule

String getMergeRule()
                    throws IOException,
                           AutomationException

Merge rule for the sub-fields.

Product Availability

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

Returns:

The rule

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoinDelimiter

void setJoinDelimiter(String delimiter)
                      throws IOException,
                             AutomationException

Join delimiter for the sub-fields.

Product Availability

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

Parameters:

delimiter - The delimiter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinDelimiter

String getJoinDelimiter()
                        throws IOException,
                               AutomationException

Join delimiter for the sub-fields.

Product Availability

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

Returns:

The delimiter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputField

Object getOutputField()
                      throws IOException,
                             AutomationException

Get the properties field

Product Availability

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

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputField

void setOutputField(Object ppField)
                    throws IOException,
                           AutomationException

Get the properties field

Product Availability

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

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

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.

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

String getInputTableName(int index)
                         throws IOException,
                                AutomationException

Get a sub-field table.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pTable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputFieldName

String getInputFieldName(int index)
                         throws IOException,
                                AutomationException

Get a sub-field.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartTextPosition

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.

Parameters:

index - The index (in)

Returns:

The pStart

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTextPosition

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.

Parameters:

index - The index (in)

Returns:

The pEnd

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputFieldCount

int getInputFieldCount()
                       throws IOException,
                              AutomationException

Get the count of sub-fields.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Remove all sub-fields.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeInputField

void removeInputField(int index)
                      throws IOException,
                             AutomationException

Remove a given sub-field

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findInputFieldIndex

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.

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

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.

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

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.

Parameters:

index - The index (in)

end - The end (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.