org.apache.openjpa.jdbc.sql

Interface Row

All Known Implementing Classes:

PrimaryRow, RowImpl, SecondaryRow, StateComparisonVersionStrategy.CustomUpdate

public interface Row

Logical representation of a table row for insert/update/delete. The UpdateManager is responsible for implementing rows to do something useful when the values are set.

Author:

Abe White

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_DELETE Mark the row for deletion.
static int	ACTION_INSERT Mark the row for inserttion.
static int	ACTION_UNKNOWN Symbolic constant reserved for situations when a row operation is unknown.
static int	ACTION_UPDATE Mark the row for update.

Method Summary

Modifier and Type	Method and Description
int	getAction() Return the action for this row.
Object	getFailedObject() Return the failed object to include in optimistic lock exceptions.
OpenJPAStateManager	getPrimaryKey() Return the instance that controls this row.
Table	getTable() Return the table for this row.
boolean	isValid() Whether this row has information set on it.
void	setArray(Column col, Array val) Set the value of the given column in this row.
void	setAsciiStream(Column col, InputStream val, int length) Set the value of the given column in this row.
void	setBigDecimal(Column col, BigDecimal val) Set the value of the given column in this row.
void	setBigInteger(Column col, BigInteger val) Set the value of the given column in this row.
void	setBinaryStream(Column col, InputStream val, int length) Set the value of the given column in this row.
void	setBlob(Column col, Blob val) Set the value of the given column in this row.
void	setBoolean(Column col, boolean val) Set the value of the given column in this row.
void	setByte(Column col, byte val) Set the value of the given column in this row.
void	setBytes(Column col, byte[] val) Set the value of the given column in this row.
void	setCalendar(Column col, Calendar val) Set the value of the given column in this row.
void	setChar(Column col, char val) Set the value of the given column in this row.
void	setCharacterStream(Column col, Reader val, int length) Set the value of the given column in this row.
void	setClob(Column col, Clob val) Set the value of the given column in this row.
void	setDate(Column col, Date val) Set the value of the given column in this row.
void	setDate(Column col, Date val, Calendar cal) Set the value of the given column in this row.
void	setDouble(Column col, double val) Set the value of the given column in this row.
void	setFailedObject(Object failed) Set the failed object to include in the optimistic lock exception that will be thrown if this update results in an update count of 0 when executed.
void	setFloat(Column col, float val) Set the value of the given column in this row.
void	setForeignKey(ForeignKey fk, ColumnIO io, OpenJPAStateManager sm) Set the value of the given foreign key to the given object.
void	setForeignKey(ForeignKey fk, OpenJPAStateManager sm) Set the value of the given foreign key to the given object.
void	setInt(Column col, int val) Set the value of the given column in this row.
void	setLocale(Column col, Locale val) Set the value of the given column in this row.
void	setLong(Column col, long val) Set the value of the given column in this row.
void	setNull(Column col) Set the value of the given column in this row.
void	setNull(Column col, boolean overrideDefault) Set the value of the given column in this row.
void	setNumber(Column col, Number val) Set the value of the given column in this row.
void	setObject(Column col, Object val) Set the value of the given column in this row.
void	setPrimaryKey(ColumnIO io, OpenJPAStateManager sm) Set the primary key to represent the given object.
void	setPrimaryKey(OpenJPAStateManager sm) Set the primary key to represent the given object.
void	setRaw(Column col, String value) Set a DB understood value for the given column.
void	setRelationId(Column col, OpenJPAStateManager sm, RelationId rel) Set the value of the given column to the identity of given instance, using the given callback to create the column value.
void	setShort(Column col, short val) Set the value of the given column in this row.
void	setString(Column col, String val) Set the value of the given column in this row.
void	setTime(Column col, Time val, Calendar cal) Set the value of the given column in this row.
void	setTimestamp(Column col, Timestamp val, Calendar cal) Set the value of the given column in this row.
void	setValid(boolean valid) Whether this row has information set on it.
void	whereArray(Column col, Array val) Set an equality condition on the value of the given column in this row.
void	whereAsciiStream(Column col, InputStream val, int length) Set an equality condition on the value of the given column in this row.
void	whereBigDecimal(Column col, BigDecimal val) Set an equality condition on the value of the given column in this row.
void	whereBigInteger(Column col, BigInteger val) Set an equality condition on the value of the given column in this row.
void	whereBinaryStream(Column col, InputStream val, int length) Set an equality condition on the value of the given column in this row.
void	whereBlob(Column col, Blob val) Set an equality condition on the value of the given column in this row.
void	whereBoolean(Column col, boolean val) Set an equality condition on the value of the given column in this row.
void	whereByte(Column col, byte val) Set an equality condition on the value of the given column in this row.
void	whereBytes(Column col, byte[] val) Set an equality condition on the value of the given column in this row.
void	whereCalendar(Column col, Calendar val) Set an equality condition on the value of the given column in this row.
void	whereChar(Column col, char val) Set an equality condition on the value of the given column in this row.
void	whereCharacterStream(Column col, Reader val, int length) Set an equality condition on the value of the given column in this row.
void	whereClob(Column col, Clob val) Set an equality condition on the value of the given column in this row.
void	whereDate(Column col, Date val) Set an equality condition on the value of the given column in this row.
void	whereDate(Column col, Date val, Calendar cal) Set an equality condition on the value of the given column in this row.
void	whereDouble(Column col, double val) Set an equality condition on the value of the given column in this row.
void	whereFloat(Column col, float val) Set an equality condition on the value of the given column in this row.
void	whereForeignKey(ForeignKey fk, OpenJPAStateManager sm) Set the foreign key equality criteria to link to the given object.
void	whereInt(Column col, int val) Set an equality condition on the value of the given column in this row.
void	whereLocale(Column col, Locale val) Set an equality condition on the value of the given column in this row.
void	whereLong(Column col, long val) Set an equality condition on the value of the given column in this row.
void	whereNull(Column col) Set an equality condition on the value of the given column in this row.
void	whereNumber(Column col, Number val) Set an equality condition on the value of the given column in this row.
void	whereObject(Column col, Object val) Set an equality condition on the value of the given column in this row.
void	wherePrimaryKey(OpenJPAStateManager sm) Set the primary key equality criteria for this row.
void	whereRaw(Column col, String value) Set a DB understood where condition for the given column.
void	whereShort(Column col, short val) Set an equality condition on the value of the given column in this row.
void	whereString(Column col, String val) Set an equality condition on the value of the given column in this row.
void	whereTime(Column col, Time val, Calendar cal) Set an equality condition on the value of the given column in this row.
void	whereTimestamp(Column col, Timestamp val, Calendar cal) Set an equality condition on the value of the given column in this row.

