com.esri.arcgis.geoprocessing
Interface IGpFieldInfoObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

GpFieldInfoObject

public interface IGpFieldInfoObject
extends Serializable

Provides access to the Dispatch Field Info Object.

Product Availability

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

Method Summary

void	addField(String fieldName, String newFieldName, String visible, String splitRule) Add a field.
String	exportToString() Export the Value Table to a string.
int	findFieldByName(String fieldName) Find a field index by name.
int	findFieldByNewName(String fieldName) Find a field index by new name.
int	getCount() The number of fields.
String	getFieldName(int index) Get the field name by index.
String	getNewName(int index) Get the new field name by index.
String	getSplitRule(int index) Get the split rule by index.
String	getVisible(int index) Get the visible flag by index.
void	loadFromString(String value) Load the Value Table from a string.
void	removeField(int index) Remove a field.
void	setFieldName(int index, String name) Set the field name by index.
void	setNewName(int index, String name) Set the new field name by index.
void	setSplitRule(int index, String rule) Set the split rule by index.
void	setVisible(int index, String visible) Set the visible flag by index.

Method Detail

addField

void addField(String fieldName,
              String newFieldName,
              String visible,
              String splitRule)
              throws IOException,
                     AutomationException

Add a field.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

newFieldName - The newFieldName (in)

visible - The visible (in)

splitRule - The splitRule (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.

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.

getFieldName

String getFieldName(int index)
                    throws IOException,
                           AutomationException

Get the field name by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNewName

String getNewName(int index)
                  throws IOException,
                         AutomationException

Get the new field name by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSplitRule

String getSplitRule(int index)
                    throws IOException,
                           AutomationException

Get the split rule by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The rule

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVisible

String getVisible(int index)
                  throws IOException,
                         AutomationException

Get the visible flag by index.

Product Availability

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

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

Set the field name by index.

Product Availability

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

Parameters:

index - The index (in)

name - The name (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

Set the new field name by index.

Product Availability

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

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,
                  String rule)
                  throws IOException,
                         AutomationException

Set the split rule by index.

Product Availability

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

Parameters:

index - The index (in)

rule - The rule (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(int index,
                String visible)
                throws IOException,
                       AutomationException

Set the visible flag by index.

Product Availability

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

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

Remove a 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.

findFieldByName

int findFieldByName(String fieldName)
                    throws IOException,
                           AutomationException

Find a field index by name.

Product Availability

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

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

Find a field index by new name.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromString

void loadFromString(String value)
                    throws IOException,
                           AutomationException

Load the Value Table from a string.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportToString

String exportToString()
                      throws IOException,
                             AutomationException

Export the Value Table to a string.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.