|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 or column is available in the result. |
boolean |
contains(Object obj)
Return true if the given or id or column is available in the result. |
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. |
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. |
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. |
Result |
getEager(Object key)
Return 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. |
Object |
getObject(Column col,
int metaTypeCode,
Object arg,
Joins joins)
Return the value stored in the given column. |
Object |
getObject(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 |
getObject(Object obj,
int metaTypeCode,
Object arg)
Return the value stored in the given column or id. |
Object |
getObject(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. |
Object |
getProcessed(Object key)
Return the processed data under the given key, or null if none. |
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. |
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. |
boolean |
isLocking()
If true, then any results loaded from this Result will be locked in the database. |
Object |
load(ClassMapping mapping,
JDBCStoreManager store,
JDBCFetchConfiguration fetch)
Load a pc object using the given store manager. |
Object |
load(ClassMapping mapping,
JDBCStoreManager 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 |
putProcessed(Object key,
Object data)
Set the data resulting from processing an eager result. |
int |
size()
Return the number of rows in this result. |
boolean |
supportsRandomAccess()
Return true if the result supports random access. |
boolean |
wasNull()
Return true if the last value fetched was null. |
Method Detail |
public Result getEager(Object key)
public void putProcessed(Object key, Object data)
public Object getProcessed(Object key)
public Joins newJoins()
public void close()
close
in interface com.solarmetric.util.Closeable
public boolean isLocking()
public boolean supportsRandomAccess() throws SQLException
public boolean absolute(int row) throws SQLException
public boolean next() throws SQLException
public 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.public int size() throws SQLException
public boolean contains(Object obj) throws SQLException
public boolean contains(Column col, Joins joins) throws SQLException
public Object load(ClassMapping mapping, JDBCStoreManager store, JDBCFetchConfiguration fetch) throws SQLException
public Object load(ClassMapping mapping, JDBCStoreManager store, JDBCFetchConfiguration fetch, Joins joins) throws SQLException
public Array getArray(Object obj) throws SQLException
public InputStream getAsciiStream(Object obj) throws SQLException
public BigDecimal getBigDecimal(Object obj) throws SQLException
public BigInteger getBigInteger(Object obj) throws SQLException
public InputStream getBinaryStream(Object obj) throws SQLException
public Blob getBlob(Object obj) throws SQLException
public boolean getBoolean(Object obj) throws SQLException
public byte getByte(Object obj) throws SQLException
public byte[] getBytes(Object obj) throws SQLException
public char getChar(Object obj) throws SQLException
public Reader getCharacterStream(Object obj) throws SQLException
public Clob getClob(Object obj) throws SQLException
public Date getDate(Object obj) throws SQLException
public Date getDate(Object obj, Calendar cal) throws SQLException
public double getDouble(Object obj) throws SQLException
public float getFloat(Object obj) throws SQLException
public int getInt(Object obj) throws SQLException
public Locale getLocale(Object obj) throws SQLException
public long getLong(Object obj) throws SQLException
public Object getObject(Object obj, int metaTypeCode, Object arg) throws SQLException
obj
- the column or id whose data to fetchmetaType
- the type code from FieldMapping
for the
type of the dataarg
- some JDBC data access methods use an argument, such
as a Calendar
or Map
public Object getObject(Object obj, Map map) throws SQLException
public Ref getRef(Object obj, Map map) throws SQLException
public short getShort(Object obj) throws SQLException
public String getString(Object obj) throws SQLException
public Time getTime(Object obj, Calendar cal) throws SQLException
public Timestamp getTimestamp(Object obj, Calendar cal) throws SQLException
public Array getArray(Column col, Joins joins) throws SQLException
public InputStream getAsciiStream(Column col, Joins joins) throws SQLException
public BigDecimal getBigDecimal(Column col, Joins joins) throws SQLException
public BigInteger getBigInteger(Column col, Joins joins) throws SQLException
public InputStream getBinaryStream(Column col, Joins joins) throws SQLException
public Blob getBlob(Column col, Joins joins) throws SQLException
public boolean getBoolean(Column col, Joins joins) throws SQLException
public byte getByte(Column col, Joins joins) throws SQLException
public byte[] getBytes(Column col, Joins joins) throws SQLException
public char getChar(Column col, Joins joins) throws SQLException
public Reader getCharacterStream(Column col, Joins joins) throws SQLException
public Clob getClob(Column col, Joins joins) throws SQLException
public Date getDate(Column col, Joins joins) throws SQLException
public Date getDate(Column col, Calendar cal, Joins joins) throws SQLException
public double getDouble(Column col, Joins joins) throws SQLException
public float getFloat(Column col, Joins joins) throws SQLException
public int getInt(Column col, Joins joins) throws SQLException
public Locale getLocale(Column col, Joins joins) throws SQLException
public long getLong(Column col, Joins joins) throws SQLException
public Object getObject(Column col, int metaTypeCode, Object arg, Joins joins) throws SQLException
col
- the column whose data to fetchmetaType
- the type code from FieldMapping
for the
type of the dataarg
- some JDBC data access methods use an argument, such
as a Calendar
or Map
public Object getObject(Column col, Map map, Joins joins) throws SQLException
public Ref getRef(Column col, Map map, Joins joins) throws SQLException
public short getShort(Column col, Joins joins) throws SQLException
public String getString(Column col, Joins joins) throws SQLException
public Time getTime(Column col, Calendar cal, Joins joins) throws SQLException
public Timestamp getTimestamp(Column col, Calendar cal, Joins joins) throws SQLException
public boolean wasNull() throws SQLException
|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |