wt.pds
Interface PersistentStoreIfc

All Known Implementing Classes:

AbstractPersistenceArray, AbstractPersistentStore, DOMTreeEncoder, ObjectAttributeTable, ObjectOutputTable, PersistenceCloner

public interface PersistentStoreIfc

Field Summary

static String

versionID

Method Summary

String	getContainer() Get the current container name.
void	setAsciiStream(String attributeName, InputStream aStream, int len) Set the value to an ascii stream.
void	setBigDecimal(String attributeName, BigDecimal aBigDecimal) Set the value to a BigDecimal.
void	setBinaryStream(String attributeName, InputStream aStream, int len) Set the value to a binary stream.
void	setBoolean(String attributeName, boolean aBool) Set the value to a Java boolean.
void	setBooleanObject(String attributeName, Boolean aBool) Set the value to a Boolean.
void	setByte(String attributeName, byte aByte) Set the value to a Java byte.
void	setByteObject(String attributeName, Byte aByte) Set the value to a Byte.
void	setBytes(String attributeName, byte[] bArray) Set the value to a Java byte array.
void	setChar(String attributeName, char aChar) Set the value to a Java char.
void	setCharObject(String attributeName, Character aChar) Set the value to a Character.
void	setDate(String attributeName, Date aDate) Set the value to a java.util.Date.
void	setDouble(String attributeName, double aDbl) Set the value to a Java double.
void	setDoubleObject(String attributeName, Double aDbl) Set the value to a Double.
void	setFloat(String attributeName, float aFloat) Set the value to a Java float.
void	setFloatObject(String attributeName, Float aFloat) Set the value to a Float.
void	setInlineObject(String attributeName, String blobAttributeName, Serializable anObj) Set the value to a Java Serializable Object.
void	setInt(String attributeName, int anInt) Set the value to a Java int.
void	setIntObject(String attributeName, Integer anInt) Set the value to a Integer.
void	setLobLocator(String attributeName, LobLocator aLL) Set the value to a Lob locator.
void	setLong(String attributeName, long aLong) Set the value to a Java long.
void	setLongObject(String attributeName, Long aLong) Set the value to a Long.
void	setNull(String attributeName, int sqltype) Set the value to a null.
void	setObject(String attributeName, Object anObj) Set the value to a Java object.
void	setShort(String attributeName, short aShort) Set the value to a Java short.
void	setShortObject(String attributeName, Short aShort) Set the value to a Short.
void	setSmallObject(String attributeName, Serializable anObj) Set the value to a Java object.
void	setString(String attributeName, String aString) Set the value to a Java String.
void	setTime(String attributeName, Time aTime) Set the value to a Java Timee.
void	setTimestamp(String attributeName, Timestamp aTimestamp) Set the value to a Java Timestamp.
void	setUnicodeStream(String attributeName, InputStream aStream, int len) Set the value to a Java Unicode stream.
void	writeObject(String attribute_name, ObjectMappable obj, Class concrete_class, boolean isRequired) Set the values corresponding to a nested ObjectMappable Object.

Field Detail

versionID

public static final String versionID

See Also:

Constant Field Values

Method Detail

setAsciiStream

public void setAsciiStream(String attributeName,
                           InputStream aStream,
                           int len)
                    throws SQLException

Set the value to an ascii stream. This maps to SQL type LONGVARCHAR.

Parameters:

attributeName - a class attribute name

aStream - the parameter value

len - the length of the input stream

Throws:

SQLException - if a database-access error occurs.

setBigDecimal

public void setBigDecimal(String attributeName,
                          BigDecimal aBigDecimal)
                   throws SQLException

Set the value to a BigDecimal. This maps to SQL type Number(precision,scale).

Parameters:

attributeName - a class attribute name

aBigDecimal - the parameter value

Throws:

SQLException - if a database-access error occurs.

setBinaryStream

public void setBinaryStream(String attributeName,
                            InputStream aStream,
                            int len)
                     throws SQLException

Set the value to a binary stream. This maps to SQL type LONGVARBINARY

Parameters:

attributeName - a class attribute name

aStream - the parameter value

len - the length of the input stream

