Package de.uplanet.lucy.server.util.db

Class DbResultSet

java.lang.Object

de.uplanet.lucy.server.util.db.DbResultSet

All Implemented Interfaces:

IDbResultSet, IValueAccess, IValueHolderAccess, ICloseable, AutoCloseable, Iterable<IDbRow>

public final class DbResultSet
extends Object
implements IDbResultSet, Iterable<IDbRow>

Method Summary

Modifier and Type	Method	Description
void	close()
List<?>	findAll(groovy.lang.Closure<?> p_closure)	Calls the given closure for every row in the result set and returns a list of rows for which the closure is valid.
BigDecimal	getBigDecimalValue(int p_iIdx)	Get a decimal number value.
BigDecimal	getBigDecimalValue(int p_iIdx, BigDecimal p_valueIfNull)	Get a decimal number value.
Boolean	getBooleanValue(int p_iIdx)	Get a boolean value.
Boolean	getBooleanValue(int p_iIdx, Boolean p_valueIfNull)	Get a boolean value.
byte	getByteValue(int p_iIdx)	Get a byte value.
Byte	getByteValue(int p_iIdx, Byte p_valueIfNull)	Get a byte value.
Date	getDateValue(int p_iIdx)	Get a date value.
Date	getDateValue(int p_iIdx, Calendar p_cal)
Date	getDateValue(int p_iIdx, Date p_valueIfNull)	Get a date value.
Date	getDateValue(int p_iIdx, Date p_valueIfNull, Calendar p_cal)
Date	getDateValue(int p_iIdx, Date p_valueIfNull, TimeZone p_tz)
Date	getDateValue(int p_iIdx, TimeZone p_tz)
DbRowList	getDisconnectedRowList()	Create a list of disconnected rows from this result set.
Double	getDoubleValue(int p_iIdx)	Get a double value.
Double	getDoubleValue(int p_iIdx, Double p_valueIfNull)	Get a double precision float value.
Float	getFloatValue(int p_iIdx)	Get a single precision float value.
Float	getFloatValue(int p_iIdx, Float p_valueIfNull)	Get a single precision float value.
Integer	getIntValue(int p_iIdx)	Get an integer value.
Integer	getIntValue(int p_iIdx, Integer p_valueIfNull)	Get an integer value.
Long	getLongValue(int p_iIdx)	Get a long value.
Long	getLongValue(int p_iIdx, Long p_valueIfNull)	Get a long value.
int	getRowCount()	Get the number of rows read so far.
Short	getShortValue(int p_iIdx)	Get a short value.
Short	getShortValue(int p_iIdx, Short p_valueIfNull)	Get a short value.
String	getStringValue(int p_iIdx)	Get a string value.
String	getStringValue(int p_iIdx, String p_valueIfNull)	Get a string value.
Timestamp	getTimestampValue(int p_iIdx)	Get a timestamp value.
Timestamp	getTimestampValue(int p_iIdx, Timestamp p_valueIfNull)	Get a timestamp value.
Timestamp	getTimestampValue(int p_iIdx, Timestamp p_valueIfNull, Calendar p_cal)
Timestamp	getTimestampValue(int p_iIdx, Timestamp p_valueIfNull, TimeZone p_tz)
Timestamp	getTimestampValue(int p_iIdx, Calendar p_cal)
Timestamp	getTimestampValue(int p_iIdx, TimeZone p_tz)
Date	getTimeValue(int p_iIdx)	Get a time value.
Date	getTimeValue(int p_iIdx, Calendar p_cal)
Date	getTimeValue(int p_iIdx, Date p_valueIfNull)	Get a time value.
Date	getTimeValue(int p_iIdx, Date p_valueIfNull, Calendar p_cal)
Date	getTimeValue(int p_iIdx, Date p_valueIfNull, TimeZone p_tz)
Date	getTimeValue(int p_iIdx, TimeZone p_tz)
Object	getValue(int p_iIdx)	Get a value.
Object	getValue(int p_iIdx, Object p_valueIfNull)	Get a value.
IValueHolder<?>	getValueHolder(int p_iIdx)
IValueHolder<?>	getValueHolder(int p_iIdx, String p_strDataTypeAsSerializedQName)
IValueHolder<?>	getValueHolder(int p_iIdx, String p_strDataTypeAsSerializedQName, IValueHolder<?> p_valueIfNull)
IValueHolder<?>	getValueHolder(int p_iIdx, QName p_qmnDataType)
IValueHolder<?>	getValueHolder(int p_iIdx, QName p_qmnDataType, IValueHolder<?> p_valueIfNull)
Collection<?>	grep(Object p_filter)	This method is not supported
Iterator<IDbRow>	iterator()
boolean	next()
boolean	wasNull(int p_iIdx)	Check if the value in the given column was null.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getRowCount

