AbstractPagedCollection (GraniteDS API Documentation)

java.lang.Object
- org.granite.client.tide.collection.AbstractPagedCollection<E,F>

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, ContextAware, TideEventObserver, Initializable, NameAware, Component, org.granite.client.util.PropertyHolder

Direct Known Subclasses:

PagedQuery
```
public abstract class AbstractPagedCollection<E,F>
extends java.lang.Object
implements java.util.List<E>, Component, org.granite.client.util.PropertyHolder, NameAware, ContextAware, Initializable, TideEventObserver
```
Author:

William DRAI

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class AbstractPagedCollection.PagedCollectionIterator

Nested Classes
Modifier and Type	Class and Description
`class`	`AbstractPagedCollection.PagedCollectionIterator`

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`count`
`protected boolean`	`filterRefresh`
`protected int`	`first`
`protected boolean`	`fullRefresh`
`protected boolean`	`initializing`
`protected int`	`last`
`protected int`	`max`
`protected SortAdapter`	`sortAdapter`

Constructor Summary

Constructors
Constructor and Description
`AbstractPagedCollection()`
`AbstractPagedCollection(Component remoteComponent, PageFilterFinder<E> finder, int maxResults)`
`AbstractPagedCollection(Component remoteComponent, SimpleFilterFinder<E> finder, int maxResults)`
`AbstractPagedCollection(Component remoteComponent, java.lang.String methodName, int maxResults)`
`AbstractPagedCollection(ServerSession serverSession)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)`
`void`	`add(int index, E element)`
`boolean`	`addAll(java.util.Collection<? extends E> c)`
`boolean`	`addAll(int index, java.util.Collection<? extends E> c)`
`<T> java.util.concurrent.Future<T>`	`call(java.lang.String operation, java.lang.Object... args)` Call a remote operation on the component
`void`	`clear()` Clear collection content
`protected abstract java.lang.Object`	`cloneFilter()`
`boolean`	`contains(java.lang.Object o)`
`boolean`	`containsAll(java.util.Collection<?> c)`
`protected java.util.concurrent.Future<?>`	`doFind(java.lang.Object filter, int first, int max)`
`protected java.util.concurrent.Future<?>`	`find(int first, int last)` Trigger a results query for the current filter
`protected void`	`findFault(TideFaultEvent event, int first, int max)` Event handler for results fault
`protected void`	`findResult(TideResultEvent<?> event, int first, int max)` Event handler for results query
`protected abstract void`	`firePageChange(TideRpcEvent event, int previousFirst, int previousLast, java.util.List<E> savedSnapshot)` Notify listeners of remote page result
`boolean`	`fullRefresh()` Force refresh of collection when filter/sort have been changed
`E`	`get(int index)` Override of get() with lazy page loading
`java.lang.Class<? extends E>`	`getElementClass()`
`abstract F`	`getFilter()`
`protected abstract java.util.List<E>`	`getInternalWrappedList()`
`java.lang.String`	`getName()` Component name
`java.lang.Object`	`getObject()` PropertyHolder interface
`protected org.granite.tide.data.model.Page<E>`	`getResult(TideResultEvent<?> event, int first, int max)` Build a result object from the result event
`SortAdapter`	`getSortAdapter()`
`protected abstract java.util.List<E>`	`getWrappedList()`
`void`	`handleEvent(TideEvent event)`
`protected void`	`handleFault(TideFaultEvent event, int first, int max)` Event handler for results query fault
`protected void`	`handleResult(org.granite.tide.data.model.Page<E> page, TideResultEvent<?> event, int first, int max)` Event handler for results query
`int`	`indexOf(java.lang.Object o)`
`void`	`init()`
`protected abstract void`	`initFilter()`
`protected void`	`initialize(TideResultEvent<?> event)` Initialize collection after first find
`boolean`	`isEmpty()`
`java.util.Iterator<E>`	`iterator()`
`int`	`lastIndexOf(java.lang.Object o)`
`java.util.ListIterator<E>`	`listIterator()`
`java.util.ListIterator<E>`	`listIterator(int index)`
`boolean`	`refresh()` Refresh collection with new filter/sort parameters
`E`	`remove(int index)`
`boolean`	`remove(java.lang.Object o)`
`boolean`	`removeAll(java.util.Collection<?> c)`
`void`	`reset()`
`void`	`resetFilter()`
`void`	`resetSort()`
`boolean`	`retainAll(java.util.Collection<?> c)`
`E`	`set(int index, E element)`
`void`	`setCancelPendingCalls(boolean cancel)`
`void`	`setContext(Context context)`
`void`	`setElementClass(java.lang.Class<? extends E> elementClass)`
`abstract void`	`setFilter(F filter)`
`void`	`setFilterClass(java.lang.Class<F> filterClass)`
`void`	`setMaxResults(int max)` Set the page size.
`void`	`setMethodName(java.lang.String methodName)`
`void`	`setName(java.lang.String componentName)` Set the name of this object in its owning context
`void`	`setPageFilterFinder(PageFilterFinder<E> finder)`
`void`	`setProperty(java.lang.String propName, java.lang.Object value)`
`void`	`setRemoteComponent(Component remoteComponent)`
`void`	`setRemoteComponentClass(java.lang.Class<? extends Component> remoteComponentClass)`
`void`	`setRemoteComponentName(java.lang.String remoteComponentName)`
`void`	`setSimpleFilterFinder(SimpleFilterFinder<E> finder)`
`void`	`setSortAdapter(SortAdapter sortAdapter)`
`void`	`setUsePage(boolean usePage)`
`int`	`size()` Get total number of elements
`java.util.List<E>`	`subList(int fromIndex, int toIndex)`
`protected void`	`updateCount(int cnt)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List
equals, hashCode, toArray, toArray

- Field Detail
  - sortAdapter
```
protected SortAdapter sortAdapter
```
  - initializing
```
protected boolean initializing
```
  - first
```
protected int first
```
  - last
```
protected int last
```
  - max
```
protected int max
```
  - count
```
protected int count
```
  - fullRefresh
```
protected boolean fullRefresh
```
  - filterRefresh
```
protected boolean filterRefresh
```
- Constructor Detail
  - AbstractPagedCollection
```
public AbstractPagedCollection()
```
  - AbstractPagedCollection
```
public AbstractPagedCollection(ServerSession serverSession)
```
  - AbstractPagedCollection
```
public AbstractPagedCollection(Component remoteComponent,
                       java.lang.String methodName,
                       int maxResults)
