|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPagedList<T>
An IPagedList represents a collection of query results. It is similar to a java.util.List, except the list itself cannot be modified. Modifications should be made via the content Federated APIs (NodeManager, TypeManager, etc).
An overview of PagedList capabilities, including sorting and filtering, is provided in the package documentation at com.bea.content.paging
An IPagedList implementation may load some or all of its items on-demand. If this is supported, the number of items to load at a time may be configured via the ContentListKeys.BATCH_LOADING_SIZE_KEY
context key and the getBatchLoadingSize() and setBatchLoadingSize() methods.
Field Summary |
---|
Fields inherited from interface com.bea.content.paging.ContentListKeys |
---|
ALL_ITEMS, BATCH_LOADING_SIZE_KEY, CUSTOM_OBJECT_FILTER, CUSTOM_OBJECT_SORT, FILTER_CRITERIA_KEY, SORT_CRITERIA_KEY |
Method Summary | |
---|---|
int |
fullSize() Finds query results size, regardless of the cost. |
int |
getBatchLoadingSize() Returns the current batch loading size. |
boolean |
isFullyResolved() For performance reasons, query results can be bounded at a maximum, such as 10,000 items. |
IPagedListIterator<T> |
iterator() Get an iterator to traverse the PagedList items. |
int |
nativeSize() If it is possible to efficiently determine the query results size, this method will return the size. |
void |
setBatchLoadingSize(int numItems) Updates the batch loading size |
Method Detail |
---|
IPagedListIterator<T> iterator() throws RepositoryRuntimeException
NOTE: any changes to the PagedList (such as resorting, refiltering, etc) will invalidate all iterators on the PagedList.
iterator
in interface Iterable<T>
RepositoryRuntimeException
boolean isFullyResolved() throws RepositoryRuntimeException
RepositoryRuntimeException
int fullSize() throws RepositoryRuntimeException
NOTE: this method is potentially very expensive, as expensive as accessing every item, since in many cases, the query results size cannot be determined efficiently. For this reason, it is generally preferable to call nativeSize() instead.
If you need to iterate over all results, it will be most efficient to skip a call to fullSize(), and use an iterator like this:
IPagedList<Node> allNodes= ... for ( Node node : allNodes ) { // use 'node' object }
RepositoryRuntimeException
int nativeSize() throws RepositoryRuntimeException
RepositoryRuntimeException
int getBatchLoadingSize() throws RepositoryRuntimeException
RepositoryRuntimeException
void setBatchLoadingSize(int numItems) throws RepositoryRuntimeException
RepositoryRuntimeException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.