public int getRowCount()

Get the number of rows read so far.

Returns:

The number of rows read so far.

next

public boolean next()
             throws SQLException

Specified by:

next in interface IDbResultSet

Throws:

SQLException

wasNull

public boolean wasNull(int p_iIdx)
                throws SQLException

Description copied from interface: IValueAccess

Check if the value in the given column was null.

Specified by:

wasNull in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

true if the value was null, or false otherwise.

Throws:

SQLException - If a database error occurred.

getValueHolder

public IValueHolder<?> getValueHolder(int p_iIdx)
                               throws SQLException

Specified by:

getValueHolder in interface IValueHolderAccess

Throws:

SQLException

getValueHolder

public IValueHolder<?> getValueHolder(int p_iIdx,
                                      QName p_qmnDataType)
                               throws SQLException

Specified by:

getValueHolder in interface IValueHolderAccess

Throws:

SQLException

getValueHolder

public IValueHolder<?> getValueHolder(int p_iIdx,
                                      String p_strDataTypeAsSerializedQName)
                               throws SQLException

Specified by:

getValueHolder in interface IValueHolderAccess

Throws:

SQLException

getValueHolder

public IValueHolder<?> getValueHolder(int p_iIdx,
                                      QName p_qmnDataType,
                                      IValueHolder<?> p_valueIfNull)
                               throws SQLException

Specified by:

getValueHolder in interface IValueHolderAccess

Throws:

SQLException

getValueHolder

public IValueHolder<?> getValueHolder(int p_iIdx,
                                      String p_strDataTypeAsSerializedQName,
                                      IValueHolder<?> p_valueIfNull)
                               throws SQLException

Specified by:

getValueHolder in interface IValueHolderAccess

Throws:

SQLException

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IDbResultSet

Throws:

SQLException

getValue

public Object getValue(int p_iIdx)
                throws SQLException

Description copied from interface: IValueAccess

Get a value. Note: The use of this method is discouraged. Use a method that returns a specified type instead.

Specified by:

getValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

The value.

Throws:

SQLException - If a database error occurred.

getValue

public Object getValue(int p_iIdx,
                       Object p_valueIfNull)
                throws SQLException

Description copied from interface: IValueAccess

Get a value. Note: The use of this method is discouraged. Use a method that returns a specified type instead.

Specified by:

getValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

The value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

getBooleanValue

public Boolean getBooleanValue(int p_iIdx)
                        throws SQLException,
                               ValueCastException

Description copied from interface: IValueAccess

Get a boolean value.

Specified by:

getBooleanValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A boolean value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to boolean.

getBooleanValue

public Boolean getBooleanValue(int p_iIdx,
                               Boolean p_valueIfNull)
                        throws SQLException,
                               ValueCastException

Description copied from interface: IValueAccess

Get a boolean value.

Specified by:

getBooleanValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A boolean value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to boolean.

getByteValue

public byte getByteValue(int p_iIdx)
                  throws SQLException,
                         ValueCastException

Description copied from interface: IValueAccess

Get a byte value.

Specified by:

getByteValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A byte value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to byte.

getByteValue

public Byte getByteValue(int p_iIdx,
                         Byte p_valueIfNull)
                  throws SQLException,
                         ValueCastException

Description copied from interface: IValueAccess

Get a byte value.

Specified by:

getByteValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A byte value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to byte.

getShortValue

public Short getShortValue(int p_iIdx)
                    throws SQLException,
                           ValueCastException

Description copied from interface: IValueAccess

Get a short value.

Specified by:

getShortValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A short value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to short.

getShortValue

public Short getShortValue(int p_iIdx,
                           Short p_valueIfNull)
                    throws SQLException,
                           ValueCastException

