com.esri.sde.sdk.client
Class SeRow

java.lang.Object
  com.esri.sde.sdk.client.SeRow

public class SeRow
extends java.lang.Object

Represents a row of a result set from a fetch operation or a row of data to be inserted or updated. To obtain a row for insert or update, use the SeInsert.getRowToSet() or SeUpdate.getRowToSet() methods.

Since:

ArcSDE 8.1

See Also:

SeInsert, SeUpdate

Field Summary

static int	BLOB_SEG_SIZE
static int	SE_IS_ALREADY_FETCHED
static int	SE_IS_NOT_NULL_VALUE
static int	SE_IS_NULL_VALUE
static int	SE_IS_REPEATED_FEATURE

Method Summary

java.io.ByteArrayInputStream	getBlob(int columnPos) Gets a blob column from the row.
java.io.ByteArrayInputStream	getClob(int columnPos) Gets a blob column from the row.
SeColumnDefinition	getColumnDef(int pos) Returns a column's definition, given the column's position.
SeColumnDefinition[]	getColumns() Returns the column definitions describing the columns on the row.
java.util.Date	getDate(int columnPos) Deprecated. at ArcSDE 8.3, replaced by getTime(int).
java.lang.Double	getDouble(int columnPos) Returns the column value at the given position as a Double.
java.lang.Float	getFloat(int columnPos) Returns the column value at the given position as a Float.
java.lang.Object	getGeometry(GeometryFactory factory, int columnPos) Returns the column value as a GeometryFactory object.
int	getIndicator(int pos) Returns an indicator value, given the column position.
java.lang.Integer	getInteger(int columnPos) Returns the column value at the given position as an Integer.
java.lang.Long	getLong(int columnPos) Returns the column value at the given position as a Long.
java.io.ByteArrayInputStream	getNClob(int columnPos) Gets an nclob column from the row.
java.lang.String	getNString(int columnPos) Returns the column value at the given position as an NString.
short	getNumColumns() Returns the number of columns in the row as a short.
java.lang.Object	getObject(int columnPos) Returns the column value at the given position as an Object.
SeRasterAttr	getRaster(int columnPos) Gets a raster column from the current row.
SeRasterAttr	getRaster(int columnPos, boolean importMode) Gets a raster column from the current row.
SeRasterTile	getRasterTile() Gets a raster tile from the current row.
SeShape	getShape(int columnPos) Returns the column value at the given position as an SeShape.
java.lang.Short	getShort(int columnPos) Returns the column value at the given position as a Short.
int[]	getSpatialMasks() Returns the spatial filter masks for the current row.
java.lang.String	getString(int columnPos) Returns the column value at the given position as a String.
java.util.Calendar	getTime(int columnPos) Returns the column value at the given position as a java.lang.Calendar object.
java.lang.String	getUuid(int columnPos) Gets the UUID column value from the current row.
SeXmlDoc	getXml(int columnPos) Gets an XML column from the current row.
boolean	hasColumns() Returns true if the row has column definitions set.
void	reset() Empties the row by clearing the column values.
void	setBlob(int columnPos, java.io.ByteArrayInputStream blobVal) Sets the value of a BLOB column, which is to be used to insert/update a row in a table/layer.
void	setClob(int columnPos, java.io.ByteArrayInputStream clobVal) Sets the value of a CLOB column, which is to be used to insert/update a row in a table/layer.
void	setColumnDefs(SeColumnDefinition[] cdefs) Sets the column definitions on the row, given an array of SeColumnDefinition objects.
void	setColumnDefs(java.util.Vector cdefs) Sets the column definitions on the row, given a Vector of SeColumnDefinition objects.
void	setDate(int columnPos, java.util.Date dtVal) Deprecated. at ArcSDE 8.3, replaced by setTime(int, java.util.Calendar).
void	setDouble(int columnPos, java.lang.Double dblVal) Sets the value of a double column, which is to be used to insert/update a row in a table/layer.
void	setFloat(int columnPos, java.lang.Float fltVal) Sets the value of a float column, which is to be used to insert/update a row in a table/layer.
void	setInteger(int columnPos, java.lang.Integer intVal) Sets the value of an integer column, which is to be used to insert/update a row in a table/layer.
void	setLong(int columnPos, java.lang.Long longVal) Sets the value of a long column, which is to be used to insert/update a row in a table/layer.
void	setNClob(int columnPos, java.io.ByteArrayInputStream nclobVal) Sets the value of a NCLOB column, which is to be used to insert/update a row in a table/layer.
void	setNString(int columnPos, java.lang.String strVal) Sets the value of an NString column, which is to be used to insert/update a row in a table/layer.
void	setRaster(int columnPos, SeRasterAttr rasAttrVal) Sets the raster attribute value.
void	setRaster(int columnPos, SeRasterAttr rasAttrVal, boolean importMode) Sets the raster attribute value.
void	setShape(int columnPos, SeShape shpVal) Sets the value of an SeShape column, which is to be used to insert/update a row in a table/layer.
void	setShort(int columnPos, java.lang.Short shortVal) Sets the value of a small integer column, which is to be used to insert/update a row in a table/layer.
void	setString(int columnPos, java.lang.String strVal) Sets the value of a String column, which is to be used to insert/update a row in a table/layer.
void	setTime(int columnPos, java.util.Calendar calendar) Sets the value of an Date column, which is to be used to insert/update a row in a table/layer.
void	setUuid(int columnPos, java.lang.String uuidVal) Sets the value for a UUID column.
void	setXml(int columnPos, SeXmlDoc xmlVal) Sets the value of an XML column.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SE_IS_REPEATED_FEATURE

