com.ibm.ims.dli

Interface DBArrayElementSet

public interface DBArrayElementSet

A table of array data representing a database element set, which is usually generated by executing DLI call.

A DBArrayElementSet object maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. The next method moves the cursor to the next row, and because it returns false when there are no more rows in the ElementSet object, it can be used in a while loop to iterate through the element set.

The DBArrayElementSet interface provides getter methods (getBoolean, getLong, and so on) for retrieving field values from the current element. Values can be retrieved using either the index number of the field or the name of the field. In general, using the field index will be more efficient. Fields are numbered from 1. For maximum portability, result set fields within each row should be read in left-to-right order, and each field should be read only once.

For the getter methods, a JDBC driver attempts to convert the underlying data to the Java type specified in the getter method and returns a suitable Java value. The JDBC specification has a table showing the allowable mappings from SQL types to Java types that can be used by the ResultSet getter methods.

Method Summary

Modifier and Type	Method and Description
boolean	absolute(int element) Moves to the specified element in the array.
void	addElement() Adds the current element to the element set.
void	beforeFirst() Positions the cursor to before the first element.
boolean	first() Moves to the first element in the array.
DBArray	getArray(java.lang.String fieldName) Retrieves the value of the designated field in the current element of the DBArrayElementSet object as a com.ibm.ims.dli.DBArray.
java.math.BigDecimal	getBigDecimal(java.lang.String fieldName) Retrieves the value of the designated field in the DBArrayElementSet object as a java.math.BigDecimal.
boolean	getBoolean(java.lang.String fieldName) Retrieves the value of the designated field in the DBArrayElementSet object as a boolean.
byte	getByte(java.lang.String fieldName) Retrieves the value of the designated field in the segment of this DBArrayElementSet object as a byte.
byte[]	getBytes(java.lang.String fieldName) Gets the value of the designated field in the DBArrayElementSet object as a byte array.
int	getCurrentElementIndex() Returns the current position in the element set
java.sql.Date	getDate(java.lang.String fieldName) Sets the value of the designated field in the DBArrayElementSet object as a java.sql.Date.
double	getDouble(java.lang.String fieldName) Retrieves the value of the designated field in the DBArrayElementSet object as a double.
float	getFloat(java.lang.String fieldName) Retrieves the value of the designated field in the DBArrayElementSet object as a float.
int	getInt(java.lang.String fieldName) Retrieves the value of the designated field in the segment of this DBArrayElementSet object as an int.
long	getLong(java.lang.String fieldName) Retrieves the value of the designated field in the DBArrayElementSet object as a long.
DBArrayElementSetMetaData	getMetaData() This method will return the metadata of an array field represented by its DBArrayElementSet.
java.lang.Object	getObject(java.lang.String fieldName) Retrieves the value of the designated field in the DBArrayElementSet object as an Object in the Java Programming Language.
short	getShort(java.lang.String fieldName) Retrieves the value of the designated field in the DBArrayElementSet object as a short.
java.lang.String	getString(java.lang.String fieldName) Gets the value of the designated field in the DBArrayElementSet object as a java.lang.String.
java.sql.Time	getTime(java.lang.String fieldName) Sets the value of the designated field in the DBArrayElementSet object as a java.sql.Time.
java.sql.Timestamp	getTimestamp(java.lang.String fieldName) Sets the value of the designated field in the DBArrayElementSet object as a java.sql.TimeStamp.
boolean	isClosed() Retrieves whether this DBArrayElementSet object has been closed.
boolean	last() Moves to the last element in the array.
void	moveToCurrentElement() Calling this method will restore the remembered cursor position after calling DBArrayElementSet.prepareElementToAdd This method can only be called if the DBArray object is dynamic.
boolean	next() Moves to the next element in the array.
void	prepareElementToAdd() Moves the cursor to a new element that will be added to the element set after calling DBArrayElementSet.addElement.
boolean	previous() Moves to the previous element in the array.
void	removeElement() Removes the current element.
void	setArray(java.lang.String fieldName, DBArray value) Sets the value of the designated field in the DBArrayElementSet object as a com.ibm.ims.dli.DBArray.
void	setBigDecimal(java.lang.String fieldName, java.math.BigDecimal value) Sets the value of the field in the DBArrayElementSet object as a java.math.BigDecimal.
void	setBoolean(java.lang.String fieldName, boolean value) Sets the value of the designated field in the DBArrayElementSet object as a boolean.
void	setByte(java.lang.String fieldName, byte value) Sets the value of the designated field in the segment of this DBArrayElementSet object as a byte.
void	setBytes(java.lang.String fieldName, byte[] value) Sets the value of the designated field in the DBArrayElementSet object as a byte array.
void	setDate(java.lang.String fieldName, java.sql.Date value) Sets the value of the designated field in the DBArrayElementSet object as a java.sql.Date.
void	setDouble(java.lang.String fieldName, double value) Sets the value of the designated field in the DBArrayElementSet object as a double.
void	setFloat(java.lang.String fieldName, float value) Sets the value of the designated field in the DBArrayElementSet object as a float.
void	setInt(java.lang.String fieldName, int value) Sets the value of the designated field in the DBArrayElementSet object as an int.
void	setLong(java.lang.String fieldName, long value) Sets the value of the designated field in the DBArrayElementSet object as a long.
void	setObject(java.lang.String fieldName, java.lang.Object value) Sets the value of the designated field in the DBArrayElementSet object with the Object value.
void	setShort(java.lang.String fieldName, short value) Sets the value of the designated field in the s DBArrayElementSet object as a short.
void	setString(java.lang.String fieldName, java.lang.String value) Sets the value of the designated field in the DBArrayElementSet object as a java.lang.String.
void	setTime(java.lang.String fieldName, java.sql.Time value) Sets the value of the designated field in the DBArrayElementSet object as a java.sql.Time.
void	setTimestamp(java.lang.String fieldName, java.sql.Timestamp value) Sets the value of the designated field in the DBArrayElementSet object as a java.sql.TimeStamp.
int	size() Returns the number of elements within the element set