```
  - AbstractPagedCollection
```
public AbstractPagedCollection(Component remoteComponent,
                       PageFilterFinder<E> finder,
                       int maxResults)
```
  - AbstractPagedCollection
```
public AbstractPagedCollection(Component remoteComponent,
                       SimpleFilterFinder<E> finder,
                       int maxResults)
```
- Method Detail
  - initFilter
```
protected abstract void initFilter()
```
  - size
```
public int size()
```
    Get total number of elements
    
    Specified by:
    
    size in interface java.util.Collection<E>
    
    Specified by:
    
    size in interface java.util.List<E>
    
    Returns:
    collection total size
  - updateCount
```
protected void updateCount(int cnt)
```
  - setMaxResults
```
public void setMaxResults(int max)
```
    Set the page size. The collection will store in memory twice this page size, and each server call will return at most the page size.
    
    Parameters:
    max - maximum number of requested elements
  - setElementClass
```
public void setElementClass(java.lang.Class<? extends E> elementClass)
```
  - getElementClass
```
public java.lang.Class<? extends E> getElementClass()
```
  - setCancelPendingCalls
```
public void setCancelPendingCalls(boolean cancel)
```
  - setName
```
public void setName(java.lang.String componentName)
```
    Description copied from interface: NameAware
    
    Set the name of this object in its owning context
    
    Specified by:
    
    setName in interface NameAware
    
    Parameters:
    componentName - name
  - setContext
```
public void setContext(Context context)
```
    Specified by:
    
    setContext in interface ContextAware
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: Component
    
    Component name
    
    Specified by:
    
    getName in interface Component
    
    Returns:
    component name
  - setRemoteComponentName
```
public void setRemoteComponentName(java.lang.String remoteComponentName)
```
  - setRemoteComponentClass
```
public void setRemoteComponentClass(java.lang.Class<? extends Component> remoteComponentClass)
                             throws java.lang.IllegalAccessException,
                                    java.lang.InstantiationException