public static final int SE_IS_REPEATED_FEATURE

See Also:

Constant Field Values

SE_IS_ALREADY_FETCHED

public static final int SE_IS_ALREADY_FETCHED

See Also:

Constant Field Values

SE_IS_NULL_VALUE

public static final int SE_IS_NULL_VALUE

See Also:

Constant Field Values

SE_IS_NOT_NULL_VALUE

public static final int SE_IS_NOT_NULL_VALUE

See Also:

Constant Field Values

BLOB_SEG_SIZE

public static final int BLOB_SEG_SIZE

See Also:

Constant Field Values

Method Detail

getNumColumns

public short getNumColumns()

Returns the number of columns in the row as a short.

getColumns

public SeColumnDefinition[] getColumns()

Returns the column definitions describing the columns on the row.

getColumnDef

public SeColumnDefinition getColumnDef(int pos)
                                throws SeException

Returns a column's definition, given the column's position.

Parameters:

pos - position of the column (0-n)

Returns:

SeColumnDefinition definition of the column at pos.

Throws:

SeException

setColumnDefs

public void setColumnDefs(SeColumnDefinition[] cdefs)
                   throws SeException

Sets the column definitions on the row, given an array of SeColumnDefinition objects.

Throws:

SeException

setColumnDefs

public void setColumnDefs(java.util.Vector cdefs)
                   throws SeException

Sets the column definitions on the row, given a Vector of SeColumnDefinition objects.

Throws:

SeException

hasColumns

public boolean hasColumns()

Returns true if the row has column definitions set.

getIndicator

public int getIndicator(int pos)

Returns an indicator value, given the column position.

Parameters:

pos - position of the column (0-n)

Returns:

int the indicator value for column at pos.

getShort

public java.lang.Short getShort(int columnPos)

Returns the column value at the given position as a Short.

Parameters:

columnPos - position of the column (0-n)

Returns:

Short Short object containing the value at columnPos.

setShort

public void setShort(int columnPos,
                     java.lang.Short shortVal)
              throws SeException

Sets the value of a small integer column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

shortVal - the value to set at columnPos.

Throws:

SeException

getInteger

public java.lang.Integer getInteger(int columnPos)

Returns the column value at the given position as an Integer.

Parameters:

columnPos - position of the column (0-n)

Returns:

Integer Integer object containing the value at columnPos.

getLong

public java.lang.Long getLong(int columnPos)

Returns the column value at the given position as a Long.

Parameters:

columnPos - position of the column (0-n)

Returns:

Integer Integer object containing the value at columnPos.

setInteger

public void setInteger(int columnPos,
                       java.lang.Integer intVal)
                throws SeException

Sets the value of an integer column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

intVal - the value to set at columnPos.

Throws:

SeException

setLong

public void setLong(int columnPos,
                    java.lang.Long longVal)
             throws SeException

Sets the value of a long column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

longVal - the value to set at columnPos.

Throws:

SeException

getFloat

public java.lang.Float getFloat(int columnPos)

Returns the column value at the given position as a Float.

Parameters:

columnPos - position of the column (0-n)

Returns:

Float Float object containing the value at columnPos.

setFloat

public void setFloat(int columnPos,
                     java.lang.Float fltVal)
              throws SeException

Sets the value of a float column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

fltVal - the value to set at columnPos.

Throws:

SeException

getDate

public java.util.Date getDate(int columnPos)

Deprecated. at ArcSDE 8.3, replaced by getTime(int).

Returns the column value at the given position as a java.lang.Date.

Parameters:

columnPos - position of the column (0-n)

Returns:

Date Date object containing the value at columnPos.

getTime

public java.util.Calendar getTime(int columnPos)

Returns the column value at the given position as a java.lang.Calendar object.

Parameters:

columnPos - position of the column.

Returns:

Calendar java.util.Calendar object containing the date value at columnPos.

setDate

public void setDate(int columnPos,
                    java.util.Date dtVal)
             throws SeException

Deprecated. at ArcSDE 8.3, replaced by setTime(int, java.util.Calendar).

Sets the value of an Date column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

dtVal - the value to set at columnPos.

Throws:

SeException

setTime

public void setTime(int columnPos,
                    java.util.Calendar calendar)
             throws SeException

Sets the value of an Date column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column.

calendar - the java.util.Calendar value used to set the date.

Throws:

SeException

getDouble

public java.lang.Double getDouble(int columnPos)

Returns the column value at the given position as a Double.

Parameters:

columnPos - position of the column (0-n)

Returns:

Double Double object containing the value at columnPos.

setDouble

public void setDouble(int columnPos,
                      java.lang.Double dblVal)
               throws SeException

Sets the value of a double column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

dblVal - the value to set at columnPos.

Throws:

SeException

getString

public java.lang.String getString(int columnPos)

Returns the column value at the given position as a String.

Parameters:

columnPos - position of the column (0-n)

Returns:

String String object containing the value at columnPos.

setString

public void setString(int columnPos,
                      java.lang.String strVal)
               throws SeException

Sets the value of a String column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

strVal - the value to set at columnPos.

Throws:

SeException

getNString

public java.lang.String getNString(int columnPos)

Returns the column value at the given position as an NString.

Parameters:

columnPos - position of the column (0-n)

Returns:

String String object containing the value at columnPos.

setNString

public void setNString(int columnPos,
                       java.lang.String strVal)
                throws SeException

Sets the value of an NString column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

strVal - the value to set at columnPos.

Throws:

SeException

getShape

public SeShape getShape(int columnPos)
                 throws SeException

Returns the column value at the given position as an SeShape.

Parameters:

columnPos - position of the column (0-n)

Returns:

SeShape SeShape object containing the value at columnPos.

Throws:

SeException

getGeometry

public java.lang.Object getGeometry(GeometryFactory factory,
                                    int columnPos)
                             throws SeException

Returns the column value as a GeometryFactory object.

Parameters:

columnPos - position of the column (0-n)

Throws:

SeException

Factory:

GeometryFactory object.

setShape

public void setShape(int columnPos,
                     SeShape shpVal)
              throws SeException

Sets the value of an SeShape column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

shpVal - the value to set at columnPos.

Throws:

SeException

getBlob

public java.io.ByteArrayInputStream getBlob(int columnPos)
                                     throws SeException

Gets a blob column from the row.

Parameters:

columnPos - position of the column (0-n)

Returns:

ByteArrayInputStream stream containing the blob value at columnPos.

Throws:

SeException

setBlob

public void setBlob(int columnPos,
                    java.io.ByteArrayInputStream blobVal)
             throws SeException

Sets the value of a BLOB column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

blobVal - the value to set at columnPos.

Throws:

SeException

getClob

public java.io.ByteArrayInputStream getClob(int columnPos)
                                     throws SeException

Gets a blob column from the row.

Parameters:

columnPos - position of the column (0-n)