Throws:

SQLException - if a database-access error occurs.

setBoolean

public void setBoolean(String attributeName,
                       boolean aBool)
                throws SQLException

Set the value to a Java boolean. This maps to SQL type BIT

Parameters:

attributeName - a class attribute name

aBool - the parameter value

Throws:

SQLException - if a database-access error occurs.

setBooleanObject

public void setBooleanObject(String attributeName,
                             Boolean aBool)
                      throws SQLException

Set the value to a Boolean. This maps to SQL type BIT

Parameters:

attributeName - a class attribute name

aBool - the parameter value

Throws:

SQLException - if a database-access error occurs.

setByte

public void setByte(String attributeName,
                    byte aByte)
             throws SQLException

Set the value to a Java byte. This maps to SQL type TINYINT

Parameters:

attributeName - a class attribute name

aByte - the parameter value

Throws:

SQLException - if a database-access error occurs.

setByteObject

public void setByteObject(String attributeName,
                          Byte aByte)
                   throws SQLException

Set the value to a Byte. This maps to SQL type TINYINT

Parameters:

attributeName - a class attribute name

aByte - the parameter value

Throws:

SQLException - if a database-access error occurs.

setBytes

public void setBytes(String attributeName,
                     byte[] bArray)
              throws SQLException

Set the value to a Java byte array. This maps to either SQL type LONGVARBINARY or BLOB

Parameters:

attributeName - a class attribute name

bArray - the parameter value

Throws:

SQLException - if a database-access error occurs.

setChar

public void setChar(String attributeName,
                    char aChar)
             throws SQLException

Set the value to a Java char. This maps to SQL type CHAR(1)

Parameters:

attributeName - a class attribute name

aChar - the parameter value

Throws:

SQLException - if a database-access error occurs.

setCharObject

public void setCharObject(String attributeName,
                          Character aChar)
                   throws SQLException

Set the value to a Character. This maps to SQL type CHAR(1)

Parameters:

attributeName - a class attribute name

aChar - the parameter value

Throws:

SQLException - if a database-access error occurs.

setDate

public void setDate(String attributeName,
                    Date aDate)
             throws SQLException

Set the value to a java.util.Date. This maps to SQL type DATE

Parameters:

attributeName - a class attribute name

aDate - the parameter value

Throws:

SQLException - if a database-access error occurs.

setDouble

public void setDouble(String attributeName,
                      double aDbl)
               throws SQLException

Set the value to a Java double. This maps to SQL type DOUBLE

Parameters:

attributeName - a class attribute name

aDbl - the parameter value

Throws:

SQLException - if a database-access error occurs.

setDoubleObject

public void setDoubleObject(String attributeName,
                            Double aDbl)
                     throws SQLException

Set the value to a Double. This maps to SQL type DOUBLE

Parameters:

attributeName - a class attribute name

aDbl - the parameter value

Throws:

SQLException - if a database-access error occurs.

setFloat

public void setFloat(String attributeName,
                     float aFloat)
              throws SQLException

Set the value to a Java float. This maps to SQL type FLOAT

Parameters:

attributeName - a class attribute name

aFloat - the parameter value

Throws:

SQLException - if a database-access error occurs.

setFloatObject

public void setFloatObject(String attributeName,
                           Float aFloat)
                    throws SQLException

Set the value to a Float. This maps to SQL type FLOAT

Parameters:

attributeName - a class attribute name

aFloat - the parameter value

Throws:

SQLException - if a database-access error occurs.

setInlineObject

public void setInlineObject(String attributeName,
                            String blobAttributeName,
                            Serializable anObj)
                     throws SQLException,
                            DatastoreException

Set the value to a Java Serializable Object.

Parameters:

attributeName - a class attribute name

blobAttributeName - a blob attribute name

anObj - the serializable object

Throws:

SQLException - if a database-access error occurs.

PersistenceException - if a database-access error occurs.

DatastoreException

setInt

public void setInt(String attributeName,
                   int anInt)
            throws SQLException

Set the value to a Java int. This maps to SQL type INTEGER

Parameters:

attributeName - a class attribute name

anInt - the parameter value

