BeanCollectionModel (Oracle Fusion Middleware Java API Reference for Oracle ADF Model)

java.lang.Object
- java.util.AbstractCollection<E>
- - oracle.adf.model.adapter.bean.provider.BeanCollectionModel<E>

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, Pagination, PaginationCollectionModel<E>

Direct Known Subclasses:

BeanDataCollection
```
public abstract class BeanCollectionModel<E>
extends java.util.AbstractCollection<E>
implements PaginationCollectionModel<E>
```
Since:

11.1.2

Field Summary

Fields
Modifier and Type Field and Description

protected oracle.adf.share.logging.ADFLogger _logger
Logger

static int DEFAULT_FETCH_SIZE
Default fetch size

Fields
Modifier and Type	Field and Description
`protected oracle.adf.share.logging.ADFLogger`	`_logger` Logger
`static int`	`DEFAULT_FETCH_SIZE` Default fetch size

Constructor Summary

Constructors
Constructor and Description

BeanCollectionModel()

Constructors
Constructor and Description
`BeanCollectionModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)`
`void`	`add(int index, E e)`
`boolean`	`addAll(java.util.Collection<? extends E> c)`
`void`	`addCollection(java.util.Collection<E> data)` Add data to managed collection
`boolean`	`canHandle()`
`void`	`clear()`
`protected void`	`clearAll()` Clear data buffer and cache page
`void`	`firstPage()` Action method bound to the "\|< First" link.
`java.util.Collection<E>`	`getCollection()` Returns a list of object that fit the given paging range.
`java.util.Collection<E>`	`getCollection(int start)` Return the page collection at startIndex
`java.lang.Object`	`getDataProvider()` Returns the data object for this collection represents.
`long`	`getEstimatedRowCount()` Return the total # of rows count for a query.
`int`	`getFetchedRowCount()`
`int`	`getFetchSize()` Return the fetch size per page
`int`	`getFetchStart()` Return fetch start
`java.lang.String`	`getFullName()`
`java.lang.String`	`getName()`
`int`	`getPageCount()`
`int`	`getPageIndex()`
`long`	`getRowCount()` Return the total rows count
`boolean`	`hasNextPage()` Method queried by the "Next" link to determine its enabled state.
`boolean`	`hasPreviousPage()` Method queried by the "Previous" link to determine its enabled state.
`java.util.Iterator<E>`	`iterator()` Return an iterator of this collection
`void`	`lastPage()` Action method bound to the "Last >\|" link.
`void`	`nextPage()` Action method bound to the "Next >" link.
`void`	`notifyRefresh()`
`void`	`previousPage()` Action method bound to the "< Previous" link.
`void`	`refresh()` Refresh the collection
`java.lang.Object`	`remove(int index)`
`boolean`	`remove(java.lang.Object o)`
`void`	`setFetchSize(int fetchSize)` Set fetch size
`void`	`setFetchStart(int fetchStart)` Set fetch start
`void`	`setPageSize(int pageSize)` Set page size
`void`	`setRowCount(long rowCount)` Set the total number row count for the collection
`int`	`size()`
`boolean`	`supportsDefaultPaging()`
`boolean`	`supportsRangePaging()`

Methods inherited from class java.util.AbstractCollection
contains, containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString

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

Methods inherited from interface java.util.Collection
equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - _logger
```
protected oracle.adf.share.logging.ADFLogger _logger
```
    Logger
  - DEFAULT_FETCH_SIZE
```
public static final int DEFAULT_FETCH_SIZE
```
    Default fetch size
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BeanCollectionModel
```
public BeanCollectionModel()
```
- Method Detail
  - refresh
```
public void refresh()
```
    Refresh the collection
  - notifyRefresh
```
public void notifyRefresh()
```
  - canHandle
```
public boolean canHandle()
```
    Specified by:
    
    canHandle in interface PaginationCollectionModel<E>
    
    Returns:
    
    Can handle operation
  - supportsRangePaging
```
public boolean supportsRangePaging()
```
  - supportsDefaultPaging
```
public boolean supportsDefaultPaging()
```
  - addAll
```
public boolean addAll(java.util.Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface java.util.Collection<E>
    
    Overrides:
    
    addAll in class java.util.AbstractCollection<E>
  - add
```
public boolean add(E e)
```
    Specified by:
    
    add in interface java.util.Collection<E>
    
    Overrides:
    
    add in class java.util.AbstractCollection<E>
  - add
```
public void add(int index,
                E e)
```
  - remove
```
public boolean remove(java.lang.Object o)
```
    Specified by:
    
    remove in interface java.util.Collection<E>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<E>
  - remove
```
public java.lang.Object remove(int index)
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<E>
    
    Specified by:
    
    size in class java.util.AbstractCollection<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<E>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<E>
  - clearAll
```
protected void clearAll()
```
    Clear data buffer and cache page
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Return an iterator of this collection
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in class java.util.AbstractCollection<E>
  - getEstimatedRowCount
