com.esri.arcgis.geoprocessing
Interface IGpValueTableObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

GpValueTableObject

public interface IGpValueTableObject
extends Serializable

Provides access to the Dispatch Value Table Object.

Product Availability

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

Method Summary

void	addRow(Object row) Add a row.
String	exportToString() Export the Value Table to a string.
int	getColumnCount() The number of columns.
String	getRow(int index) Get a row.
int	getRowCount() The number of rows.
String	getValue(int rowIndex, int columnIndex) Get a value.
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.

Method Detail

setColumns

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

Parameters:

nColumns - The nColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowCount

int getRowCount()
                throws IOException,
                       AutomationException

The number of rows.

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.

getColumnCount

int getColumnCount()
                   throws IOException,
                          AutomationException

The number of columns.

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.

addRow

void addRow(Object row)
            throws IOException,
                   AutomationException

Add a row.

Product Availability

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

Supported Platforms

Windows

Parameters:

row - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRow

String getRow(int index)
              throws IOException,
                     AutomationException

Get a row.

Product Availability

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

Supported Platforms

Windows

Parameters:

index - The index (in)

Returns:

The row

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

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

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

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

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.

Supported Platforms

Windows

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeRow

void removeRow(int rowIndex)
               throws IOException,
                      AutomationException

Remove a row.

Product Availability

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

Supported Platforms

Windows

Parameters:

rowIndex - The rowIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRow

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

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

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

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

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

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.