wt.pds
Interface PersistentRetrieveIfc

All Known Implementing Classes:

AbstractPersistenceArray, AbstractPersistentRetrieve, DirectoryInputStream, DOMTreeDecoder, InfoEngineInputStream, PersistenceCloner, WTCallableStatement

public interface PersistentRetrieveIfc

PersistentRetrieveIfc specifies persistence interfaces to retrieve java types from persistent storage.

Field Summary

static String

versionID

Method Summary

void	close() Immediately release a ResultSet's datastore and connection resources
InputStream	getAsciiStream(String attributeName) Get the value of a column in the current row as a stream of ASCII characters.
BigDecimal	getBigDecimal(String attributeName) Get the value of a column in the current row as a BigDecimal
InputStream	getBinaryStream(String attributeName) Get the value of a column in the current row as a stream of uninterpreted bytes.
boolean	getBoolean(String attributeName) Get the value of a column in the current row as a Java boolean.
Boolean	getBooleanObject(String attributeName) Get the value of a column in the current row as a Boolean.
byte	getByte(String attributeName) Get the value of a column in the current row as a Java byte.
Byte	getByteObject(String attributeName) Get the value of a column in the current row as a Byte.
byte[]	getBytes(String attributeName) Get the value of a column in the current row as a Java byte array.
char	getChar(String attributeName) Get the value of a column in the current row as a Java char.
Character	getCharObject(String attributeName) Get the value of a column in the current row as a Character.
String	getContainer() Get the current container name.
Date	getDate(String attributeName) Get the value of a column in the current row as a java.sql.Date object.
double	getDouble(String attributeName) Get the value of a column in the current row as a Java double.
Double	getDoubleObject(String attributeName) Get the value of a column in the current row as a Double.
float	getFloat(String attributeName) Get the value of a column in the current row as a Java float.
Float	getFloatObject(String attributeName) Get the value of a column in the current row as a Float.
Object	getInlineObject(String attributeName, String blobAttributeName) Get the value of a blob column as a Java Object.
int	getInt(String attributeName) Get the value of a column in the current row as a Java int.
Integer	getIntObject(String attributeName) Get the value of a column in the current row as an Integer.
LobLocator	getLobLocator(String attributeName) Get a LobLocator for the given attribute.
long	getLong(String attributeName) Get the value of a column in the current row as a Java long.
Long	getLongObject(String attributeName) Get the value of a column in the current row as a Long.
Object	getObject(String attributeName) Get the value of a column in the current row as a Java object.
short	getShort(String attributeName) Get the value of a column in the current row as a Java short.
Short	getShortObject(String attributeName) Get the value of a column in the current row as a Short.
Object	getSmallObject(String attributeName) Get the value of a column in the current row as a Java object.
String	getString(String attributeName) Get the value of a column in the current row as a Java String.
Time	getTime(String attributeName) Get the value of a column in the current row as a java.sql.Time object.
Timestamp	getTimestamp(String attributeName) Get the value of a column in the current row as a java.sql.Timestamp object.
InputStream	getUnicodeStream(String attributeName) Get the value of a column in the current row as a stream of Unicode characters and then read in chunks.
boolean	next() A ResultSet is initially positioned before its first row; the first call to next makes the first row the current row; the second call makes the second row the current row, etc.
ObjectMappable	readObject(String attribute_name, ObjectMappable obj, Class concrete_class, boolean isRequired) Get the values corresponding to a nested ObjectMappable Object.
boolean	wasNull() A column may have the value of SQL NULL; wasNull reports whether the last column read had this special value.

Field Detail

versionID

public static final String versionID

See Also:

Constant Field Values

Method Detail

getAsciiStream

public InputStream getAsciiStream(String attributeName)
                           throws SQLException

Get the value of a column in the current row as a stream of ASCII characters.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

getBigDecimal

public BigDecimal getBigDecimal(String attributeName)
                         throws SQLException

Get the value of a column in the current row as a BigDecimal

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

getBinaryStream

public InputStream getBinaryStream(String attributeName)
                            throws SQLException

Get the value of a column in the current row as a stream of uninterpreted bytes.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

getBoolean

public boolean getBoolean(String attributeName)
                   throws SQLException

Get the value of a column in the current row as a Java boolean.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is false

Throws:

SQLException - if a database-access error occurs.

getBooleanObject

public Boolean getBooleanObject(String attributeName)
                         throws SQLException

Get the value of a column in the current row as a Boolean.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, then null is returned

Throws:

SQLException - if a database-access error occurs.

getByte

public byte getByte(String attributeName)
             throws SQLException

Get the value of a column in the current row as a Java byte.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is 0

Throws:

SQLException - if a database-access error occurs.

getByteObject

public Byte getByteObject(String attributeName)
                   throws SQLException

Get the value of a column in the current row as a Byte.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, then null is returned

Throws:

SQLException - if a database-access error occurs.

getBytes

public byte[] getBytes(String attributeName)
                throws SQLException,
                       DatastoreException

Get the value of a column in the current row as a Java byte array.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

DatastoreException

getChar

public char getChar(String attributeName)
             throws SQLException

Get the value of a column in the current row as a Java char.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is 0

Throws:

SQLException - if a database-access error occurs.

getCharObject

