|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Result
A result from the execution of a query or stored procedure. This
interface is aligned closely with the ResultSet
, so you
can expect like-named methods to have similar semantics. However, the
interface has been distilled and simplified, so a result object could
easily mask information sources other than a result set.
For more flexible customization of data loading, see the
PCResultObjectProvider
.
ResultSetResult
Method Summary | |
---|---|
boolean |
absolute(int row)
Move to the given 0-based row in the result, or return false if the row does not exist. |
void |
close()
Free the resources used by this result; do not close the SQL connection. |
boolean |
contains(Column col,
Joins joins)
Return true if the given column is available in the result. |
boolean |
contains(java.lang.Object obj)
Return true if the given id or column is available in the result. |
boolean |
containsAll(Column[] cols,
Joins joins)
Return true if all the given columns are available in the result. |
boolean |
containsAll(java.lang.Object[] objs)
Return true if all the given ids or columns are available in the result. |
void |
endDataRequest()
Ends a data request. |
java.sql.Array |
getArray(Column col,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.sql.Array |
getArray(java.lang.Object obj)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
java.io.InputStream |
getAsciiStream(Column col,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.io.InputStream |
getAsciiStream(java.lang.Object obj)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
ClassMapping |
getBaseMapping()
If this is the result of a UNION used to select a hierarchy of mappings, the base mapping represented by the current row. |
java.math.BigDecimal |
getBigDecimal(Column col,
Joins joins)
Return the value stored in the given column. |
java.math.BigDecimal |
getBigDecimal(java.lang.Object obj)
Return the value stored in the given column or id. |
java.math.BigInteger |
getBigInteger(Column col,
Joins joins)
Return the value stored in the given column. |
java.math.BigInteger |
getBigInteger(java.lang.Object obj)
Return the value stored in the given column or id. |
java.io.InputStream |
getBinaryStream(Column col,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.io.InputStream |
getBinaryStream(java.lang.Object obj)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
java.sql.Blob |
getBlob(Column col,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.sql.Blob |
getBlob(java.lang.Object obj)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
boolean |
getBoolean(Column col,
Joins joins)
Return the value stored in the given column. |
boolean |
getBoolean(java.lang.Object obj)
Return the value stored in the given column or id. |
byte |
getByte(Column col,
Joins joins)
Return the value stored in the given column. |
byte |
getByte(java.lang.Object obj)
Return the value stored in the given column or id. |
byte[] |
getBytes(Column col,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
byte[] |
getBytes(java.lang.Object obj)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
java.util.Calendar |
getCalendar(Column col,
Joins joins)
Return the value stored in the given column. |
java.util.Calendar |
getCalendar(java.lang.Object obj)
Return the value stored in the given column or id. |
char |
getChar(Column col,
Joins joins)
Return the value stored in the given column. |
char |
getChar(java.lang.Object obj)
Return the value stored in the given column or id. |
java.io.Reader |
getCharacterStream(Column col,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.io.Reader |
getCharacterStream(java.lang.Object obj)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
java.sql.Clob |
getClob(Column col,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.sql.Clob |
getClob(java.lang.Object obj)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
java.sql.Date |
getDate(Column col,
java.util.Calendar cal,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.util.Date |
getDate(Column col,
Joins joins)
Return the value stored in the given column. |
java.util.Date |
getDate(java.lang.Object obj)
Return the value stored in the given column or id. |
java.sql.Date |
getDate(java.lang.Object obj,
java.util.Calendar cal)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
double |
getDouble(Column col,
Joins joins)
Return the value stored in the given column. |
double |
getDouble(java.lang.Object obj)
Return the value stored in the given column or id. |
java.lang.Object |
getEager(FieldMapping key)
The eager result for the given key, or null if none. |
float |
getFloat(Column col,
Joins joins)
Return the value stored in the given column. |
float |
getFloat(java.lang.Object obj)
Return the value stored in the given column or id. |
int |
getInt(Column col,
Joins joins)
Return the value stored in the given column. |
int |
getInt(java.lang.Object obj)
Return the value stored in the given column or id. |
java.io.InputStream |
getLOBStream(JDBCStore store,
java.lang.Object obj)
|
java.util.Locale |
getLocale(Column col,
Joins joins)
Return the value stored in the given column. |
java.util.Locale |
getLocale(java.lang.Object obj)
Return the value stored in the given column or id. |
long |
getLong(Column col,
Joins joins)
Return the value stored in the given column. |
long |
getLong(java.lang.Object obj)
Return the value stored in the given column or id. |
FieldMapping |
getMappedByFieldMapping()
If this is the result used to select a toMany relationship, the mappedByFieldMapping is field mapping representing the inverse relationship. |
java.lang.Object |
getMappedByValue()
If this is the result used to select a toMany relationship, the mappedByValue is value of the owner of the toMany relationship. |
java.lang.Number |
getNumber(Column col,
Joins joins)
Return the value stored in the given column. |
java.lang.Number |
getNumber(java.lang.Object obj)
Return the value stored in the given column or id. |
java.lang.Object |
getObject(Column col,
java.lang.Object arg,
Joins joins)
Return the value stored in the given column. |
java.lang.Object |
getObject(java.lang.Object obj,
int metaType,
java.lang.Object arg)
Return the value stored in the given column or id. |
java.sql.Ref |
getRef(Column col,
java.util.Map map,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.sql.Ref |
getRef(java.lang.Object obj,
java.util.Map map)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
short |
getShort(Column col,
Joins joins)
Return the value stored in the given column. |
short |
getShort(java.lang.Object obj)
Return the value stored in the given column or id. |
java.lang.Object |
getSQLObject(Column col,
java.util.Map map,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.lang.Object |
getSQLObject(java.lang.Object obj,
java.util.Map map)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
java.lang.String |
getString(Column col,
Joins joins)
Return the value stored in the given column. |
java.lang.String |
getString(java.lang.Object obj)
Return the value stored in the given column or id. |
java.sql.Time |
getTime(Column col,
java.util.Calendar cal,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.sql.Time |
getTime(java.lang.Object obj,
java.util.Calendar cal)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
java.sql.Timestamp |
getTimestamp(Column col,
java.util.Calendar cal,
Joins joins)
Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set. |
java.sql.Timestamp |
getTimestamp(java.lang.Object obj,
java.util.Calendar cal)
Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set. |
int |
indexOf()
The index of the select within the UNION that the current row corresponds to, or 0. |
boolean |
isLocking()
If true, then any results loaded from this Result will be locked in the database. |
java.lang.Object |
load(ClassMapping mapping,
JDBCStore store,
JDBCFetchConfiguration fetch)
Load a pc object using the given store manager. |
java.lang.Object |
load(ClassMapping mapping,
JDBCStore store,
JDBCFetchConfiguration fetch,
Joins joins)
Load a pc object using the given store manager. |
Joins |
newJoins()
Return a new joins instance to use for traversing to related data. |
boolean |
next()
Advance to the next row, or return false if there are no more rows in the result. |
void |
pushBack()
Push back the last result. |
void |
putEager(FieldMapping key,
java.lang.Object res)
The eager result for the given key, or null if none. |
void |
setBaseMapping(ClassMapping mapping)
If this is the result of a UNION used to select a hierarchy of mappings, the base mapping represented by the current row. |
void |
setLocking(boolean locking)
Set to true if row locking has been issued for the row. |
void |
setMappedByFieldMapping(FieldMapping fieldMapping)
If this is the result used to select a toMany relationship, the mappedByFieldMapping is field mapping representing the inverse relationship. |
void |
setMappedByValue(java.lang.Object mappedByValue)
If this is the result used to select a toMany relationship, the mappedByValue is value of the owner of the toMany relationship. |
int |
size()
Return the number of rows in this result. |
void |
startDataRequest(java.lang.Object mapping)
Informs this receiver about the application element for which a subsequent data request will be made. |
boolean |
supportsRandomAccess()
Return true if the result supports random access. |
boolean |
wasNull()
Return true if the last value fetched was null. |
Method Detail |
---|
java.lang.Object getEager(FieldMapping key)
void putEager(FieldMapping key, java.lang.Object res)
Joins newJoins()
void close()
close
in interface Closeable
void setLocking(boolean locking)
boolean isLocking()
boolean supportsRandomAccess() throws java.sql.SQLException
java.sql.SQLException
boolean absolute(int row) throws java.sql.SQLException
java.sql.SQLException
boolean next() throws java.sql.SQLException
java.sql.SQLException
void pushBack() throws java.sql.SQLException
next()
. After the first time this method is called,
additional calls before a call to next()
or absolute(int)
should have no further affect.
java.sql.SQLException
int size() throws java.sql.SQLException
java.sql.SQLException
boolean contains(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
boolean containsAll(java.lang.Object[] objs) throws java.sql.SQLException
java.sql.SQLException
boolean contains(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
boolean containsAll(Column[] cols, Joins joins) throws java.sql.SQLException
java.sql.SQLException
ClassMapping getBaseMapping()
void setBaseMapping(ClassMapping mapping)
FieldMapping getMappedByFieldMapping()
void setMappedByFieldMapping(FieldMapping fieldMapping)
java.lang.Object getMappedByValue()
void setMappedByValue(java.lang.Object mappedByValue)
int indexOf()
java.lang.Object load(ClassMapping mapping, JDBCStore store, JDBCFetchConfiguration fetch) throws java.sql.SQLException
java.sql.SQLException
java.lang.Object load(ClassMapping mapping, JDBCStore store, JDBCFetchConfiguration fetch, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.sql.Array getArray(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.io.InputStream getAsciiStream(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.math.BigDecimal getBigDecimal(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.math.BigInteger getBigInteger(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.io.InputStream getBinaryStream(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.io.InputStream getLOBStream(JDBCStore store, java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.sql.Blob getBlob(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
boolean getBoolean(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
byte getByte(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
byte[] getBytes(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.util.Calendar getCalendar(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
char getChar(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.io.Reader getCharacterStream(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.sql.Clob getClob(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.util.Date getDate(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.sql.Date getDate(java.lang.Object obj, java.util.Calendar cal) throws java.sql.SQLException
java.sql.SQLException
double getDouble(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
float getFloat(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
int getInt(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.util.Locale getLocale(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
long getLong(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.lang.Number getNumber(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.lang.Object getObject(java.lang.Object obj, int metaType, java.lang.Object arg) throws java.sql.SQLException
obj
- the column or id whose data to fetchmetaType
- the type code from
JavaTypes
or JavaSQLTypes
for the
type of the data; if obj
is a column, you may specify -1
to use the column's recorded java typearg
- some JDBC data access methods use an argument, such
as a Calendar
or Map
java.sql.SQLException
java.lang.Object getSQLObject(java.lang.Object obj, java.util.Map map) throws java.sql.SQLException
java.sql.SQLException
java.sql.Ref getRef(java.lang.Object obj, java.util.Map map) throws java.sql.SQLException
java.sql.SQLException
short getShort(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.lang.String getString(java.lang.Object obj) throws java.sql.SQLException
java.sql.SQLException
java.sql.Time getTime(java.lang.Object obj, java.util.Calendar cal) throws java.sql.SQLException
java.sql.SQLException
java.sql.Timestamp getTimestamp(java.lang.Object obj, java.util.Calendar cal) throws java.sql.SQLException
java.sql.SQLException
java.sql.Array getArray(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.io.InputStream getAsciiStream(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.math.BigDecimal getBigDecimal(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.math.BigInteger getBigInteger(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.io.InputStream getBinaryStream(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.sql.Blob getBlob(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
boolean getBoolean(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
byte getByte(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
byte[] getBytes(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.util.Calendar getCalendar(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
char getChar(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.io.Reader getCharacterStream(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.sql.Clob getClob(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.util.Date getDate(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.sql.Date getDate(Column col, java.util.Calendar cal, Joins joins) throws java.sql.SQLException
java.sql.SQLException
double getDouble(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
float getFloat(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
int getInt(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.util.Locale getLocale(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
long getLong(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.lang.Number getNumber(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.lang.Object getObject(Column col, java.lang.Object arg, Joins joins) throws java.sql.SQLException
col
- the column whose data to fetcharg
- some JDBC data access methods use an argument, such
as a Calendar
or Map
java.sql.SQLException
java.lang.Object getSQLObject(Column col, java.util.Map map, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.sql.Ref getRef(Column col, java.util.Map map, Joins joins) throws java.sql.SQLException
java.sql.SQLException
short getShort(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.lang.String getString(Column col, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.sql.Time getTime(Column col, java.util.Calendar cal, Joins joins) throws java.sql.SQLException
java.sql.SQLException
java.sql.Timestamp getTimestamp(Column col, java.util.Calendar cal, Joins joins) throws java.sql.SQLException
java.sql.SQLException
boolean wasNull() throws java.sql.SQLException
java.sql.SQLException
void startDataRequest(java.lang.Object mapping)
void endDataRequest()
startDataRequest(java.lang.Object)
. The calls can be nested as follwsstartDataRequest (relation); startDataRequest (relationsField); getObject("COLUMN_Y"); endDataRequest (); endDataRequest ();
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |