|
||||||||||
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(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(Object[] objs)
Return true if all the given ids or columns are available in the result. |
void |
endDataRequest()
Ends a data request. |
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. |
Array |
getArray(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. |
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. |
InputStream |
getAsciiStream(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. |
BigDecimal |
getBigDecimal(Column col,
Joins joins)
Return the value stored in the given column. |
BigDecimal |
getBigDecimal(Object obj)
Return the value stored in the given column or id. |
BigInteger |
getBigInteger(Column col,
Joins joins)
Return the value stored in the given column. |
BigInteger |
getBigInteger(Object obj)
Return the value stored in the given column or id. |
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. |
InputStream |
getBinaryStream(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. |
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. |
Blob |
getBlob(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(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(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(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. |
Calendar |
getCalendar(Column col,
Joins joins)
Return the value stored in the given column. |
Calendar |
getCalendar(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(Object obj)
Return the value stored in the given column or id. |
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. |
Reader |
getCharacterStream(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. |
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. |
Clob |
getClob(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. |
Date |
getDate(Column col,
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. |
Date |
getDate(Column col,
Joins joins)
Return the value stored in the given column. |
Date |
getDate(Object obj)
Return the value stored in the given column or id. |
Date |
getDate(Object obj,
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(Object obj)
Return the value stored in the given column or id. |
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(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(Object obj)
Return the value stored in the given column or id. |
Locale |
getLocale(Column col,
Joins joins)
Return the value stored in the given column. |
Locale |
getLocale(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(Object obj)
Return the value stored in the given column or id. |
Number |
getNumber(Column col,
Joins joins)
Return the value stored in the given column. |
Number |
getNumber(Object obj)
Return the value stored in the given column or id. |
Object |
getObject(Column col,
Object arg,
Joins joins)
Return the value stored in the given column. |
Object |
getObject(Object obj,
int metaType,
Object arg)
Return the value stored in the given column or id. |
Ref |
getRef(Column col,
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. |
Ref |
getRef(Object obj,
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(Object obj)
Return the value stored in the given column or id. |
Object |
getSQLObject(Column col,
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. |
Object |
getSQLObject(Object obj,
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. |
String |
getString(Column col,
Joins joins)
Return the value stored in the given column. |
String |
getString(Object obj)
Return the value stored in the given column or id. |
Time |
getTime(Column col,
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. |
Time |
getTime(Object obj,
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. |
Timestamp |
getTimestamp(Column col,
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. |
Timestamp |
getTimestamp(Object obj,
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. |
Object |
load(ClassMapping mapping,
JDBCStore store,
JDBCFetchConfiguration fetch)
Load a pc object using the given store manager. |
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,
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. |
int |
size()
Return the number of rows in this result. |
void |
startDataRequest(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 |
---|
Object getEager(FieldMapping key)
void putEager(FieldMapping key, Object res)
Joins newJoins()
void close()
close
in interface Closeable
boolean isLocking()
boolean supportsRandomAccess() throws SQLException
SQLException
boolean absolute(int row) throws SQLException
SQLException
boolean next() throws SQLException
SQLException
void pushBack() throws 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.
SQLException
int size() throws SQLException
SQLException
boolean contains(Object obj) throws SQLException
SQLException
boolean containsAll(Object[] objs) throws SQLException
SQLException
boolean contains(Column col, Joins joins) throws SQLException
SQLException
boolean containsAll(Column[] cols, Joins joins) throws SQLException
SQLException
ClassMapping getBaseMapping()
void setBaseMapping(ClassMapping mapping)
int indexOf()
Object load(ClassMapping mapping, JDBCStore store, JDBCFetchConfiguration fetch) throws SQLException
SQLException
Object load(ClassMapping mapping, JDBCStore store, JDBCFetchConfiguration fetch, Joins joins) throws SQLException
SQLException
Array getArray(Object obj) throws SQLException
SQLException
InputStream getAsciiStream(Object obj) throws SQLException
SQLException
BigDecimal getBigDecimal(Object obj) throws SQLException
SQLException
BigInteger getBigInteger(Object obj) throws SQLException
SQLException
InputStream getBinaryStream(Object obj) throws SQLException
SQLException
Blob getBlob(Object obj) throws SQLException
SQLException
boolean getBoolean(Object obj) throws SQLException
SQLException
byte getByte(Object obj) throws SQLException
SQLException
byte[] getBytes(Object obj) throws SQLException
SQLException
Calendar getCalendar(Object obj) throws SQLException
SQLException
char getChar(Object obj) throws SQLException
SQLException
Reader getCharacterStream(Object obj) throws SQLException
SQLException
Clob getClob(Object obj) throws SQLException
SQLException
Date getDate(Object obj) throws SQLException
SQLException
Date getDate(Object obj, Calendar cal) throws SQLException
SQLException
double getDouble(Object obj) throws SQLException
SQLException
float getFloat(Object obj) throws SQLException
SQLException
int getInt(Object obj) throws SQLException
SQLException
Locale getLocale(Object obj) throws SQLException
SQLException
long getLong(Object obj) throws SQLException
SQLException
Number getNumber(Object obj) throws SQLException
SQLException
Object getObject(Object obj, int metaType, Object arg) throws 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
SQLException
Object getSQLObject(Object obj, Map map) throws SQLException
SQLException
Ref getRef(Object obj, Map map) throws SQLException
SQLException
short getShort(Object obj) throws SQLException
SQLException
String getString(Object obj) throws SQLException
SQLException
Time getTime(Object obj, Calendar cal) throws SQLException
SQLException
Timestamp getTimestamp(Object obj, Calendar cal) throws SQLException
SQLException
Array getArray(Column col, Joins joins) throws SQLException
SQLException
InputStream getAsciiStream(Column col, Joins joins) throws SQLException
SQLException
BigDecimal getBigDecimal(Column col, Joins joins) throws SQLException
SQLException
BigInteger getBigInteger(Column col, Joins joins) throws SQLException
SQLException
InputStream getBinaryStream(Column col, Joins joins) throws SQLException
SQLException
Blob getBlob(Column col, Joins joins) throws SQLException
SQLException
boolean getBoolean(Column col, Joins joins) throws SQLException
SQLException
byte getByte(Column col, Joins joins) throws SQLException
SQLException
byte[] getBytes(Column col, Joins joins) throws SQLException
SQLException
Calendar getCalendar(Column col, Joins joins) throws SQLException
SQLException
char getChar(Column col, Joins joins) throws SQLException
SQLException
Reader getCharacterStream(Column col, Joins joins) throws SQLException
SQLException
Clob getClob(Column col, Joins joins) throws SQLException
SQLException
Date getDate(Column col, Joins joins) throws SQLException
SQLException
Date getDate(Column col, Calendar cal, Joins joins) throws SQLException
SQLException
double getDouble(Column col, Joins joins) throws SQLException
SQLException
float getFloat(Column col, Joins joins) throws SQLException
SQLException
int getInt(Column col, Joins joins) throws SQLException
SQLException
Locale getLocale(Column col, Joins joins) throws SQLException
SQLException
long getLong(Column col, Joins joins) throws SQLException
SQLException
Number getNumber(Column col, Joins joins) throws SQLException
SQLException
Object getObject(Column col, Object arg, Joins joins) throws SQLException
col
- the column whose data to fetcharg
- some JDBC data access methods use an argument, such
as a Calendar
or Map
SQLException
Object getSQLObject(Column col, Map map, Joins joins) throws SQLException
SQLException
Ref getRef(Column col, Map map, Joins joins) throws SQLException
SQLException
short getShort(Column col, Joins joins) throws SQLException
SQLException
String getString(Column col, Joins joins) throws SQLException
SQLException
Time getTime(Column col, Calendar cal, Joins joins) throws SQLException
SQLException
Timestamp getTimestamp(Column col, Calendar cal, Joins joins) throws SQLException
SQLException
boolean wasNull() throws SQLException
SQLException
void startDataRequest(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 |