public Character getCharObject(String attributeName)
                        throws SQLException

Get the value of a column in the current row as a Character.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, then null is returned

Throws:

SQLException - if a database-access error occurs.

getDate

public Date getDate(String attributeName)
             throws SQLException

Get the value of a column in the current row as a java.sql.Date object.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

getDouble

public double getDouble(String attributeName)
                 throws SQLException

Get the value of a column in the current row as a Java double.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is 0

Throws:

SQLException - if a database-access error occurs.

getDoubleObject

public Double getDoubleObject(String attributeName)
                       throws SQLException

Get the value of a column in the current row as a Double.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, then null is returned

Throws:

SQLException - if a database-access error occurs.

getFloat

public float getFloat(String attributeName)
               throws SQLException

Get the value of a column in the current row as a Java float.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is 0

Throws:

SQLException - if a database-access error occurs.

getFloatObject

public Float getFloatObject(String attributeName)
                     throws SQLException

Get the value of a column in the current row as a Float.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, then null is returned

Throws:

SQLException - if a database-access error occurs.

getInlineObject

public Object getInlineObject(String attributeName,
                              String blobAttributeName)
                       throws SQLException,
                              DatastoreException

Get the value of a blob column as a Java Object.

Parameters:

attributeName - a class attribute name

blobAttributeName - a blob attribute name

Throws:

SQLException - if a database-access error occurs.

PersistenceException - if a database-access error occurs.

DatastoreException

getInt

public int getInt(String attributeName)
           throws SQLException

Get the value of a column in the current row as a Java int.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is 0

Throws:

SQLException - if a database-access error occurs.

getIntObject

public Integer getIntObject(String attributeName)
                     throws SQLException

Get the value of a column in the current row as an Integer.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, then null is returned

Throws:

SQLException - if a database-access error occurs.

getLong

public long getLong(String attributeName)
             throws SQLException

Get the value of a column in the current row as a Java long.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is 0

Throws:

SQLException - if a database-access error occurs.

getLongObject

public Long getLongObject(String attributeName)
                   throws SQLException

Get the value of a column in the current row as a Long.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, then null is returned

Throws:

SQLException - if a database-access error occurs.

getObject

public Object getObject(String attributeName)
                 throws SQLException,
                        DatastoreException

Get the value of a column in the current row as a Java object.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

DatastoreException

getSmallObject

public Object getSmallObject(String attributeName)
                      throws SQLException,
                             DatastoreException

Get the value of a column in the current row as a Java object.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

DatastoreException

getShort

public short getShort(String attributeName)
               throws SQLException

Get the value of a column in the current row as a Java short.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is 0

Throws:

SQLException - if a database-access error occurs.

getShortObject

public Short getShortObject(String attributeName)
                     throws SQLException

Get the value of a column in the current row as a Short.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, then null is returned

Throws:

SQLException - if a database-access error occurs.

getString

public String getString(String attributeName)
                 throws SQLException

Get the value of a column in the current row as a Java String.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

getTime

public Time getTime(String attributeName)
             throws SQLException

Get the value of a column in the current row as a java.sql.Time object.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

getTimestamp

public Timestamp getTimestamp(String attributeName)
                       throws SQLException

Get the value of a column in the current row as a java.sql.Timestamp object.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

getUnicodeStream

public InputStream getUnicodeStream(String attributeName)
                             throws SQLException

Get the value of a column in the current row as a stream of Unicode characters and then read in chunks.

Parameters:

attributeName - a class attribute name

Returns:

the column value; if the value is SQL NULL, the result is null

Throws:

SQLException - if a database-access error occurs.

getLobLocator

public LobLocator getLobLocator(String attributeName)
                         throws SQLException,
                                DatastoreException

Get a LobLocator for the given attribute.

Parameters:

attributeName - a class attribute name

Throws:

SQLException - if a database-access error occurs.

DatastoreException

readObject

public ObjectMappable readObject(String attribute_name,
                                 ObjectMappable obj,
                                 Class concrete_class,
                                 boolean isRequired)
                          throws SQLException,
                                 DatastoreException

Get the values corresponding to a nested ObjectMappable Object. This results in a call to the nested object's readExternal method.

Parameters:

attribute_name - a class attribute name

obj - the nested object

concrete_class - the class to instantiate if needed

Throws:

SQLException - if a database-access error occurs.

DatastoreException - if any other internal error occurs.

getContainer

public String getContainer()

Get the current container name. The container name is set by calls to readObject.

Returns:

the current container name

next

public boolean next()
             throws SQLException

A ResultSet is initially positioned before its first row; the first call to next makes the first row the current row; the second call makes the second row the current row, etc.

Returns:

true if new row is valid, false if there are no more rows

Throws:

SQLException - if a database-access error occurs.

close

public void close()
           throws SQLException

Immediately release a ResultSet's datastore and connection resources

Throws:

SQLException - if a database-access error occurs.

wasNull

public boolean wasNull()
                throws SQLException

A column may have the value of SQL NULL; wasNull reports whether the last column read had this special value. Note that you must first call getXXX on a column to try to read its value and then call wasNull() to find if the value was the SQL NULL.

Returns:

true if last column was a null value

Throws:

SQLException - if a database-access error occurs.