```
    Throws:
    
    java.lang.IllegalAccessException
    
    java.lang.InstantiationException
  - setRemoteComponent
```
public void setRemoteComponent(Component remoteComponent)
```
  - setMethodName
```
public void setMethodName(java.lang.String methodName)
```
  - setPageFilterFinder
```
public void setPageFilterFinder(PageFilterFinder<E> finder)
```
  - setSimpleFilterFinder
```
public void setSimpleFilterFinder(SimpleFilterFinder<E> finder)
```
  - setUsePage
```
public void setUsePage(boolean usePage)
```
  - init
```
public void init()
```
    Specified by:
    
    init in interface Initializable
  - setSortAdapter
```
public void setSortAdapter(SortAdapter sortAdapter)
```
  - getSortAdapter
```
public SortAdapter getSortAdapter()
```
  - resetSort
```
public void resetSort()
```
  - setFilterClass
```
public void setFilterClass(java.lang.Class<F> filterClass)
                    throws java.lang.IllegalAccessException,
                           java.lang.InstantiationException
```
    Throws:
    
    java.lang.IllegalAccessException
    
    java.lang.InstantiationException
  - resetFilter
```
public void resetFilter()
```
  - setFilter
```
public abstract void setFilter(F filter)
```
  - reset
```
public void reset()
```
  - handleEvent
```
public void handleEvent(TideEvent event)
```
    Specified by:
    
    handleEvent in interface TideEventObserver
  - clear
```
@PreDestroy
public void clear()
```
    Clear collection content
    
    Specified by:
    
    clear in interface java.util.Collection<E>
    
    Specified by:
    
    clear in interface java.util.List<E>
  - find
```
protected java.util.concurrent.Future<?> find(int first,
                                  int last)
```
    Trigger a results query for the current filter
    
    Parameters:
    first - : index of first required result
    last - : index of last required result
  - doFind
```
protected java.util.concurrent.Future<?> doFind(java.lang.Object filter,
                                    int first,
                                    int max)
```
  - getFilter
```
public abstract F getFilter()
```
  - cloneFilter
```
protected abstract java.lang.Object cloneFilter()
```
  - getResult
```
protected org.granite.tide.data.model.Page<E> getResult(TideResultEvent<?> event,
                                            int first,
                                            int max)
```
    Build a result object from the result event
    
    Parameters:
    event - the result event
    first - first index requested
    max - max elements requested
    
    Returns:
    a Page object containing data from the collection resultList : the retrieved data resultCount : the total count of elements (non paged) firstResult : the index of the first retrieved element maxResults : the maximum count of retrieved elements
  - fullRefresh
```
public boolean fullRefresh()
```
    Force refresh of collection when filter/sort have been changed
    
    Returns:
    always false
  - refresh
```
public boolean refresh()
```
    Refresh collection with new filter/sort parameters
    
    Returns:
    always false
  - firePageChange
```
protected abstract void firePageChange(TideRpcEvent event,
                  int previousFirst,
                  int previousLast,
                  java.util.List<E> savedSnapshot)
```
    Notify listeners of remote page result
    
    Parameters:
    event - the remote event (ResultEvent or FaultEvent)
    previousFirst - index of first element before last updated list
    previousLast - index of last element before last updated list
    savedSnapshot - collection snapshot before last change
  - initialize
```
protected void initialize(TideResultEvent<?> event)
```
    Initialize collection after first find
    
    Parameters:
    event - the result event of the first find
  - findResult
```
protected void findResult(TideResultEvent<?> event,
              int first,
              int max)
```
    Event handler for results query
    
    Parameters:
    event - the result event
    first - first requested index
    max - max elements requested
  - handleResult
```
protected void handleResult(org.granite.tide.data.model.Page<E> page,
                TideResultEvent<?> event,
                int first,
                int max)
```
    Event handler for results query
    
    Parameters:
    page - the result page
    event - the result event
    first - first requested index
    max - max elements requested
  - findFault
```
protected void findFault(TideFaultEvent event,
             int first,
             int max)
```
    Event handler for results fault
    
    Parameters:
    event - the fault event
    first - first requested index
    max - max elements requested
  - handleFault
```
protected void handleFault(TideFaultEvent event,
               int first,
               int max)
