org.gvsig.tools.dynobject.impl

Class DefaultDynObjectPagingHelper

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.tools.dynobject.impl.DefaultDynObjectPagingHelper

All Implemented Interfaces:

Disposable, DynObjectPagingHelper, PagingCalculator

public class DefaultDynObjectPagingHelper
extends AbstractDisposable
implements DynObjectPagingHelper

Default DynObjectPagingHelper implementation.

Version:

$Id$

Author:

gvSIG Team

Nested Class Summary

Nested classes/interfaces inherited from interface org.gvsig.tools.paging.PagingCalculator

PagingCalculator.Sizeable

Field Summary

Fields inherited from interface org.gvsig.tools.paging.PagingCalculator

DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
DefaultDynObjectPagingHelper()
DefaultDynObjectPagingHelper(DynObjectSet set)
DefaultDynObjectPagingHelper(DynObjectSet set, int pageSize)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
protected PagingCalculator	getCalculator()
long	getCurrentPage() Returns the number of the currently loaded page of data (zero based).
DynObject[]	getCurrentPageDynObjects() Returns all the values of the current loaded page.
int	getCurrentPageSize() Returns the number of elements of the current page.
DynObject	getDynObjectAt(long index) Returns the DynObject located at the index position.
DynObjectSet	getDynObjectSet() Returns the DynObjectSet used to fetch the data.
long	getInitialIndex() Returns the index of the initial element of the current page into all the elements.
int	getMaxPageSize() Returns the current maximum number of values per page.
long	getNumPages() Returns the number of pages available, calculated with the total number of elements and the maximum number of elements per page.
long	getTotalSize() Returns the number of elements of the entire set of data.
protected void	loadCurrentPageData()
void	reload() Reloads everything.
void	reloadCurrentPage() Reloads the current page of data from the set.
protected void	setCalculator(PagingCalculator calculator)
void	setCurrentPage(long page) Sets the current page number (zero based), and loads the elements for that page.
protected void	setDefaultCalculator(PagingCalculator.Sizeable sizeable, int pageSize)
protected void	setDynObjectSet(DynObjectSet set, int pageSize)
void	setMaxPageSize(int pageSize) Sets the current maximum number of elements per page.

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDynObjectPagingHelper

public DefaultDynObjectPagingHelper()

DefaultDynObjectPagingHelper

public DefaultDynObjectPagingHelper(DynObjectSet set)
                             throws BaseException

Throws:

BaseException

DefaultDynObjectPagingHelper

public DefaultDynObjectPagingHelper(DynObjectSet set,
                            int pageSize)
                             throws BaseException

Throws:

BaseException

Method Detail

setDynObjectSet

protected void setDynObjectSet(DynObjectSet set,
                   int pageSize)
                        throws BaseException

Throws:

BaseException

getDynObjectAt

public DynObject getDynObjectAt(long index)
                         throws BaseException

Description copied from interface: DynObjectPagingHelper

Returns the DynObject located at the index position.

Specified by:

getDynObjectAt in interface DynObjectPagingHelper

Parameters:

index - to locate the DynObject in the set

Returns:

the DynObject located at the index position

Throws:

BaseException - if there is an error getting the DynObject

getCurrentPageDynObjects

public DynObject[] getCurrentPageDynObjects()

Description copied from interface: DynObjectPagingHelper

Returns all the values of the current loaded page.

Specified by:

getCurrentPageDynObjects in interface DynObjectPagingHelper

Returns:

all the values of the current loaded page

getDynObjectSet

public DynObjectSet getDynObjectSet()

Description copied from interface: DynObjectPagingHelper

Returns the DynObjectSet used to fetch the data.

Specified by:

getDynObjectSet in interface DynObjectPagingHelper

Returns:

the DynObjectSet

reloadCurrentPage

public void reloadCurrentPage()
                       throws BaseException

Description copied from interface: DynObjectPagingHelper

Reloads the current page of data from the set.

Specified by:

reloadCurrentPage in interface DynObjectPagingHelper

Throws:

BaseException - if there is an error reloading the current page

loadCurrentPageData

protected void loadCurrentPageData()
                            throws BaseException

Throws:

BaseException

reload

public void reload()
            throws BaseException

Description copied from interface: DynObjectPagingHelper

Reloads everything.

Specified by:

reload in interface DynObjectPagingHelper

Throws:

BaseException

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.

Specified by:

doDispose in class AbstractDisposable

Throws:

BaseException

See Also:

AbstractDisposable.dispose()

getCalculator

protected PagingCalculator getCalculator()

setCalculator

protected void setCalculator(PagingCalculator calculator)
                      throws BaseException

Throws:

BaseException

setDefaultCalculator

protected void setDefaultCalculator(PagingCalculator.Sizeable sizeable,
                        int pageSize)
                             throws BaseException

Throws:

BaseException

getMaxPageSize

public int getMaxPageSize()

Description copied from interface: PagingCalculator

Returns the current maximum number of values per page.

Specified by:

getMaxPageSize in interface PagingCalculator

Returns:

the current maximum page size

setMaxPageSize

public void setMaxPageSize(int pageSize)
                    throws BaseException

Description copied from interface: PagingCalculator

Sets the current maximum number of elements per page. As the page size changes, the current page of data is reloaded. All pages, but maybe the last one, will have this number of elements.

Specified by:

setMaxPageSize in interface PagingCalculator

Parameters:

pageSize - the maximum number of values per page

Throws:

BaseException - if there is an error reloading the current page

getCurrentPage

public long getCurrentPage()

Description copied from interface: PagingCalculator

Returns the number of the currently loaded page of data (zero based).

Specified by:

getCurrentPage in interface PagingCalculator

Returns:

the current page number

setCurrentPage

public void setCurrentPage(long page)
                    throws BaseException

Description copied from interface: PagingCalculator

Sets the current page number (zero based), and loads the elements for that page.

Specified by:

setCurrentPage in interface PagingCalculator

Parameters:

page - the page to load

Throws:

BaseException - if there is an error setting the current page

getInitialIndex

public long getInitialIndex()

Description copied from interface: PagingCalculator

Returns the index of the initial element of the current page into all the elements.

Specified by:

getInitialIndex in interface PagingCalculator

Returns:

the index of the initial element

getNumPages

public long getNumPages()

Description copied from interface: PagingCalculator

Returns the number of pages available, calculated with the total number of elements and the maximum number of elements per page.

Specified by:

getNumPages in interface PagingCalculator

Returns:

the number of pages available

getTotalSize

public long getTotalSize()

Description copied from interface: PagingCalculator

Returns the number of elements of the entire set of data.

Specified by:

getTotalSize in interface PagingCalculator

Returns:

the number of elements

getCurrentPageSize

public int getCurrentPageSize()

Description copied from interface: PagingCalculator

Returns the number of elements of the current page. All the pages, but maybe the last one, will have the maximum number of elements per page.

Specified by:

getCurrentPageSize in interface PagingCalculator

Returns:

the current page size