com.boylesoftware.cb2
Class FetchResultDescriptor

java.lang.Object
  com.boylesoftware.cb2.FetchResultDescriptor

All Implemented Interfaces:

java.io.Serializable

public final class FetchResultDescriptor

extends java.lang.Object

implements java.io.Serializable

Descriptor or a result set processed by a DAO fetch call. An instance of this class can be passed to certain DAO fetch methods and after the method returns, the instance will contain additional information about the result set. This works only when a paginated result is requested and allows to find out such information as how many rows there were in the whole result set, not only the requested page.

Version:

$Id: FetchResultDescriptor.java,v 1.3 2004/04/20 16:00:58 levahim Exp $

Author:

Lev Himmelfarb

See Also:

DAO.fetch(String, Set, Object [], String [], int, int, int, FetchResultProcessorHandler [], FetchResultDescriptor), DAO.executeFetch(Class, String, Object [], int, int, FetchResultProcessorHandler [], FetchResultDescriptor), Serialized Form

Constructor Summary

FetchResultDescriptor()

Method Summary

int	getRowsTotal() Gets total number of rows in the result set, not only in the requested page,
void	setRowsTotal(int rowsTotal) Sets the rowsTotal property.

Methods inherited from class java.lang.Object

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

Constructor Detail

FetchResultDescriptor

public FetchResultDescriptor()

Method Detail

getRowsTotal

public int getRowsTotal()

Gets total number of rows in the result set, not only in the requested page,

Returns:

total number of rows in the result set.

setRowsTotal

public void setRowsTotal(int rowsTotal)

Sets the rowsTotal property. Can be used from within DAO plugins, namely a FetchExecutor plugin.

Parameters:

rowsTotal - new value for rowsTotal.