Hibernate Core 3.6.10.Final · org.hibernate.ScrollableResults

Method Summary

Modifier and Type	Method and Description
public void	afterLast() Go to a location just after the last result
public void	beforeFirst() Go to a location just before first result (this is the initial location)
public void	close() Release resources immediately.
public boolean	Returns: `true` if there are any results first() Go to the first result
public Object[]	Returns: an object or array get() Get the current row of results
public Object	Returns: an object of any Hibernate type or `null` get(int the column, numbered from zero i) Get the `i`th object in the current row of results, without initializing any other results in the row.
public BigDecimal	getBigDecimal(int col) Convenience method to read a `big_decimal`
public BigInteger	getBigInteger(int col) Convenience method to read a `big_integer`
public byte[]	getBinary(int col) Convenience method to read a `binary`
public Blob	getBlob(int col) Convenience method to read a `blob`
public Boolean	getBoolean(int col) Convenience method to read a `boolean`
public Byte	getByte(int col) Convenience method to read a `byte`
public Calendar	getCalendar(int col) Convenience method to read a `calendar` or `calendar_date`
public Character	getCharacter(int col) Convenience method to read a `character`
public Clob	getClob(int col) Convenience method to read a `clob`
public Date	getDate(int col) Convenience method to read a `date`, `time` or `timestamp`
public Double	getDouble(int col) Convenience method to read a `double`
public Float	getFloat(int col) Convenience method to read a `float`
public Integer	getInteger(int col) Convenience method to read an `integer`
public Locale	getLocale(int col) Convenience method to read a `locale`
public Long	getLong(int col) Convenience method to read a `long`
public int	Returns: the row number, numbered from `0`, or `-1` if there is no current row getRowNumber() Get the current location in the result set.
public Short	getShort(int col) Convenience method to read a `short`
public String	getString(int col) Convenience method to read a `string`
public String	getText(int col) Convenience method to read `text`
public TimeZone	getTimeZone(int col) Convenience method to read a `timezone`
public Type	Returns: the Hibernate type getType(int the column, numbered from zero i) Get the type of the `i`th column of results
public boolean	Returns: `true` if this is the first row of results isFirst() Is this the first result?
public boolean	Returns: `true` if this is the last row of results isLast() Is this the last result?
public boolean	Returns: `true` if there are any results last() Go to the last result
public boolean	Returns: `true` if there is another result next() Advance to the next result
public boolean	Returns: `true` if there is a previous result previous() Retreat to the previous result
public boolean	Returns: `true` if there is a result at the new location scroll(int a positive (forward) or negative (backward) number of rows i) Scroll an arbitrary number of locations
public boolean	Returns: true if there is a row at that row number setRowNumber(int the row number, numbered from the last row, in the case of a negative row number rowNumber) Set the current location in the result set, numbered from either the first row (row number `0`), or the last row (row number `-1`).

Method Detail

afterLast	back to summary
public void afterLast() throws HibernateException Go to a location just after the last result

beforeFirst	back to summary
public void beforeFirst() throws HibernateException Go to a location just before first result (this is the initial location)

close	back to summary
public void close() throws HibernateException Release resources immediately.

first back to summary

first	back to summary
public boolean first() throws HibernateException Go to the first result Returns:boolean `true` if there are any results

public boolean first() throws HibernateException

Go to the first result

Returns:boolean: true if there are any results

get	back to summary
public Object[] get() throws HibernateException Get the current row of results Returns:Object[] an object or array

get

back to summary

public Object[] get() throws HibernateException

Get the current row of results

Returns:Object[]: an object or array

get back to summary

get	back to summary
public Object get(int i) throws HibernateException Get the `i`th object in the current row of results, without initializing any other results in the row. This method may be used safely, regardless of the type of the column (ie. even for scalar results). Parameters i:int the column, numbered from zero Returns:Object an object of any Hibernate type or `null`

public Object get(int i) throws HibernateException

Get the ith object in the current row of results, without initializing any other results in the row. This method may be used safely, regardless of the type of the column (ie. even for scalar results).

Parameters

i:int: the column, numbered from zero

Returns:Object

an object of any Hibernate type or null

getBigDecimal	back to summary
public BigDecimal getBigDecimal(int col) throws HibernateException Convenience method to read a `big_decimal`

getBigInteger	back to summary
public BigInteger getBigInteger(int col) throws HibernateException Convenience method to read a `big_integer`

getBinary	back to summary
public byte[] getBinary(int col) throws HibernateException Convenience method to read a `binary`

getBlob	back to summary
public Blob getBlob(int col) throws HibernateException Convenience method to read a `blob`

