AbstractBatchingList Class Reference

Inherits java::util::AbstractList, and er::extensions::batching::IBatchingList.

Collaboration diagram for AbstractBatchingList:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 AbstractBatchingList ()
Object get (int index)
void setPageIndex (int pageIndex)
void setPageSize (int pageSize)
void setSortOrderings (NSArray sortOrderings)
int size ()

Protected Member Functions

void ensurePageLoaded (int index)
abstract Object getFromPage (int index)
abstract int getTotalCount ()
abstract void invalidatePage ()
abstract boolean isPageLoaded ()
abstract void loadPage (int startingIndex, int pageSize, NSArray sortOrderings)

Private Attributes

int _pageIndex
int _pageSize
NSArray _sortOrderings


Detailed Description

Partial implementation of the IBatchingList interface that handles page invalidation and most of the List interface.

Author:
mschrag

Constructor & Destructor Documentation


Member Function Documentation

void ensurePageLoaded ( int  index  )  [protected]

Object get ( int  index  ) 

abstract Object getFromPage ( int  index  )  [protected, pure virtual]

Returns the index'th element from the current page.

Parameters:
index the index of the element to return
Returns:
the element

abstract int getTotalCount (  )  [protected, pure virtual]

Returns the total size of this list.

abstract void invalidatePage (  )  [protected, pure virtual]

Invalidates the current page of objects, requiring a reload.

abstract boolean isPageLoaded (  )  [protected, pure virtual]

Returns whether or not the current page has been loaded.

abstract void loadPage ( int  startingIndex,
int  pageSize,
NSArray  sortOrderings 
) [protected, pure virtual]

Loads one page into this list.

Parameters:
startingIndex the index of the first element of the page (in element units, not page units)
pageSize the size of the page to load
sortOrderings the list of sort orderings

void setPageIndex ( int  _pageIndex  ) 

Sets the page number that is currently being viewed on this list.

Parameters:
_pageIndex the page number

Implements IBatchingList.

void setPageSize ( int  _pageSize  ) 

Sets the page size of this list.

Parameters:
_pageSize the page size

Implements IBatchingList.

void setSortOrderings ( NSArray  _sortOrderings  ) 

Sets the sort orderings of this list.

Parameters:
_sortOrderings the sort orderings array

Implements IBatchingList.

int size (  ) 


Member Data Documentation

int _pageIndex [private]

int _pageSize [private]

NSArray _sortOrderings [private]


The documentation for this class was generated from the following file:

Generated on Sat May 26 06:43:03 2012 for Project Wonder by  doxygen 1.5.8