Returns:

ByteArrayInputStream stream containing the blob value at columnPos.

Throws:

SeException

setClob

public void setClob(int columnPos,
                    java.io.ByteArrayInputStream clobVal)
             throws SeException

Sets the value of a CLOB column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

clobVal - the value to set at columnPos.

Throws:

SeException

getNClob

public java.io.ByteArrayInputStream getNClob(int columnPos)
                                      throws SeException

Gets an nclob column from the row.

Parameters:

columnPos - position of the column (0-n)

Returns:

ByteArrayInputStream stream containing the nclob value at columnPos.

Throws:

SeException

setNClob

public void setNClob(int columnPos,
                     java.io.ByteArrayInputStream nclobVal)
              throws SeException

Sets the value of a NCLOB column, which is to be used to insert/update a row in a table/layer. If a NULL value is given, then the column value will be set to NULL.

Parameters:

columnPos - position of the column (0-n)

nclobVal - the value to set at columnPos.

Throws:

SeException

getObject

public java.lang.Object getObject(int columnPos)
                           throws SeException

Returns the column value at the given position as an Object. Use this method to retrieve a column value and then cast the Object to the expected type. Blobs cannot be retreived by this method.

Parameters:

columnPos - position of the column (0-n)

Returns:

Object generic object containing the value at columnPos.

Throws:

SeException

reset

public void reset()

Empties the row by clearing the column values.

getSpatialMasks

public int[] getSpatialMasks()
                      throws SeException

Returns the spatial filter masks for the current row. There is one mask per spatial filter as specified in the call to SeQuery.setSpatialConstraints(short, boolean, com.esri.sde.sdk.client.SeFilter[]). If the calcMasks argument of SeQuery.setSpatialConstraints(short, boolean, com.esri.sde.sdk.client.SeFilter[]) is true, all spatial masks are retrieved.

Throws:

SeException

getRaster

public SeRasterAttr getRaster(int columnPos)
                       throws SeException

Gets a raster column from the current row. At this point, the caller must have executed the query and fetched a row using SeQuery.fetch().

Parameters:

columnPos - as int value

Throws:

SeException - if an error occurs

getRaster

public SeRasterAttr getRaster(int columnPos,
                              boolean importMode)
                       throws SeException

Gets a raster column from the current row. At this point, the caller must have executed the query and fetched a row using SeQuery.fetch() .

Parameters:

columnPos - as int value

importMode - If true, export rasterTile in ArcSDE server native format (ie, pixel data is uncompress).

Throws:

SeException - if an error occurs

getRasterTile

public SeRasterTile getRasterTile()
                           throws SeException

Gets a raster tile from the current row.

Throws:

SeException - if an error occurs

setRaster

public void setRaster(int columnPos,
                      SeRasterAttr rasAttrVal)
               throws SeException

Sets the raster attribute value.

Parameters:

columnPos - as int value

rasAttrVal - raster attribute value.

Throws:

SeException - if an error occurs

setRaster

public void setRaster(int columnPos,
                      SeRasterAttr rasAttrVal,
                      boolean importMode)
               throws SeException

Sets the raster attribute value.

Parameters:

columnPos - as int value

rasAttrVal - raster attribute value.

importMode - true, callback function expect rasterTile else expect image_scan_lines.

Throws:

SeException - if an error occurs

setXml

public void setXml(int columnPos,
                   SeXmlDoc xmlVal)
            throws SeException

Sets the value of an XML column.

Parameters:

columnPos - as int value

xmlVal - the xml doc to copy

Throws:

SeException - if an error occurs

setUuid

public void setUuid(int columnPos,
                    java.lang.String uuidVal)
             throws SeException

Sets the value for a UUID column.

Parameters:

columnPos - as int value

uuidVal - the uuid value

Throws:

SeException - if an error occurs

getXml

public SeXmlDoc getXml(int columnPos)
                throws SeException

Gets an XML column from the current row.

Parameters:

columnPos - as int value

Throws:

SeException - if an error occurs

getUuid

public java.lang.String getUuid(int columnPos)
                         throws SeException

Gets the UUID column value from the current row.

Parameters:

columnPos - as int value

Throws:

SeException - if an error occurs