com.esri.arcgis.geoprocessing
Interface IGPFieldInfo

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPFieldInfo

public interface IGPFieldInfo
extends Serializable

Provides access to the properties/methods of a geoprocessing field info object.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void addField(int fieldIndex, String fieldName, 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(String fieldName)
          Returns the index of the field in the field info object matching given the field name.
 int findFieldByNewName(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.
 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.
 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, 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, 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.
 

Method Detail

initialize

void initialize(IDETable table,
                IDEWorkspace workspace)
                throws IOException,
                       AutomationException
Initializes the field info object using the field information from the given table/workspace.

Product Availability

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

Supported Platforms

Windows

Parameters:
table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)
workspace - A reference to a com.esri.arcgis.geodatabase.IDEWorkspace (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

merge

void merge(IDETable table)
           throws IOException,
                  AutomationException
Merges the field information from the given table data element into the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException
Removes all the fields from the field info object.

Product Availability

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

Supported Platforms

Windows

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addField

void addField(int fieldIndex,
              String fieldName,
              String newFieldName,
              boolean visible,
              int split)
              throws IOException,
                     AutomationException
Add a field to the field info object.

Product Availability

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

Supported Platforms

Windows

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException
The number of fields in the field info object.

Product Availability

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

Supported Platforms

Windows

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldName

String getFieldName(int index)
                    throws IOException,
                           AutomationException
Returns the name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldIndex

int getFieldIndex(int index)
                  throws IOException,
                         AutomationException
Returns the field index of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
The fieldIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNamingError

boolean getNamingError(int index)
                       throws IOException,
                              AutomationException
Returns whether there is an error with the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
The error
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNewName

String getNewName(int index)
                  throws IOException,
                         AutomationException
Returns the new name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSplitRule

int getSplitRule(int index)
                 throws IOException,
                        AutomationException
Returns the split rule of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVisible

boolean getVisible(int index)
                   throws IOException,
                          AutomationException
Returns the visibility of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldName

void setFieldName(int index,
                  String name)
                  throws IOException,
                         AutomationException
Sets the name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldIndex

void setFieldIndex(int index,
                   int fieldIndex)
                   throws IOException,
                          AutomationException
Sets the name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
fieldIndex - The fieldIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNamingError

void setNamingError(int index,
                    boolean error)
                    throws IOException,
                           AutomationException
Sets whether there is an error with the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
error - The error (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNewName

void setNewName(int index,
                String name)
                throws IOException,
                       AutomationException
Sets the new name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSplitRule

void setSplitRule(int index,
                  int split)
                  throws IOException,
                         AutomationException
Sets the split rule of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
split - A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(int index,
                boolean visible)
                throws IOException,
                       AutomationException
Sets the visibility of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeField

void removeField(int index)
                 throws IOException,
                        AutomationException
Removes the given field from the field info object.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findFieldByName

int findFieldByName(String fieldName)
                    throws IOException,
                           AutomationException
Returns the index of the field in the field info object matching given the field name.

Product Availability

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

Supported Platforms

Windows

Parameters:
fieldName - The fieldName (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findFieldByNewName

int findFieldByNewName(String fieldName)
                       throws IOException,
                              AutomationException
Returns the index of the field in the field info object matching given the field new name.

Product Availability

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

Supported Platforms

Windows

Parameters:
fieldName - The fieldName (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findFieldByIndex

int findFieldByIndex(int fieldIndex)
                     throws IOException,
                            AutomationException
Returns the index of the field in the field info object matching given the field index.

Product Availability

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

Supported Platforms

Windows

Parameters:
fieldIndex - The fieldIndex (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.