com.esri.arcgis.geoprocessing
Class GpValueTableObject

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

All Implemented Interfaces:

IGpValueTableObject, IGpValueTableObject2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GpValueTableObject
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGpValueTableObject, IGpValueTableObject2

Geoprocessing Value Table object.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GpValueTableObject()
Constructs a GpValueTableObject using ArcGIS Engine.

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

Method Summary

void	addRow(Object row) Add a row.
boolean	equals(Object o) Compare this object with another
String	exportToString() Export the Value Table to a string.
static String	getClsid() getClsid.
int	getColumnCount() The number of columns.
String	getRow(int index) Get a row.
int	getRowCount() The number of rows.
IGPValue	getTrueValue(int rowIndex, int columnIndex) Get a value.
String	getValue(int rowIndex, int columnIndex) Get a value.
int	hashCode() the hashcode for this object
void	loadFromString(String value) Load the Value Table from a string.
void	populate(IGPValueTable pGpValueTable) Populate a given ValueTable with the values from this one.
void	removeRow(int rowIndex) Remove a row.
void	setColumns(int nColumns) The number of columns.
void	setRow(int rowIndex, Object value) Set a given row with a new value.
void	setValue(int rowIndex, int columnIndex, Object value) Set a given column value.

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

GpValueTableObject

public GpValueTableObject()
                   throws IOException,
                          UnknownHostException

Constructs a GpValueTableObject using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GpValueTableObject

public GpValueTableObject(Object obj)
                   throws IOException

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

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

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

setColumns

public void setColumns(int nColumns)
                throws IOException,
                       AutomationException

The number of columns.

Product Availability

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

Supported Platforms

Windows

Specified by:

setColumns in interface IGpValueTableObject

Parameters:

nColumns - The nColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowCount

public int getRowCount()
                throws IOException,
                       AutomationException

The number of rows.

Product Availability

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

Supported Platforms

Windows

Specified by:

getRowCount in interface IGpValueTableObject

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

public int getColumnCount()
                   throws IOException,
                          AutomationException

The number of columns.

Product Availability

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

Supported Platforms

Windows

Specified by:

getColumnCount in interface IGpValueTableObject

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addRow

public void addRow(Object row)
            throws IOException,
                   AutomationException

Add a row.

Product Availability

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

Supported Platforms

Windows

Specified by:

addRow in interface IGpValueTableObject

Parameters:

row - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRow

public String getRow(int index)
              throws IOException,
                     AutomationException

Get a row.

Product Availability

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

Supported Platforms

Windows

Specified by:

getRow in interface IGpValueTableObject

Parameters:

index - The index (in)

Returns:

The row

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public String getValue(int rowIndex,
                       int columnIndex)
                throws IOException,
                       AutomationException

Get a value.

Product Availability

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

Supported Platforms

Windows

Specified by:

getValue in interface IGpValueTableObject

Parameters:

rowIndex - The rowIndex (in)

columnIndex - The columnIndex (in)

Returns:

The value

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.

Supported Platforms

Windows

Specified by:

loadFromString in interface IGpValueTableObject

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.

Supported Platforms

Windows

Specified by:

exportToString in interface IGpValueTableObject

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeRow

public void removeRow(int rowIndex)
               throws IOException,
                      AutomationException

Remove a row.

Product Availability

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

Supported Platforms

Windows

Specified by:

removeRow in interface IGpValueTableObject

Parameters:

rowIndex - The rowIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRow

public void setRow(int rowIndex,
                   Object value)
            throws IOException,
                   AutomationException

Set a given row with a new value.

Product Availability

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

Supported Platforms

Windows

Specified by:

setRow in interface IGpValueTableObject

Parameters:

rowIndex - The rowIndex (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int rowIndex,
                     int columnIndex,
                     Object value)
              throws IOException,
                     AutomationException

Set a given column value.

Product Availability

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

Supported Platforms

Windows

Specified by:

setValue in interface IGpValueTableObject

Parameters:

rowIndex - The rowIndex (in)

columnIndex - The columnIndex (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

populate

public void populate(IGPValueTable pGpValueTable)
              throws IOException,
                     AutomationException

Populate a given ValueTable with the values from this one.

Product Availability

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

Supported Platforms

Windows

Specified by:

populate in interface IGpValueTableObject

Parameters:

pGpValueTable - A reference to a com.esri.arcgis.geoprocessing.IGPValueTable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrueValue

public IGPValue getTrueValue(int rowIndex,
                             int columnIndex)
                      throws IOException,
                             AutomationException

Get a value.

Product Availability

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

Specified by:

getTrueValue in interface IGpValueTableObject2

Parameters:

rowIndex - The rowIndex (in)

columnIndex - The columnIndex (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.