com.ibm.ims.dli

Interface DBStruct

public interface DBStruct

A DBStruct object contains a value for each attribute of the structured type that it represents. Use a DBStruct when a database description (DBD) contains a field with DATATYPE=STRUCT.

Your application must be written with an understanding of the Struct as it is defined in the target database, including the type mapping for each element of the Struct.

Method Summary

Modifier and Type	Method and Description
DBArray	getArray(java.lang.String fieldName) Retrieves the value of the designated field in the current element of the DBStruct object as a com.ibm.ims.dli.DBArray.
java.lang.Object[]	getAttributes() Retrieves and converts the ordered values of the attributes of the structured type that this DBStruct object represents.
java.math.BigDecimal	getBigDecimal(java.lang.String fieldName) Retrieves the value of the designated field in the DBStruct object as a java.math.BigDecimal.
boolean	getBoolean(java.lang.String fieldName) Retrieves the value of the designated field in the DBStruct object as a boolean.
byte	getByte(java.lang.String fieldName) Retrieves the value of the designated field in the segment of this DBStruct object as a byte.
byte[]	getBytes(java.lang.String fieldName) Gets the value of the designated field in the DBStruct object as a byte array.
java.sql.Date	getDate(java.lang.String fieldName) Sets the value of the designated field in the DBStruct object as a java.sql.Date.
double	getDouble(java.lang.String fieldName) Retrieves the value of the designated field in the DBStruct object as a double.
float	getFloat(java.lang.String fieldName) Retrieves the value of the designated field in the DBStruct object as a float.
int	getInt(java.lang.String fieldName) Retrieves the value of the designated field in the segment of this DBStruct object as an int.
long	getLong(java.lang.String fieldName) Retrieves the value of the designated field in the DBStruct object as a long.
java.lang.Object	getObject(java.lang.String fieldName) Retrieves the value of the designated field in the DBStruct object as an Object in the Java Programming Language.
short	getShort(java.lang.String fieldName) Retrieves the value of the designated field in the DBStruct object as a short.
java.lang.String	getString(java.lang.String fieldName) Gets the value of the designated field in the DBStruct object as a java.lang.String.
java.sql.Time	getTime(java.lang.String fieldName) Sets the value of the designated field in the DBStruct object as a java.sql.Time.
java.sql.Timestamp	getTimestamp(java.lang.String fieldName) Sets the value of the designated field in the DBStruct object as a java.sql.TimeStamp.
java.lang.String	getTypeName() Retrieves the type name of the structured type that this DBStruct object represents.
void	setArray(java.lang.String fieldName, DBArray value) Sets the value of the designated field in the DBStruct 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 DBStruct object as a java.math.BigDecimal.
void	setBoolean(java.lang.String fieldName, boolean value) Sets the value of the designated field in the DBStruct object as a boolean.
void	setByte(java.lang.String fieldName, byte value) Sets the value of the designated field in the segment of this DBStruct object as a byte.
void	setBytes(java.lang.String fieldName, byte[] value) Sets the value of the designated field in the DBStruct object as a byte array.
void	setDate(java.lang.String fieldName, java.sql.Date value) Sets the value of the designated field in the DBStruct object as a java.sql.Date.
void	setDouble(java.lang.String fieldName, double value) Sets the value of the designated field in the DBStruct object as a double.
void	setFloat(java.lang.String fieldName, float value) Sets the value of the designated field in the DBStruct object as a float.
void	setInt(java.lang.String fieldName, int value) Sets the value of the designated field in the DBStruct object as an int.
void	setLong(java.lang.String fieldName, long value) Sets the value of the designated field in the DBStruct object as a long.
void	setObject(java.lang.String fieldName, java.lang.Object value) Sets the value of the designated field in the DBStruct object with the Object value.
void	setShort(java.lang.String fieldName, short value) Sets the value of the designated field in the s DBStruct object as a short.
void	setString(java.lang.String fieldName, java.lang.String value) Sets the value of the designated field in the DBStruct 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 DBStruct 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 DBStruct object as a java.sql.TimeStamp.

Method Detail

getAttributes

java.lang.Object[] getAttributes()
                          throws DLIException

Retrieves and converts the ordered values of the attributes of the structured type that this DBStruct object represents. The driver processes and converts each attribute individually, based on the defined mapping for that attribute.

Returns:

an array containing the ordered attribute values

Throws:

DLIException - if an error occurs converting the attributes

getTypeName

java.lang.String getTypeName()

Retrieves the type name of the structured type that this DBStruct object represents.

Returns:

the fully-qualified type name in the format pcbName.segmentName.structName

getArray

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

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

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a boolean.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a byte.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as an int.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a short.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a long.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a float.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a double.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a byte array.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a java.lang.String.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a java.math.BigDecimal.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a java.sql.Date.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a java.sql.Time.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct object as a java.sql.TimeStamp.

Parameters:

fieldName - name of the field

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 DBStruct 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 DBStruct 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.

Parameters:

fieldName - name of the field

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 DBStruct object with the Object value.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if an error occurs