com.esri.arcgis.geoprocessing
Class GPValueTable

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

All Implemented Interfaces:

IGPValue, IGPValueExpression, IGPValueTable, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPValueTable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPValue, IGPValueTable, IClone, IXMLSerialize, IPersistStream, IGPValueExpression, Externalizable

Geoprocessing value object containing two-dimensional array of geoprocessing value objects.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GPValueTable()
Constructs a GPValueTable using ArcGIS Engine.

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

Method Summary

void	addDataType(IGPDataType pDataType) Adds the data type as a column to the value table.
void	addRecord(IArray pValues) Adds a record to the value table.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	empty() Clears the value object.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
String	getAsText() Provides the value of the value object.
String	getAsText(IGPVariableManager pVariableManager) Gets the text value of the variable value.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IGPDataType	getDataType(int index) The data type object of the given column index.
int	getDataTypeCount() The number of data types/columns of the value table.
IArray	getRecord(int index) Returns the array of values of the specified record in the value table.
int	getRecordCount() The number of rows in the value table.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IGPValue	getValue(int row, int col) Returns the value of the given row/column.
IStringArray	getVariableNames() Returns a string array of the variable names.
IArray	getVariables() Returns an array of variables.
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
void	insertRecord(int index, IArray pValues) Inserts a record in the value table at the specified index.
void	isDirty() isDirty
boolean	isEmpty() Indicates if the value object is empty.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isResolved() Gets the resolved state.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	removeDataType(int index) Removes the given column from the value table.
void	removeRecord(int index) Removes the specified record from the value table.
void	removeValue(IGPValue pValue) Removes the given value from the value table.
void	replaceRecord(int index, IArray pValues) Replaces the record in the value table at the specified index.
IGPValue	resolveValue(IGPVariableManager pVariableManager) Resolves a given variable value.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(String text) Provides the value of the value object with the given string value.
void	setResolved(boolean pResolved) Gets the resolved state.
void	setValue(int row, int col, IGPValue ppValue) Sets the vlaue of the given row/column.
void	setVariablesByRef(IArray ppVariables) Returns an array of variables.
void	writeExternal(ObjectOutput out)

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

GPValueTable

public GPValueTable()
             throws IOException,
                    UnknownHostException

Constructs a GPValueTable using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPValueTable

public GPValueTable(Object obj)
             throws IOException

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

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

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

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws IOException,
                                        AutomationException

The data type of the value object.

Product Availability

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

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

Specified by:

empty in interface IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException

Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataTypeCount

public int getDataTypeCount()
                     throws IOException,
                            AutomationException

The number of data types/columns of the value table.

Product Availability

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

Supported Platforms

Windows

Specified by:

getDataTypeCount in interface IGPValueTable

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

public IGPDataType getDataType(int index)
                        throws IOException,
                               AutomationException

The data type object of the given column index.

Product Availability

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

Specified by:

getDataType in interface IGPValueTable

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDataType

public void addDataType(IGPDataType pDataType)
                 throws IOException,
                        AutomationException

Adds the data type as a column to the value table.

Product Availability

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

Supported Platforms

Windows

Specified by:

addDataType in interface IGPValueTable

Parameters:

pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeDataType

public void removeDataType(int index)
                    throws IOException,
                           AutomationException

Removes the given column from the value table.

Product Availability

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

Supported Platforms

Windows

Specified by:

removeDataType in interface IGPValueTable

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecordCount

public int getRecordCount()
                   throws IOException,
                          AutomationException

The number of rows in the value table.

Product Availability

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

Supported Platforms

Windows

Specified by:

getRecordCount in interface IGPValueTable

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public IGPValue getValue(int row,
                         int col)
                  throws IOException,
                         AutomationException

Returns the value of the given row/column.

Product Availability

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

Supported Platforms

Windows

Specified by:

getValue in interface IGPValueTable

Parameters:

row - The row (in)

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

setValue

public void setValue(int row,
                     int col,
                     IGPValue ppValue)
              throws IOException,
                     AutomationException

Sets the vlaue of the given row/column.

Product Availability

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

Supported Platforms

Windows

Specified by:

setValue in interface IGPValueTable

Parameters:

row - The row (in)

col - The col (in)

ppValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addRecord

public void addRecord(IArray pValues)
               throws IOException,
                      AutomationException

Adds a record to the value table.

Product Availability

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

Supported Platforms

Windows

Specified by:

addRecord in interface IGPValueTable

Parameters:

pValues - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertRecord

public void insertRecord(int index,
                         IArray pValues)
                  throws IOException,
                         AutomationException

Inserts a record in the value table at the specified index.

Product Availability

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

Supported Platforms

Windows

Specified by:

insertRecord in interface IGPValueTable

Parameters:

index - The index (in)

pValues - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceRecord

public void replaceRecord(int index,
                          IArray pValues)
                   throws IOException,
                          AutomationException

Replaces the record in the value table at the specified index.

Product Availability

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

Supported Platforms

Windows

Specified by:

replaceRecord in interface IGPValueTable

Parameters:

index - The index (in)

pValues - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeRecord

public void removeRecord(int index)
                  throws IOException,
                         AutomationException

Removes the specified record from the value table.

Product Availability

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

Supported Platforms

Windows

Specified by:

removeRecord in interface IGPValueTable

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecord

public IArray getRecord(int index)
                 throws IOException,
                        AutomationException

Returns the array of values of the specified record in the value table.

Product Availability

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

Supported Platforms

Windows

Specified by:

getRecord in interface IGPValueTable

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeValue

public void removeValue(IGPValue pValue)
                 throws IOException,
                        AutomationException

Removes the given value from the value table.

Product Availability

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

Supported Platforms

Windows

Specified by:

removeValue in interface IGPValueTable

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isResolved

public boolean isResolved()
                   throws IOException,
                          AutomationException

Gets the resolved state.

Product Availability

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

Specified by:

isResolved in interface IGPValueExpression

Returns:

The pResolved

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResolved

public void setResolved(boolean pResolved)
                 throws IOException,
                        AutomationException

Gets the resolved state.

Product Availability

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

Specified by:

setResolved in interface IGPValueExpression

Parameters:

pResolved - The pResolved (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolveValue

public IGPValue resolveValue(IGPVariableManager pVariableManager)
                      throws IOException,
                             AutomationException

Resolves a given variable value.

Product Availability

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

Specified by:

resolveValue in interface IGPValueExpression

Parameters:

pVariableManager - A reference to a com.esri.arcgis.geoprocessing.IGPVariableManager (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.

getVariableNames

public IStringArray getVariableNames()
                              throws IOException,
                                     AutomationException

Returns a string array of the variable names.

Product Availability

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

Specified by:

getVariableNames in interface IGPValueExpression

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVariables

public IArray getVariables()
                    throws IOException,
                           AutomationException

Returns an array of variables.

Product Availability

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

Specified by:

getVariables in interface IGPValueExpression

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVariablesByRef

public void setVariablesByRef(IArray ppVariables)
                       throws IOException,
                              AutomationException

Returns an array of variables.

Product Availability

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

Specified by:

setVariablesByRef in interface IGPValueExpression

Parameters:

ppVariables - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText(IGPVariableManager pVariableManager)
                 throws IOException,
                        AutomationException

Gets the text value of the variable value.

Product Availability

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

Specified by:

getAsText in interface IGPValueExpression

Parameters:

pVariableManager - A reference to a com.esri.arcgis.geoprocessing.IGPVariableManager (in)

Returns:

The pText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException