com.esri.arcgis.geoprocessing
Class GpFieldInfoObject

java.lang.Object
  com.esri.arcgis.geoprocessing.GpFieldInfoObject

All Implemented Interfaces:

IGpFieldInfoObject, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GpFieldInfoObject
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGpFieldInfoObject

Geoprocessing Field Info object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GpFieldInfoObject()
Constructs a GpFieldInfoObject using ArcGIS Engine.

GpFieldInfoObject(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpFieldInfoObject theGpFieldInfoObject = (GpFieldInfoObject) obj;

Method Summary

void	addField(String fieldName, String newFieldName, String visible, String splitRule) Add a field.
boolean	equals(Object o) Compare this object with another
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.
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GpFieldInfoObject

public GpFieldInfoObject()
                  throws IOException,
                         UnknownHostException

Constructs a GpFieldInfoObject using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GpFieldInfoObject

public GpFieldInfoObject(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpFieldInfoObject theGpFieldInfoObject = (GpFieldInfoObject) obj;

Construct a GpFieldInfoObject using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GpFieldInfoObject.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addField

public 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.

Specified by:

addField in interface IGpFieldInfoObject

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

public int getCount()
             throws IOException,
                    AutomationException

The number of fields.

Product Availability

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

Specified by:

getCount in interface IGpFieldInfoObject

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldName

public String getFieldName(int index)
                    throws IOException,
                           AutomationException

Get the field name by index.

Product Availability

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

Specified by:

getFieldName in interface IGpFieldInfoObject

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNewName

public 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.

Specified by:

getNewName in interface IGpFieldInfoObject

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSplitRule

public String getSplitRule(int index)
                    throws IOException,
                           AutomationException

Get the split rule by index.

Product Availability

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

Specified by:

getSplitRule in interface IGpFieldInfoObject

Parameters:

index - The index (in)

Returns:

The rule

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVisible

public String getVisible(int index)
                  throws IOException,
                         AutomationException

Get the visible flag by index.

Product Availability

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

Specified by:

getVisible in interface IGpFieldInfoObject

Parameters:

index - The index (in)

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldName

public 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.

Specified by:

setFieldName in interface IGpFieldInfoObject

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

public 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.

Specified by:

setNewName in interface IGpFieldInfoObject

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

public 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.

Specified by:

setSplitRule in interface IGpFieldInfoObject

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

public 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.

Specified by:

setVisible in interface IGpFieldInfoObject

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

public void removeField(int index)
                 throws IOException,
                        AutomationException

Remove a field.

Product Availability

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

Specified by:

removeField in interface IGpFieldInfoObject

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFieldByName

public int findFieldByName(String fieldName)
                    throws IOException,
                           AutomationException

Find a field index by name.

Product Availability

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

Specified by:

findFieldByName in interface IGpFieldInfoObject

Parameters:

fieldName - The fieldName (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFieldByNewName

public 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.

Specified by:

findFieldByNewName in interface IGpFieldInfoObject

Parameters:

fieldName - The fieldName (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromString

public 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.

Specified by:

loadFromString in interface IGpFieldInfoObject

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportToString

public String exportToString()
                      throws IOException,
                             AutomationException

Export the Value Table to a string.

Product Availability

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

Specified by:

exportToString in interface IGpFieldInfoObject

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.