com.esri.arcgis.geoprocessing
Interface IGPFieldMap

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPFieldMap, IGPFieldMapProxy

public interface IGPFieldMap
extends java.io.Serializable

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

Description: 'Provides access to the sub field map 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	IID Deprecated. Internal use only
static int	IID64dc7625_bb93_4cad_bbca_c4bf5e9f6807
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addInputField(IDETable table, IField field, int startPos, int endPos) Add an internal mapped field.
int	findInputField(IDETable table, java.lang.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.
java.lang.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(java.lang.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.

Field Detail

IID64dc7625_bb93_4cad_bbca_c4bf5e9f6807

static final int IID64dc7625_bb93_4cad_bbca_c4bf5e9f6807

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

Method Detail

removeAll

void removeAll()
               throws java.io.IOException,
                      AutomationException

Remove all of the mapped fields.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

Get the count of mapped fields.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

IFields getFields()
                  throws java.io.IOException,
                         AutomationException

Get the mapped fields.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputField

IField getOutputField()
                      throws java.io.IOException,
                             AutomationException

Get the main field.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputFieldByRef

void setOutputFieldByRef(IField field)
                         throws java.io.IOException,
                                AutomationException

Get the main field.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMergeRule

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

Get the merge rule.

Returns:

A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMergeRule

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

Get the merge rule.

Parameters:

rule - A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant (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

Get the join delimiter.

Returns:

The delimiter

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

Get the join delimiter.

Parameters:

delimiter - The delimiter (in)

Throws:

java.io.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 java.io.IOException,
                          AutomationException

Add an internal mapped field.

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:

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

AutomationException - If the ArcObject component throws an exception.

findInputField

int findInputField(IDETable table,
                   java.lang.String fieldName)
                   throws java.io.IOException,
                          AutomationException

Find an internal mapped field.

Parameters:

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

fieldName - The fieldName (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeField

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

Remove an internal mapped field.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getField

IField getField(int index)
                throws java.io.IOException,
                       AutomationException

Get an internal mapped field.

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTable

IDETable getTable(int index)
                  throws java.io.IOException,
                         AutomationException

Get an internal mapped field table.

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTextPos

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

Get the start and end text positions.

Parameters:

index - The index (in)

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextPos

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

Set the start and end text positions.

Parameters:

index - The index (in)

start - The start (in)

end - The end (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.