getBoolean	back to summary
public Boolean getBoolean(int col) throws HibernateException Convenience method to read a `boolean`

getByte	back to summary
public Byte getByte(int col) throws HibernateException Convenience method to read a `byte`

getCalendar	back to summary
public Calendar getCalendar(int col) throws HibernateException Convenience method to read a `calendar` or `calendar_date`

getCharacter	back to summary
public Character getCharacter(int col) throws HibernateException Convenience method to read a `character`

getClob	back to summary
public Clob getClob(int col) throws HibernateException Convenience method to read a `clob`

getDate	back to summary
public Date getDate(int col) throws HibernateException Convenience method to read a `date`, `time` or `timestamp`

getDouble	back to summary
public Double getDouble(int col) throws HibernateException Convenience method to read a `double`

getFloat	back to summary
public Float getFloat(int col) throws HibernateException Convenience method to read a `float`

getInteger	back to summary
public Integer getInteger(int col) throws HibernateException Convenience method to read an `integer`

getLocale	back to summary
public Locale getLocale(int col) throws HibernateException Convenience method to read a `locale`

getLong	back to summary
public Long getLong(int col) throws HibernateException Convenience method to read a `long`

getRowNumber back to summary

getRowNumber	back to summary
public int getRowNumber() throws HibernateException Get the current location in the result set. The first row is number `0`, contrary to JDBC. Returns:int the row number, numbered from `0`, or `-1` if there is no current row

public int getRowNumber() throws HibernateException

Get the current location in the result set. The first row is number 0, contrary to JDBC.

Returns:int: the row number, numbered from 0, or -1 if there is no current row

getShort	back to summary
public Short getShort(int col) throws HibernateException Convenience method to read a `short`

getString	back to summary
public String getString(int col) throws HibernateException Convenience method to read a `string`

getText	back to summary
public String getText(int col) throws HibernateException Convenience method to read `text`

getTimeZone	back to summary
public TimeZone getTimeZone(int col) throws HibernateException Convenience method to read a `timezone`

getType back to summary

getType	back to summary
public Type getType(int i) Get the type of the `i`th column of results Parameters i:int the column, numbered from zero Returns:Type the Hibernate type

public Type getType(int i)

Get the type of the ith column of results

Parameters

i:int: the column, numbered from zero

Returns:Type

the Hibernate type

isFirst back to summary

isFirst	back to summary
public boolean isFirst() throws HibernateException Is this the first result? Returns:boolean `true` if this is the first row of results

public boolean isFirst() throws HibernateException

Is this the first result?

Returns:boolean: true if this is the first row of results

isLast back to summary

isLast	back to summary
public boolean isLast() throws HibernateException Is this the last result? Returns:boolean `true` if this is the last row of results

public boolean isLast() throws HibernateException

Is this the last result?

Returns:boolean: true if this is the last row of results

last back to summary

last	back to summary
public boolean last() throws HibernateException Go to the last result Returns:boolean `true` if there are any results

public boolean last() throws HibernateException

Go to the last result

Returns:boolean: true if there are any results

next back to summary

next	back to summary
public boolean next() throws HibernateException Advance to the next result Returns:boolean `true` if there is another result

public boolean next() throws HibernateException

Advance to the next result

Returns:boolean: true if there is another result

previous back to summary

previous	back to summary
public boolean previous() throws HibernateException Retreat to the previous result Returns:boolean `true` if there is a previous result

public boolean previous() throws HibernateException

Retreat to the previous result

Returns:boolean: true if there is a previous result

scroll back to summary

scroll	back to summary
public boolean scroll(int i) throws HibernateException Scroll an arbitrary number of locations Parameters i:int a positive (forward) or negative (backward) number of rows Returns:boolean `true` if there is a result at the new location

public boolean scroll(int i) throws HibernateException

Scroll an arbitrary number of locations

Parameters

i:int: a positive (forward) or negative (backward) number of rows

Returns:boolean

true if there is a result at the new location

setRowNumber back to summary

setRowNumber	back to summary
public boolean setRowNumber(int rowNumber) throws HibernateException Set the current location in the result set, numbered from either the first row (row number `0`), or the last row (row number `-1`). Parameters rowNumber:int the row number, numbered from the last row, in the case of a negative row number Returns:boolean true if there is a row at that row number

public boolean setRowNumber(int rowNumber) throws HibernateException

Set the current location in the result set, numbered from either the first row (row number 0), or the last row (row number -1).

Parameters

rowNumber:int: the row number, numbered from the last row, in the case of a negative row number

Returns:boolean

true if there is a row at that row number

public Interface ScrollableResults

Method Summary

Method Detail