com.esri.arcgis.geoprocessing
Interface IGPFieldInfo

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPFieldInfo, IGPFieldInfoProxy

public interface IGPFieldInfo
extends java.io.Serializable

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

Description: 'Provides access to the properties/methods of a geoprocessing field info 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	IIDb4893c59_ece5_4b2d_ab4a_540abc813789
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addField(int fieldIndex, java.lang.String fieldName, java.lang.String newFieldName, boolean visible, int split) Add a field to the field info object.
int	findFieldByIndex(int fieldIndex) Returns the index of the field in the field info object matching given the field index.
int	findFieldByName(java.lang.String fieldName) Returns the index of the field in the field info object matching given the field name.
int	findFieldByNewName(java.lang.String fieldName) Returns the index of the field in the field info object matching given the field new name.
int	getCount() The number of fields in the field info object.
int	getFieldIndex(int index) Returns the field index of the specified field in the field info object.
java.lang.String	getFieldName(int index) Returns the name of the specified field in the field info object.
boolean	getNamingError(int index) Returns whether there is an error with the specified field in the field info object.
java.lang.String	getNewName(int index) Returns the new name of the specified field in the field info object.
int	getSplitRule(int index) Returns the split rule of the specified field in the field info object.
boolean	getVisible(int index) Returns the visibility of the specified field in the field info object.
void	initialize(IDETable table, IDEWorkspace workspace) Initializes the field info object using the field information from the given table/workspace.
void	merge(IDETable table) Merges the field information from the given table data element into the field info object.
void	removeAll() Removes all the fields from the field info object.
void	removeField(int index) Removes the given field from the field info object.
void	setFieldIndex(int index, int fieldIndex) Sets the name of the specified field in the field info object.
void	setFieldName(int index, java.lang.String name) Sets the name of the specified field in the field info object.
void	setNamingError(int index, boolean error) Sets whether there is an error with the specified field in the field info object.
void	setNewName(int index, java.lang.String name) Sets the new name of the specified field in the field info object.
void	setSplitRule(int index, int split) Sets the split rule of the specified field in the field info object.
void	setVisible(int index, boolean visible) Sets the visibility of the specified field in the field info object.

Field Detail

IIDb4893c59_ece5_4b2d_ab4a_540abc813789

static final int IIDb4893c59_ece5_4b2d_ab4a_540abc813789

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

initialize

void initialize(IDETable table,
                IDEWorkspace workspace)
                throws java.io.IOException,
                       AutomationException

Initializes the field info object using the field information from the given table/workspace.

Parameters:

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

workspace - A reference to a com.esri.arcgis.geodatabase.IDEWorkspace (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

merge

void merge(IDETable table)
           throws java.io.IOException,
                  AutomationException

Merges the field information from the given table data element into the field info object.

Parameters:

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

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

Removes all the fields from the field info object.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addField

void addField(int fieldIndex,
              java.lang.String fieldName,
              java.lang.String newFieldName,
              boolean visible,
              int split)
              throws java.io.IOException,
                     AutomationException

Add a field to the field info object.

Parameters:

fieldIndex - The fieldIndex (in)

fieldName - The fieldName (in)

newFieldName - The newFieldName (in)

visible - The visible (in)

split - A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant (in)

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

The number of fields in the field info object.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldName

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

Returns the name of the specified field in the field info object.

Parameters:

index - The index (in)

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldIndex

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

Returns the field index of the specified field in the field info object.

Parameters:

index - The index (in)

Returns:

The fieldIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNamingError

boolean getNamingError(int index)
                       throws java.io.IOException,
                              AutomationException

Returns whether there is an error with the specified field in the field info object.

Parameters:

index - The index (in)

Returns:

The error

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNewName

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

Returns the new name of the specified field in the field info object.

Parameters:

index - The index (in)

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSplitRule

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

Returns the split rule of the specified field in the field info object.

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVisible

boolean getVisible(int index)
                   throws java.io.IOException,
                          AutomationException

Returns the visibility of the specified field in the field info object.

Parameters:

index - The index (in)

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldName

void setFieldName(int index,
                  java.lang.String name)
                  throws java.io.IOException,
                         AutomationException

Sets the name of the specified field in the field info object.

Parameters:

index - The index (in)

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldIndex

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

Sets the name of the specified field in the field info object.

Parameters:

index - The index (in)

fieldIndex - The fieldIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNamingError

void setNamingError(int index,
                    boolean error)
                    throws java.io.IOException,
                           AutomationException

Sets whether there is an error with the specified field in the field info object.

Parameters:

index - The index (in)

error - The error (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNewName

void setNewName(int index,
                java.lang.String name)
                throws java.io.IOException,
                       AutomationException

Sets the new name of the specified field in the field info object.

Parameters:

index - The index (in)

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSplitRule

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

Sets the split rule of the specified field in the field info object.

Parameters:

index - The index (in)

split - A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(int index,
                boolean visible)
                throws java.io.IOException,
                       AutomationException

Sets the visibility of the specified field in the field info object.

Parameters:

index - The index (in)

visible - The visible (in)

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

Removes the given field from the field info object.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findFieldByName

int findFieldByName(java.lang.String fieldName)
                    throws java.io.IOException,
                           AutomationException

Returns the index of the field in the field info object matching given the field name.

Parameters:

fieldName - The fieldName (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findFieldByNewName

int findFieldByNewName(java.lang.String fieldName)
                       throws java.io.IOException,
                              AutomationException

Returns the index of the field in the field info object matching given the field new name.

Parameters:

fieldName - The fieldName (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findFieldByIndex

int findFieldByIndex(int fieldIndex)
                     throws java.io.IOException,
                            AutomationException

Returns the index of the field in the field info object matching given the field index.

Parameters:

fieldIndex - The fieldIndex (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.