com.esri.arcgis.geoprocessing
Interface IGPFieldMap

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPFieldMap

public interface IGPFieldMap
extends Serializable

Provides access to the sub field map object.

Product Availability

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

Method Summary

void	addInputField(IDETable table, IField field, int startPos, int endPos) Add an internal mapped field.
int	findInputField(IDETable table, String fieldName) Find an internal mapped field.
int	getCount() Get the count of mapped fields.
IField	getField(int index) Get an internal mapped field.
IFields	getFields() Get the mapped fields.
String	getJoinDelimiter() Get the join delimiter.
int	getMergeRule() Get the merge rule.
IField	getOutputField() Get the main field.
IDETable	getTable(int index) Get an internal mapped field table.
void	getTextPos(int index, int[] start, int[] end) Get the start and end text positions.
void	removeAll() Remove all of the mapped fields.
void	removeField(int index) Remove an internal mapped field.
void	setJoinDelimiter(String delimiter) Get the join delimiter.
void	setMergeRule(int rule) Get the merge rule.
void	setOutputFieldByRef(IField field) Get the main field.
void	setTextPos(int index, int start, int end) Set the start and end text positions.

Method Detail

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Remove all of the mapped 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.

getCount

int getCount()
             throws IOException,
                    AutomationException

Get the count of mapped fields.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

IFields getFields()
                  throws IOException,
                         AutomationException

Get the mapped fields.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputField

IField getOutputField()
                      throws IOException,
                             AutomationException

Get the main field.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputFieldByRef

void setOutputFieldByRef(IField field)
                         throws IOException,
                                AutomationException

Get the main field.

Product Availability

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

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMergeRule

int getMergeRule()
                 throws IOException,
                        AutomationException

Get the merge rule.

Product Availability

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

Returns:

A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMergeRule

void setMergeRule(int rule)
                  throws IOException,
                         AutomationException

Get the merge rule.

Product Availability

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

Parameters:

rule - A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinDelimiter

String getJoinDelimiter()
                        throws IOException,
                               AutomationException

Get the join delimiter.

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.

setJoinDelimiter

void setJoinDelimiter(String delimiter)
                      throws IOException,
                             AutomationException

Get the join delimiter.

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.

addInputField

void addInputField(IDETable table,
                   IField field,
                   int startPos,
                   int endPos)
                   throws IOException,
                          AutomationException

Add an internal mapped field.

Product Availability

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

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

startPos - The startPos (in)

endPos - The endPos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findInputField

int findInputField(IDETable table,
                   String fieldName)
                   throws IOException,
                          AutomationException

Find an internal mapped field.

Product Availability

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

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)

fieldName - The fieldName (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeField

void removeField(int index)
                 throws IOException,
                        AutomationException

Remove an internal mapped 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.

getField

IField getField(int index)
                throws IOException,
                       AutomationException

Get an internal mapped field.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

IDETable getTable(int index)
                  throws IOException,
                         AutomationException

Get an internal mapped field table.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IDETable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextPos

void getTextPos(int index,
                int[] start,
                int[] end)
                throws IOException,
                       AutomationException

Get the start and end text positions.

Product Availability

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

Parameters:

index - The index (in)

start - The start (out: use single element array)

end - The end (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextPos

void setTextPos(int index,
                int start,
                int end)
                throws IOException,
                       AutomationException

Set the start and end text positions.

Product Availability

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

Parameters:

index - The index (in)

start - The start (in)

end - The end (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.