Field Detail

ACTION_UNKNOWN

static final int ACTION_UNKNOWN

Symbolic constant reserved for situations when a row operation is unknown.

See Also:

Constant Field Values

ACTION_UPDATE

static final int ACTION_UPDATE

Mark the row for update.

See Also:

Constant Field Values

ACTION_INSERT

static final int ACTION_INSERT

Mark the row for inserttion.

See Also:

Constant Field Values

ACTION_DELETE

static final int ACTION_DELETE

Mark the row for deletion.

See Also:

Constant Field Values

Method Detail

getTable

Table getTable()

Return the table for this row.

getAction

int getAction()

Return the action for this row.

getFailedObject

Object getFailedObject()

Return the failed object to include in optimistic lock exceptions.

setFailedObject

void setFailedObject(Object failed)

Set the failed object to include in the optimistic lock exception that will be thrown if this update results in an update count of 0 when executed. Leave null to avoid checking the update count.

isValid

boolean isValid()

Whether this row has information set on it.

setValid

void setValid(boolean valid)

Whether this row has information set on it.

getPrimaryKey

OpenJPAStateManager getPrimaryKey()

Return the instance that controls this row. The setPrimaryKey(org.apache.openjpa.kernel.OpenJPAStateManager) method does not necessarily have to be called to know the owning instance, nor does this row's table have to have an actual primary key.

setPrimaryKey

void setPrimaryKey(OpenJPAStateManager sm)
            throws SQLException

Set the primary key to represent the given object.

Throws:

SQLException

setPrimaryKey

void setPrimaryKey(ColumnIO io,
                   OpenJPAStateManager sm)
            throws SQLException

Set the primary key to represent the given object.

Parameters:

io - information on which columns are settable; may be null

Throws:

SQLException

wherePrimaryKey

void wherePrimaryKey(OpenJPAStateManager sm)
              throws SQLException

Set the primary key equality criteria for this row.

Throws:

SQLException

setForeignKey

void setForeignKey(ForeignKey fk,
                   OpenJPAStateManager sm)
            throws SQLException

Set the value of the given foreign key to the given object. If the related type uses table-per-class mappings, the foreign key may be targeted at an independent superclass table.

Throws:

SQLException

setForeignKey

void setForeignKey(ForeignKey fk,
                   ColumnIO io,
                   OpenJPAStateManager sm)
            throws SQLException

Set the value of the given foreign key to the given object. If the related type uses table-per-class mappings, the foreign key may be targeted at an independent superclass table.

Parameters:

io - information on which columns are settable; may be null

Throws:

SQLException

whereForeignKey

void whereForeignKey(ForeignKey fk,
                     OpenJPAStateManager sm)
              throws SQLException

Set the foreign key equality criteria to link to the given object. If the related type uses table-per-class mappings, the foreign key may be targeted at an independent superclass table.

Throws:

SQLException

setArray

void setArray(Column col,
              Array val)
       throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setAsciiStream

void setAsciiStream(Column col,
                    InputStream val,
                    int length)
             throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setBigDecimal

void setBigDecimal(Column col,
                   BigDecimal val)
            throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setBigInteger

void setBigInteger(Column col,
                   BigInteger val)
            throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setBinaryStream

void setBinaryStream(Column col,
                     InputStream val,
                     int length)
              throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setBlob

void setBlob(Column col,
             Blob val)
      throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setBoolean

void setBoolean(Column col,
                boolean val)
         throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setByte

void setByte(Column col,
             byte val)
      throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setBytes

void setBytes(Column col,
              byte[] val)
       throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setCalendar

void setCalendar(Column col,
                 Calendar val)
          throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setChar

void setChar(Column col,
             char val)
      throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setCharacterStream

void setCharacterStream(Column col,
                        Reader val,
                        int length)
                 throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setClob

void setClob(Column col,
             Clob val)
      throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setDate

void setDate(Column col,
             Date val)
      throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setDate

void setDate(Column col,
             Date val,
             Calendar cal)
      throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setDouble

void setDouble(Column col,
               double val)
        throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setFloat

void setFloat(Column col,
              float val)
       throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setInt

void setInt(Column col,
            int val)
     throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setLong

void setLong(Column col,
             long val)
      throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setLocale

void setLocale(Column col,
               Locale val)
        throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setNull

void setNull(Column col)
      throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setNull

void setNull(Column col,
             boolean overrideDefault)
      throws SQLException

Set the value of the given column in this row.

Parameters:

overrideDefault - whether to set this column to null even if this is an insert and the column has a default

Throws:

SQLException

setNumber

void setNumber(Column col,
               Number val)
        throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setObject

void setObject(Column col,
               Object val)
        throws SQLException

Set the value of the given column in this row.

Parameters:

col - the column being set

val - the value for the column

Throws:

SQLException

setRaw

void setRaw(Column col,
            String value)
     throws SQLException

Set a DB understood value for the given column. The value will not be parameterized and instead be inserted as raw SQL.

Throws:

SQLException

setRelationId

void setRelationId(Column col,
                   OpenJPAStateManager sm,
                   RelationId rel)
            throws SQLException

Set the value of the given column to the identity of given instance, using the given callback to create the column value. This method is used for mappings that store some serialized form of id values, but must make sure that the related object's id is assigned (which might require an insert if the instance uses auto-increment) before it is serialized.

Throws:

SQLException

setShort

void setShort(Column col,
              short val)
       throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setString

void setString(Column col,
               String val)
        throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setTime

void setTime(Column col,
             Time val,
             Calendar cal)
      throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

setTimestamp

void setTimestamp(Column col,
                  Timestamp val,
                  Calendar cal)
           throws SQLException

Set the value of the given column in this row.

Throws:

SQLException

whereArray

void whereArray(Column col,
                Array val)
         throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereAsciiStream

void whereAsciiStream(Column col,
                      InputStream val,
                      int length)
               throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereBigDecimal

void whereBigDecimal(Column col,
                     BigDecimal val)
              throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereBigInteger

void whereBigInteger(Column col,
                     BigInteger val)
              throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereBinaryStream

void whereBinaryStream(Column col,
                       InputStream val,
                       int length)
                throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereBlob

void whereBlob(Column col,
               Blob val)
        throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereBoolean

void whereBoolean(Column col,
                  boolean val)
           throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereByte

void whereByte(Column col,
               byte val)
        throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereBytes

void whereBytes(Column col,
                byte[] val)
         throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereCalendar

void whereCalendar(Column col,
                   Calendar val)
            throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereChar

void whereChar(Column col,
               char val)
        throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereCharacterStream

void whereCharacterStream(Column col,
                          Reader val,
                          int length)
                   throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereClob

void whereClob(Column col,
               Clob val)
        throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereDate

void whereDate(Column col,
               Date val)
        throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereDate

void whereDate(Column col,
               Date val,
               Calendar cal)
        throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereDouble

void whereDouble(Column col,
                 double val)
          throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereFloat

void whereFloat(Column col,
                float val)
         throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereInt

void whereInt(Column col,
              int val)
       throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereLong

void whereLong(Column col,
               long val)
        throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereLocale

void whereLocale(Column col,
                 Locale val)
          throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereNull

void whereNull(Column col)
        throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereNumber

void whereNumber(Column col,
                 Number val)
          throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereObject

void whereObject(Column col,
                 Object val)
          throws SQLException

Set an equality condition on the value of the given column in this row.

Parameters:

col - the column being set

val - the value for the column

Throws:

SQLException

whereRaw

void whereRaw(Column col,
              String value)
       throws SQLException

Set a DB understood where condition for the given column. The value will not be parameterized and instead be inserted as raw SQL.

Throws:

SQLException

whereShort

void whereShort(Column col,
                short val)
         throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereString

void whereString(Column col,
                 String val)
          throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereTime

void whereTime(Column col,
               Time val,
               Calendar cal)
        throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException

whereTimestamp

void whereTimestamp(Column col,
                    Timestamp val,
                    Calendar cal)
             throws SQLException

Set an equality condition on the value of the given column in this row.

Throws:

SQLException