```
public long getEstimatedRowCount()
```
    Return the total # of rows count for a query.
    
    Specified by:
    
    getEstimatedRowCount in interface PaginationCollectionModel<E>
    
    Returns:
    
    The method estimates long the number of rows in the collection.
  - addCollection
```
public void addCollection(java.util.Collection<E> data)
```
    Add data to managed collection
    
    Specified by:
    
    addCollection in interface PaginationCollectionModel<E>
    
    Parameters:
    
    data - Collection collection for page
  - getCollection
```
public java.util.Collection<E> getCollection()
```
    Returns a list of object that fit the given paging range.
    
    Specified by:
    
    getCollection in interface PaginationCollectionModel<E>
    
    Returns:
    
    the paging collection Collection
  - getCollection
```
public java.util.Collection<E> getCollection(int start)
```
    Return the page collection at startIndex
    
    Specified by:
    
    getCollection in interface PaginationCollectionModel<E>
    
    Returns:
    
    the paging collection at pageIndex
  - getDataProvider
```
public java.lang.Object getDataProvider()
```
    Returns the data object for this collection represents.
    
    Specified by:
    
    getDataProvider in interface PaginationCollectionModel<E>
    
    Returns:
    
    the data object for this collection represents.
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface PaginationCollectionModel<E>
    
    Returns:
    
    name of the data object
  - getFullName
```
public java.lang.String getFullName()
```
    Specified by:
    
    getFullName in interface PaginationCollectionModel<E>
    
    Returns:
    
    the full name of the data object in the form of package_name.name.
  - setPageSize
```
public void setPageSize(int pageSize)
```
    Set page size
    
    Specified by:
    
    setPageSize in interface Pagination
  - setFetchSize
```
public void setFetchSize(int fetchSize)
```
    Set fetch size
    
    Specified by:
    
    setFetchSize in interface Pagination
  - getFetchSize
```
public int getFetchSize()
```
    Description copied from interface: Pagination
    
    Return the fetch size per page
    
    Specified by:
    
    getFetchSize in interface Pagination
  - setFetchStart
```
public void setFetchStart(int fetchStart)
```
    Set fetch start
    
    Specified by:
    
    setFetchStart in interface Pagination
    
    Parameters:
    
    fetchStart - int rangeStart.
  - getFetchStart
```
public int getFetchStart()
```
    Description copied from interface: Pagination
    
    Return fetch start
    
    Specified by:
    
    getFetchStart in interface Pagination
    
    Returns:
    
    fetch start position
  - getPageIndex
```
public int getPageIndex()
```
    Returns:
    
    current page index
  - getPageCount
```
public int getPageCount()
```
    Returns:
    
    the number of pages in the collection
  - setRowCount
```
public void setRowCount(long rowCount)
```
    Set the total number row count for the collection
    
    Specified by:
    
    setRowCount in interface Pagination
    
    Parameters:
    
    rowCount -
  - getRowCount
```
public long getRowCount()
```
    Description copied from interface: Pagination
    
    Return the total rows count
    
    Specified by:
    
    getRowCount in interface Pagination
    
    Returns:
    
    The total numer of row count
  - getFetchedRowCount
```
public int getFetchedRowCount()
```
  - firstPage
```
public void firstPage()
```
    Action method bound to the "|< First" link. The _fromRange row
    
    Specified by:
    
    firstPage in interface Pagination
  - lastPage
```
public void lastPage()
```
    Action method bound to the "Last >|" link. Increment to the row.
    
    Specified by:
    
    lastPage in interface Pagination
  - nextPage
```
public void nextPage()
```
    Action method bound to the "Next >" link. Increment the row cursor by the increment size.
    
    Specified by:
    
    nextPage in interface Pagination
  - previousPage
```
public void previousPage()
```
    Action method bound to the "< Previous" link. Decrements the row cursor by the increment size.
    
    Specified by:
    
    previousPage in interface Pagination
  - hasNextPage
```
public boolean hasNextPage()
```
    Method queried by the "Next" link to determine its enabled state. Returns true if another _page exists.
    
    Specified by:
    
    hasNextPage in interface Pagination
  - hasPreviousPage
```
public boolean hasPreviousPage()
```
    Method queried by the "Previous" link to determine its enabled state. Returns true if a previous _page exists.
    
    Specified by:
    
    hasPreviousPage in interface Pagination

Class BeanCollectionModel<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

_logger

DEFAULT_FETCH_SIZE

Constructor Detail

BeanCollectionModel

Method Detail

refresh

notifyRefresh

canHandle

supportsRangePaging

supportsDefaultPaging

addAll

add

add

remove

remove

size

clear

clearAll

iterator

getEstimatedRowCount

addCollection

getCollection

getCollection

getDataProvider

getName

getFullName

setPageSize

setFetchSize

getFetchSize

setFetchStart

getFetchStart

getPageIndex

getPageCount

setRowCount

getRowCount

getFetchedRowCount

firstPage

lastPage

nextPage

previousPage

hasNextPage

hasPreviousPage