Method Detail

isClosed

boolean isClosed()
          throws DLIException

Retrieves whether this DBArrayElementSet object has been closed. A DBArrayElementSet is closed if the method close has been called on it, or if it is automatically closed.

Returns:

true if this DBArrayElementSet object is closed; false if it is still open

Throws:

DLIException - if an error occurs

next

boolean next()
      throws DLIException

Moves to the next element in the array.

Returns:

true if there is another element; false otherwise

Throws:

DLIException - if an error occurs

previous

boolean previous()
          throws DLIException

Moves to the previous element in the array.

Returns:

true if there is a previous element; false otherwise

Throws:

DLIException - if an error occurs

absolute

boolean absolute(int element)
          throws DLIException

Moves to the specified element in the array.

Returns:

true if the element exists; false otherwise

Throws:

DLIException - if an error occurs

first

boolean first()
       throws DLIException

Moves to the first element in the array.

Returns:

true if there is a first element; false otherwise

Throws:

DLIException - if an error occurs

last

boolean last()
      throws DLIException

Moves to the last element in the array.

Returns:

true if there is a last element; false otherwise

Throws:

DLIException - if an error occurs

getArray

DBArray getArray(java.lang.String fieldName)
          throws DLIException

Retrieves the value of the designated field in the current element of the DBArrayElementSet object as a com.ibm.ims.dli.DBArray.

Returns:

value of the field

Throws:

DLIException - if an error occurs

See Also:

DBArray

setArray

void setArray(java.lang.String fieldName,
              DBArray value)
       throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a com.ibm.ims.dli.DBArray.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

See Also:

DBArray

getBoolean

boolean getBoolean(java.lang.String fieldName)
            throws DLIException

Retrieves the value of the designated field in the DBArrayElementSet object as a boolean.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setBoolean

void setBoolean(java.lang.String fieldName,
                boolean value)
         throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a boolean.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getByte

byte getByte(java.lang.String fieldName)
      throws DLIException

Retrieves the value of the designated field in the segment of this DBArrayElementSet object as a byte.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setByte

void setByte(java.lang.String fieldName,
             byte value)
      throws DLIException

Sets the value of the designated field in the segment of this DBArrayElementSet object as a byte.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getInt

int getInt(java.lang.String fieldName)
    throws DLIException

Retrieves the value of the designated field in the segment of this DBArrayElementSet object as an int.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setInt

void setInt(java.lang.String fieldName,
            int value)
     throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as an int.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getShort

short getShort(java.lang.String fieldName)
        throws DLIException

Retrieves the value of the designated field in the DBArrayElementSet object as a short.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setShort

void setShort(java.lang.String fieldName,
              short value)
       throws DLIException

Sets the value of the designated field in the s DBArrayElementSet object as a short.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getLong

long getLong(java.lang.String fieldName)
      throws DLIException