```
    Event handler for results query fault
    
    Parameters:
    event - the fault event
  - getInternalWrappedList
```
protected abstract java.util.List<E> getInternalWrappedList()
```
  - getWrappedList
```
protected abstract java.util.List<E> getWrappedList()
```
  - get
```
public E get(int index)
```
    Override of get() with lazy page loading
    
    Specified by:
    
    get in interface java.util.List<E>
    
    Parameters:
    index - index of requested item
    
    Returns:
    object at specified index
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection<E>
    
    Specified by:
    
    isEmpty in interface java.util.List<E>
  - contains
```
public boolean contains(java.lang.Object o)
```
    Specified by:
    
    contains in interface java.util.Collection<E>
    
    Specified by:
    
    contains in interface java.util.List<E>
  - containsAll
```
public boolean containsAll(java.util.Collection<?> c)
```
    Specified by:
    
    containsAll in interface java.util.Collection<E>
    
    Specified by:
    
    containsAll in interface java.util.List<E>
  - indexOf
```
public int indexOf(java.lang.Object o)
```
    Specified by:
    
    indexOf in interface java.util.List<E>
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object o)
```
    Specified by:
    
    lastIndexOf in interface java.util.List<E>
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.util.List<E>
  - listIterator
```
public java.util.ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface java.util.List<E>
  - listIterator
```
public java.util.ListIterator<E> listIterator(int index)
```
    Specified by:
    
    listIterator in interface java.util.List<E>
  - add
```
public boolean add(E e)
```
    Specified by:
    
    add in interface java.util.Collection<E>
    
    Specified by:
    
    add in interface java.util.List<E>
  - add
```
public void add(int index,
       E element)
```
    Specified by:
    
    add in interface java.util.List<E>
  - addAll
```
public boolean addAll(java.util.Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface java.util.Collection<E>
    
    Specified by:
    
    addAll in interface java.util.List<E>
  - addAll
```
public boolean addAll(int index,
             java.util.Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface java.util.List<E>
  - remove
```
public boolean remove(java.lang.Object o)
```
    Specified by:
    
    remove in interface java.util.Collection<E>
    
    Specified by:
    
    remove in interface java.util.List<E>
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface java.util.List<E>
  - removeAll
```
public boolean removeAll(java.util.Collection<?> c)
```
    Specified by:
    
    removeAll in interface java.util.Collection<E>
    
    Specified by:
    
    removeAll in interface java.util.List<E>
  - retainAll
```
public boolean retainAll(java.util.Collection<?> c)
```
    Specified by:
    
    retainAll in interface java.util.Collection<E>
    
    Specified by:
    
    retainAll in interface java.util.List<E>
  - set
```
public E set(int index,
    E element)
```
    Specified by:
    
    set in interface java.util.List<E>
  - subList
```
public java.util.List<E> subList(int fromIndex,
                        int toIndex)
```
    Specified by:
    
    subList in interface java.util.List<E>
  - getObject
```
public java.lang.Object getObject()
```
    PropertyHolder interface
    
    Specified by:
    
    getObject in interface org.granite.client.util.PropertyHolder
  - setProperty
```
public void setProperty(java.lang.String propName,
               java.lang.Object value)
```
    Specified by:
    
    setProperty in interface org.granite.client.util.PropertyHolder
  - call
```
public <T> java.util.concurrent.Future<T> call(java.lang.String operation,
                                      java.lang.Object... args)
```
    Description copied from interface: Component
    
    Call a remote operation on the component
    
    Specified by:
    
    call in interface Component
    
    Type Parameters:
    T - expected return type
    Parameters:
    operation - method name
    args - arguments
    
    Returns:
    future triggered when response is received

Class AbstractPagedCollection<E,F>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Field Detail

sortAdapter

initializing

first

last

max

count

fullRefresh

filterRefresh

Constructor Detail

AbstractPagedCollection

AbstractPagedCollection

AbstractPagedCollection

AbstractPagedCollection

AbstractPagedCollection

Method Detail

initFilter

size

updateCount

setMaxResults

setElementClass

getElementClass

setCancelPendingCalls

setName

setContext

getName

setRemoteComponentName

setRemoteComponentClass

setRemoteComponent

setMethodName

setPageFilterFinder

setSimpleFilterFinder

setUsePage

init

setSortAdapter

getSortAdapter

resetSort

setFilterClass

resetFilter

setFilter

reset

handleEvent

clear

find

doFind

getFilter

cloneFilter

getResult

fullRefresh

refresh

firePageChange

initialize

findResult

handleResult

findFault

handleFault

getInternalWrappedList

getWrappedList

get

isEmpty

contains

containsAll

indexOf

lastIndexOf

iterator

listIterator

listIterator

add

add

addAll

addAll

remove

remove