Description copied from interface: IValueAccess

Get a short value.

Specified by:

getShortValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A short value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to short.

getIntValue

public Integer getIntValue(int p_iIdx)
                    throws SQLException,
                           ValueCastException

Description copied from interface: IValueAccess

Get an integer value.

Specified by:

getIntValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

An integer value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to integer.

getIntValue

public Integer getIntValue(int p_iIdx,
                           Integer p_valueIfNull)
                    throws SQLException,
                           ValueCastException

Description copied from interface: IValueAccess

Get an integer value.

Specified by:

getIntValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

An integer value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to integer.

getLongValue

public Long getLongValue(int p_iIdx)
                  throws SQLException,
                         ValueCastException

Description copied from interface: IValueAccess

Get a long value.

Specified by:

getLongValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A long value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to long.

getLongValue

public Long getLongValue(int p_iIdx,
                         Long p_valueIfNull)
                  throws SQLException,
                         ValueCastException

Description copied from interface: IValueAccess

Get a long value.

Specified by:

getLongValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A long value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to long.

getFloatValue

public Float getFloatValue(int p_iIdx)
                    throws SQLException,
                           ValueCastException

Description copied from interface: IValueAccess

Get a single precision float value.

Specified by:

getFloatValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A float value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to float.

getFloatValue

public Float getFloatValue(int p_iIdx,
                           Float p_valueIfNull)
                    throws SQLException,
                           ValueCastException

Description copied from interface: IValueAccess

Get a single precision float value.

Specified by:

getFloatValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A float value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to float.

getDoubleValue

public Double getDoubleValue(int p_iIdx)
                      throws SQLException,
                             ValueCastException

Description copied from interface: IValueAccess

Get a double value.

Specified by:

getDoubleValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A double value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to double.

getDoubleValue

public Double getDoubleValue(int p_iIdx,
                             Double p_valueIfNull)
                      throws SQLException,
                             ValueCastException

Description copied from interface: IValueAccess

Get a double precision float value.

Specified by:

getDoubleValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A double value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to double.

getBigDecimalValue

public BigDecimal getBigDecimalValue(int p_iIdx)
                              throws SQLException,
                                     ValueCastException

Description copied from interface: IValueAccess

Get a decimal number value.

Specified by:

getBigDecimalValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A BigDecimal value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to BigDecimal.

getBigDecimalValue

public BigDecimal getBigDecimalValue(int p_iIdx,
                                     BigDecimal p_valueIfNull)
                              throws SQLException,
                                     ValueCastException

Description copied from interface: IValueAccess

Get a decimal number value.

Specified by:

getBigDecimalValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A BigDecimal value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to BigDecimal.

getStringValue

public String getStringValue(int p_iIdx)
                      throws SQLException,
                             ValueCastException

Description copied from interface: IValueAccess

Get a string value.

Specified by:

getStringValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A string value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to a string.

getStringValue

public String getStringValue(int p_iIdx,
                             String p_valueIfNull)
                      throws SQLException,
                             ValueCastException

Description copied from interface: IValueAccess

Get a string value.

Specified by:

getStringValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A string value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to string.

getTimestampValue

public Timestamp getTimestampValue(int p_iIdx)
                            throws SQLException,
                                   ValueCastException

Description copied from interface: IValueAccess

Get a timestamp value.

Specified by:

getTimestampValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A timestamp value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to a timestamp.

getTimestampValue

public Timestamp getTimestampValue(int p_iIdx,
                                   Calendar p_cal)
                            throws SQLException,
                                   ValueCastException

Specified by:

getTimestampValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getTimestampValue

public Timestamp getTimestampValue(int p_iIdx,
                                   TimeZone p_tz)
                            throws SQLException,
                                   ValueCastException

Specified by:

getTimestampValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getTimestampValue

public Timestamp getTimestampValue(int p_iIdx,
                                   Timestamp p_valueIfNull)
                            throws SQLException,
                                   ValueCastException

Description copied from interface: IValueAccess

Get a timestamp value.

Specified by:

getTimestampValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A timestamp value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to timestamp.

getTimestampValue