Retrieves the value of the designated field in the DBArrayElementSet object as a long.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setLong

void setLong(java.lang.String fieldName,
             long value)
      throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a long.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getFloat

float getFloat(java.lang.String fieldName)
        throws DLIException

Retrieves the value of the designated field in the DBArrayElementSet object as a float.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setFloat

void setFloat(java.lang.String fieldName,
              float value)
       throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a float.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getDouble

double getDouble(java.lang.String fieldName)
          throws DLIException

Retrieves the value of the designated field in the DBArrayElementSet object as a double.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setDouble

void setDouble(java.lang.String fieldName,
               double value)
        throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a double.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getBytes

byte[] getBytes(java.lang.String fieldName)
         throws DLIException

Gets the value of the designated field in the DBArrayElementSet object as a byte array.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setBytes

void setBytes(java.lang.String fieldName,
              byte[] value)
       throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a byte array.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getString

java.lang.String getString(java.lang.String fieldName)
                    throws DLIException

Gets the value of the designated field in the DBArrayElementSet object as a java.lang.String.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setString

void setString(java.lang.String fieldName,
               java.lang.String value)
        throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a java.lang.String.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String fieldName)
                            throws DLIException

Retrieves the value of the designated field in the DBArrayElementSet object as a java.math.BigDecimal.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setBigDecimal

void setBigDecimal(java.lang.String fieldName,
                   java.math.BigDecimal value)
            throws DLIException

Sets the value of the field in the DBArrayElementSet object as a java.math.BigDecimal.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getDate

java.sql.Date getDate(java.lang.String fieldName)
               throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a java.sql.Date.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setDate

void setDate(java.lang.String fieldName,
             java.sql.Date value)
      throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a java.sql.Date.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getTime

java.sql.Time getTime(java.lang.String fieldName)
               throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a java.sql.Time.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setTime

void setTime(java.lang.String fieldName,
             java.sql.Time value)
      throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a java.sql.Time.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getTimestamp

java.sql.Timestamp getTimestamp(java.lang.String fieldName)
                         throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a java.sql.TimeStamp.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setTimestamp

void setTimestamp(java.lang.String fieldName,
                  java.sql.Timestamp value)
           throws DLIException

Sets the value of the designated field in the DBArrayElementSet object as a java.sql.TimeStamp.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

getObject

java.lang.Object getObject(java.lang.String fieldName)
                    throws DLIException

Retrieves the value of the designated field in the DBArrayElementSet object as an Object in the Java Programming Language.
This method will return the value of the given field as a Java object. The type of the Java object will be the default Java object type corresponding to the field's actual type.

Returns:

value of the field

Throws:

DLIException - if an error occurs

setObject

void setObject(java.lang.String fieldName,
               java.lang.Object value)
        throws DLIException

Sets the value of the designated field in the DBArrayElementSet object with the Object value.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs

prepareElementToAdd

void prepareElementToAdd()
                  throws DLIException

Moves the cursor to a new element that will be added to the element set after calling DBArrayElementSet.addElement. This method only needs to be called once prior to calling multiple DBArrayElementSet.addElement The current cursor position is remembered while the cursor is positioned on the new element. Calling DBArrayElementSet.moveToCurrentElement will restore the remembered cursor position. This method can only be called if the DBArray object is dynamic.

Throws:

DLIException

addElement

void addElement()
         throws DLIException

Adds the current element to the element set. This method can only be called if the DBArray object is dynamic.

Throws:

DLIException

removeElement

void removeElement()
            throws DLIException

Removes the current element. This method can only be called if the DBArray object is dynamic.

Throws:

DLIException

moveToCurrentElement

void moveToCurrentElement()
                   throws DLIException

Calling this method will restore the remembered cursor position after calling DBArrayElementSet.prepareElementToAdd This method can only be called if the DBArray object is dynamic.

Throws:

DLIException

getCurrentElementIndex

int getCurrentElementIndex()

Returns the current position in the element set

Returns:

the current element index.

Throws:

DLIException

size

int size()

Returns the number of elements within the element set

Returns:

the size of the element set

beforeFirst

void beforeFirst()
          throws DLIException

Positions the cursor to before the first element.

Throws:

DLIException

getMetaData

DBArrayElementSetMetaData getMetaData()
                               throws DLIException

This method will return the metadata of an array field represented by its DBArrayElementSet.

Returns:

DBArrayElementSetMetaData

Throws:

DLIException