public interface Row
UpdateManager
is responsible for
implementing rows to do something useful when the values are set.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.
|
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.
|
static final int ACTION_UNKNOWN
static final int ACTION_UPDATE
static final int ACTION_INSERT
static final int ACTION_DELETE
Table getTable()
int getAction()
Object getFailedObject()
void setFailedObject(Object failed)
boolean isValid()
void setValid(boolean valid)
OpenJPAStateManager getPrimaryKey()
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.void setPrimaryKey(OpenJPAStateManager sm) throws SQLException
SQLException
void setPrimaryKey(ColumnIO io, OpenJPAStateManager sm) throws SQLException
io
- information on which columns are settable; may be nullSQLException
void wherePrimaryKey(OpenJPAStateManager sm) throws SQLException
SQLException
void setForeignKey(ForeignKey fk, OpenJPAStateManager sm) throws SQLException
SQLException
void setForeignKey(ForeignKey fk, ColumnIO io, OpenJPAStateManager sm) throws SQLException
io
- information on which columns are settable; may be nullSQLException
void whereForeignKey(ForeignKey fk, OpenJPAStateManager sm) throws SQLException
SQLException
void setArray(Column col, Array val) throws SQLException
SQLException
void setAsciiStream(Column col, InputStream val, int length) throws SQLException
SQLException
void setBigDecimal(Column col, BigDecimal val) throws SQLException
SQLException
void setBigInteger(Column col, BigInteger val) throws SQLException
SQLException
void setBinaryStream(Column col, InputStream val, int length) throws SQLException
SQLException
void setBlob(Column col, Blob val) throws SQLException
SQLException
void setBoolean(Column col, boolean val) throws SQLException
SQLException
void setByte(Column col, byte val) throws SQLException
SQLException
void setBytes(Column col, byte[] val) throws SQLException
SQLException
void setCalendar(Column col, Calendar val) throws SQLException
SQLException
void setChar(Column col, char val) throws SQLException
SQLException
void setCharacterStream(Column col, Reader val, int length) throws SQLException
SQLException
void setClob(Column col, Clob val) throws SQLException
SQLException
void setDate(Column col, Date val) throws SQLException
SQLException
void setDate(Column col, Date val, Calendar cal) throws SQLException
SQLException
void setDouble(Column col, double val) throws SQLException
SQLException
void setFloat(Column col, float val) throws SQLException
SQLException
void setInt(Column col, int val) throws SQLException
SQLException
void setLong(Column col, long val) throws SQLException
SQLException
void setLocale(Column col, Locale val) throws SQLException
SQLException
void setNull(Column col) throws SQLException
SQLException
void setNull(Column col, boolean overrideDefault) throws SQLException
overrideDefault
- whether to set this column to null even if this
is an insert and the column has a defaultSQLException
void setNumber(Column col, Number val) throws SQLException
SQLException
void setObject(Column col, Object val) throws SQLException
col
- the column being setval
- the value for the columnSQLException
void setRaw(Column col, String value) throws SQLException
SQLException
void setRelationId(Column col, OpenJPAStateManager sm, RelationId rel) throws SQLException
SQLException
void setShort(Column col, short val) throws SQLException
SQLException
void setString(Column col, String val) throws SQLException
SQLException
void setTime(Column col, Time val, Calendar cal) throws SQLException
SQLException
void setTimestamp(Column col, Timestamp val, Calendar cal) throws SQLException
SQLException
void whereArray(Column col, Array val) throws SQLException
SQLException
void whereAsciiStream(Column col, InputStream val, int length) throws SQLException
SQLException
void whereBigDecimal(Column col, BigDecimal val) throws SQLException
SQLException
void whereBigInteger(Column col, BigInteger val) throws SQLException
SQLException
void whereBinaryStream(Column col, InputStream val, int length) throws SQLException
SQLException
void whereBlob(Column col, Blob val) throws SQLException
SQLException
void whereBoolean(Column col, boolean val) throws SQLException
SQLException
void whereByte(Column col, byte val) throws SQLException
SQLException
void whereBytes(Column col, byte[] val) throws SQLException
SQLException
void whereCalendar(Column col, Calendar val) throws SQLException
SQLException
void whereChar(Column col, char val) throws SQLException
SQLException
void whereCharacterStream(Column col, Reader val, int length) throws SQLException
SQLException
void whereClob(Column col, Clob val) throws SQLException
SQLException
void whereDate(Column col, Date val) throws SQLException
SQLException
void whereDate(Column col, Date val, Calendar cal) throws SQLException
SQLException
void whereDouble(Column col, double val) throws SQLException
SQLException
void whereFloat(Column col, float val) throws SQLException
SQLException
void whereInt(Column col, int val) throws SQLException
SQLException
void whereLong(Column col, long val) throws SQLException
SQLException
void whereLocale(Column col, Locale val) throws SQLException
SQLException
void whereNull(Column col) throws SQLException
SQLException
void whereNumber(Column col, Number val) throws SQLException
SQLException
void whereObject(Column col, Object val) throws SQLException
col
- the column being setval
- the value for the columnSQLException
void whereRaw(Column col, String value) throws SQLException
SQLException
void whereShort(Column col, short val) throws SQLException
SQLException
void whereString(Column col, String val) throws SQLException
SQLException
void whereTime(Column col, Time val, Calendar cal) throws SQLException
SQLException
void whereTimestamp(Column col, Timestamp val, Calendar cal) throws SQLException
SQLException
Copyright © 2006–2018 Apache Software Foundation. All rights reserved.