public Timestamp getTimestampValue(int p_iIdx,
                                   Timestamp p_valueIfNull,
                                   TimeZone p_tz)
                            throws SQLException,
                                   ValueCastException

Specified by:

getTimestampValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getTimestampValue

public Timestamp getTimestampValue(int p_iIdx,
                                   Timestamp p_valueIfNull,
                                   Calendar p_cal)
                            throws SQLException,
                                   ValueCastException

Specified by:

getTimestampValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getDateValue

public Date getDateValue(int p_iIdx)
                  throws SQLException,
                         ValueCastException

Description copied from interface: IValueAccess

Get a date value.

Specified by:

getDateValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A date value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to date.

getDateValue

public Date getDateValue(int p_iIdx,
                         Calendar p_cal)
                  throws SQLException,
                         ValueCastException

Specified by:

getDateValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getDateValue

public Date getDateValue(int p_iIdx,
                         TimeZone p_tz)
                  throws SQLException,
                         ValueCastException

Specified by:

getDateValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getDateValue

public Date getDateValue(int p_iIdx,
                         Date p_valueIfNull)
                  throws SQLException,
                         ValueCastException

Description copied from interface: IValueAccess

Get a date value.

Specified by:

getDateValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A date value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to date.

getDateValue

public Date getDateValue(int p_iIdx,
                         Date p_valueIfNull,
                         TimeZone p_tz)
                  throws SQLException,
                         ValueCastException

Specified by:

getDateValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getDateValue

public Date getDateValue(int p_iIdx,
                         Date p_valueIfNull,
                         Calendar p_cal)
                  throws SQLException,
                         ValueCastException

Specified by:

getDateValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getTimeValue

public Date getTimeValue(int p_iIdx)
                  throws SQLException,
                         ValueCastException

Description copied from interface: IValueAccess

Get a time value.

Specified by:

getTimeValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

Returns:

A time value, or null.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to time.

getTimeValue

public Date getTimeValue(int p_iIdx,
                         Calendar p_cal)
                  throws SQLException,
                         ValueCastException

Specified by:

getTimeValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getTimeValue

public Date getTimeValue(int p_iIdx,
                         TimeZone p_tz)
                  throws SQLException,
                         ValueCastException

Specified by:

getTimeValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getTimeValue

public Date getTimeValue(int p_iIdx,
                         Date p_valueIfNull)
                  throws SQLException,
                         ValueCastException

Description copied from interface: IValueAccess

Get a time value.

Specified by:

getTimeValue in interface IValueAccess

Parameters:

p_iIdx - The 1-based column index.

p_valueIfNull - The value to be returned if the database value was NULL.

Returns:

A time value, or p_valueIfNull.

Throws:

SQLException - If a database error occurred.

ValueCastException - If the database value could not be cast to time.

getTimeValue

public Date getTimeValue(int p_iIdx,
                         Date p_valueIfNull,
                         TimeZone p_tz)
                  throws SQLException,
                         ValueCastException

Specified by:

getTimeValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getTimeValue

public Date getTimeValue(int p_iIdx,
                         Date p_valueIfNull,
                         Calendar p_cal)
                  throws SQLException,
                         ValueCastException

Specified by:

getTimeValue in interface IDbResultSet

Throws:

SQLException

ValueCastException

getDisconnectedRowList

public DbRowList getDisconnectedRowList()

Create a list of disconnected rows from this result set.

Note:

• The result set data are at once fetched into memory so that calling this method may result in excessive memory consumption.
• After this method has been called, subsequent iterations over this result set will give no result. However anew call to this method will return the previous returned rows.
• Rows that were consumed in previous iterations over this result set will not be present in this list.

Returns:

A list of disconnected rows.

iterator

public Iterator<IDbRow> iterator()

Specified by:

iterator in interface Iterable<IDbRow>

findAll

public List<?> findAll(groovy.lang.Closure<?> p_closure)

Calls the given closure for every row in the result set and returns a list of rows for which the closure is valid.

Parameters:

p_closure - The closure that's being called.

Returns:

A list of rows the closure is valid for.

Throws:

UnsupportedOperationException - - If the result set does not provide disconnected rows.

grep

public Collection<?> grep(Object p_filter)

This method is not supported

.

Throws:

UnsupportedOperationException