Throws:

SQLException - if a database-access error occurs.

setIntObject

public void setIntObject(String attributeName,
                         Integer anInt)
                  throws SQLException

Set the value to a Integer. This maps to SQL type INTEGER

Parameters:

attributeName - a class attribute name

anInt - the parameter value

Throws:

SQLException - if a database-access error occurs.

setLong

public void setLong(String attributeName,
                    long aLong)
             throws SQLException

Set the value to a Java long. This maps to SQL type BIGINT

Parameters:

attributeName - a class attribute name

aLong - the parameter value

Throws:

SQLException - if a database-access error occurs.

setLongObject

public void setLongObject(String attributeName,
                          Long aLong)
                   throws SQLException

Set the value to a Long. This maps to SQL type BIGINT

Parameters:

attributeName - a class attribute name

aLong - the parameter value

Throws:

SQLException - if a database-access error occurs.

setNull

public void setNull(String attributeName,
                    int sqltype)
             throws SQLException

Set the value to a null. This maps to SQL type SQLNULL

Parameters:

attributeName - a class attribute name

sqltype - the SQL type of the attribute

Throws:

SQLException - if a database-access error occurs.

setObject

public void setObject(String attributeName,
                      Object anObj)
               throws SQLException

Set the value to a Java object. This maps to SQL type LONGVARBINARY or BLOB.

Parameters:

attributeName - a class attribute name

anObj - the parameter value

Throws:

SQLException - if a database-access error occurs.

setSmallObject

public void setSmallObject(String attributeName,
                           Serializable anObj)
                    throws SQLException,
                           DatastoreException

Set the value to a Java object. This maps to SQL type LONGVARBINARY or BLOB.

Parameters:

attributeName - a class attribute name

anObj - the parameter value

Throws:

SQLException - if a database-access error occurs.

DatastoreException

setShort

public void setShort(String attributeName,
                     short aShort)
              throws SQLException

Set the value to a Java short. This maps to SQL type SMALLINT

Parameters:

attributeName - a class attribute name

aShort - the parameter value

Throws:

SQLException - if a database-access error occurs.

setShortObject

public void setShortObject(String attributeName,
                           Short aShort)
                    throws SQLException

Set the value to a Short. This maps to SQL type SMALLINT

Parameters:

attributeName - a class attribute name

aShort - the parameter value

Throws:

SQLException - if a database-access error occurs.

setString

public void setString(String attributeName,
                      String aString)
               throws SQLException

Set the value to a Java String. This maps to SQL type VARCHAR

Parameters:

attributeName - a class attribute name

aString - the parameter value

Throws:

SQLException - if a database-access error occurs.

setTime

public void setTime(String attributeName,
                    Time aTime)
             throws SQLException

Set the value to a Java Timee. This maps to SQL type TIME

Parameters:

attributeName - a class attribute name

aTime - the parameter value

Throws:

SQLException - if a database-access error occurs.

setTimestamp

public void setTimestamp(String attributeName,
                         Timestamp aTimestamp)
                  throws SQLException

Set the value to a Java Timestamp. This maps to SQL type TIMESTAMP

Parameters:

attributeName - a class attribute name

aTimestamp - the parameter value

Throws:

SQLException - if a database-access error occurs.

setUnicodeStream

public void setUnicodeStream(String attributeName,
                             InputStream aStream,
                             int len)
                      throws SQLException

Set the value to a Java Unicode stream. This maps to SQL type LONGVARCHAR

Parameters:

attributeName - a class attribute name

aStream - the parameter value

Throws:

SQLException - if a database-access error occurs.

setLobLocator

public void setLobLocator(String attributeName,
                          LobLocator aLL)
                   throws SQLException

Set the value to a Lob locator.

Parameters:

attributeName - a class attribute name

aLL - the parameter value

Throws:

SQLException - if a database-access error occurs.

writeObject

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

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

Parameters:

attribute_name - a class attribute name

obj - the nested object

concrete_class - the class of the object (in case obj is null)

Throws:

SQLException - if a database-access error occurs.

DatastoreException

getContainer

public String getContainer()

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

Returns:

the current container name