|
Oracle ADF Model and Business Components API Reference 10.1.2 B14022-02 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface for Row Set Iterator. A Row Iterator is an iterator over a collection of View rows or Entity rows.
RowSetIterator
is an extended interface of
, which itself extends NavigatableRowIterator
. Refer to these base interfaces for detailed description of iteration functionalities.RowIterator
NavigatableRowIterator
, RowIterator
Field Summary |
Fields inherited from interface oracle.jbo.RowIterator |
ITER_MODE_LAST_PAGE_FULL, ITER_MODE_LAST_PAGE_PARTIAL, SLOT_BEFORE_FIRST, SLOT_BEYOND_LAST, SLOT_DELETED, SLOT_VALID |
Method Summary | |
void |
addManagementListener(RowSetManagementListener listener) Adds a subscriber (listener) to be notified of RowSetManagementListener events generated by this Row Set Iterator. |
void |
closeRowSetIterator() Closes this row set iterator. |
RowSet |
createDetailRowSet(java.lang.String rsName, java.lang.String viewLinkDefName) Creates a detail Row Set. |
RowSet[] |
getDetailRowSets() Gets an array of detail Row Sets for which this Iterator is the master. |
int |
getEstimatedRangePageCount() Returns getEstimatedRowCount()/rangePageSize, if rangeSize > 0. |
Row[] |
getFilteredRows(java.lang.String attrName, java.lang.Object attrValue) Returns all rows in this collection whose attribute value matches the value being passed in attrValue . |
Row[] |
getFilteredRowsInRange(java.lang.String attrName, java.lang.Object attrValue) Returns all rows in this range whose attribute value matches the value being passed in attrValue . |
java.lang.String |
getName() Gets the name of the Iterator. |
Row[] |
getNextRangeSet() Gets the next set of rows in the range. |
Row[] |
getPreviousRangeSet() Gets the previous set of rows in the range. |
RowSet |
getRowSet() Gets the Row Set that this Iterator belongs to. |
java.lang.Object |
getSyncLock() Gets the locking object for this Row Set Iterator. |
boolean |
isNameGenerated() Tests if the Iterator's name was generated by the system. |
void |
removeManagementListener(RowSetManagementListener listener) Removes a subscriber (listener) for RowSetManagementListener events generated by this row set iterator. |
int |
scrollToRangePage(int pageIndex) Moves the row set range start to the given page index where every page consists of RangeSize number of rows. |
Methods inherited from interface oracle.jbo.NavigatableRowIterator |
addListener, removeListener |
Method Detail |
public java.lang.String getName()
RowSet.createRowSetIterator(String)
for more info.public boolean isNameGenerated()
true
if the name was generated by the system. false
if the name was given by the user and not generated by the system.public Row[] getNextRangeSet()
getNextRangeSet()
will return rows 10 through 19.
If the next range set does not have enough rows to fill up the range, getNextRangeSet()
returns a partially filled range. That is, this method operates as if the iteration mode is
.RowIterator.ITER_MODE_LAST_PAGE_PARTIAL
If there is no more rows, this method returns an empty array (an array of length 0).
While obtaining the next range set, the range will be scrolled. This causes a
to be sent to #oracle.jbo.ScrollEvent
. To pick up such an event, the listener object must implement the #oracle.jbo.RowSetListener.rangeScrolled(oracle.jbo.ScrollEvent)
interface. Further, this listener must be registered through a call to #oracle.jbo.RowSetListener
(the listener object passed in as the parameter to #oracle.jbo.NavigatableRowIterator.addListener(Object)
addListener
).
After the next range set is obtained, the method sets the first Row of the range as the current row. This may fire a
and sends it to #oracle.jbo.NavigationEvent
.#oracle.jbo.RowSetListener.navigated(oracle.jbo.NavigationEvent)
public Row[] getPreviousRangeSet()
getPreviousRangeSet()
will return rows 0 through 9.
If there is no more rows, this method returns an empty array (an array of length 0).
While obtaining the previous range set, the range will be scrolled. This causes a
to be sent to #oracle.jbo.ScrollEvent
. To pick up such an event, the listener object must implement the #oracle.jbo.RowSetListener.rangeScrolled(oracle.jbo.ScrollEvent)
interface. Further, this listener must be registered through a call to #oracle.jbo.RowSetListener
(the listener object passed in as the parameter to #oracle.jbo.NavigatableRowIterator.addListener(Object)
addListener
).
After the previous range set is obtained, the method sets the first Row of the range as the current row. This may fire a
and sends it to #oracle.jbo.NavigationEvent
.#oracle.jbo.RowSetListener.navigated(oracle.jbo.NavigationEvent)
public RowSet getRowSet()
public int getEstimatedRangePageCount()
This number may fluxuate when the View Object is syncronized with its Entity Object.
public int scrollToRangePage(int pageIndex)
(rangeSize * (pageSize-1)) - getRangeStart();
pageIndex
- the page number to go to in the result set.public RowSet[] getDetailRowSets()
In a master-detail relationship in an Application Module, the master in reality is a Row Set Iterator. (Though we often speak of master View Object, in reality, it is the Iterator behind the View Object which is playing the role of the master). Whenever the currency of this master Iterator moves, the detail Row Sets are re-executed to show related Rows.
Calling this method returns an array of Row Sets that are related to this Iterator as detail Row Sets.
RowSet
.public RowSet createDetailRowSet(java.lang.String rsName, java.lang.String viewLinkDefName)
getDetailRowSets()
for explanation of detail Row Sets.
This method creates a new detail Row Set for this Iterator.
rsName
- the name of the new detail Row Set.viewLinkDefName
- the name of a View Link definition. This View Link chooses the relationship in which this Iterator is the master and the new Row Set is the detail. It must be a fully qualified name (including the package name).public void addManagementListener(RowSetManagementListener listener)
RowSetManagementListener
events generated by this Row Set Iterator.listener
- the subscriber to be added. It should implement RowSetManagementListener
.public void removeManagementListener(RowSetManagementListener listener)
RowSetManagementListener
events generated by this row set iterator.listener
- the subscriber to be removed.public void closeRowSetIterator()
closeRowSetIterator
closes all detail row sets.
After that, it fires a RowSetManagementListener.iteratorClosed()
event to its RowSetManagementListener's
.
Then, it deregisters this row set iterator from the owning row set, and deregisters all its listeners.
public java.lang.Object getSyncLock()
ApplicationModule.getSyncLock()
for details.public Row[] getFilteredRows(java.lang.String attrName, java.lang.Object attrValue)
attrValue
.
Note that this method does not affect the current RowSetIterator
.
attrName
- name of the attribute to be used for filtering.attrValue
- attribute value for filtering.public Row[] getFilteredRowsInRange(java.lang.String attrName, java.lang.Object attrValue)
attrValue
.
This method uses getAllRowsInRange()
to retrieve all rows and then match the rows.
attrName
- name of the attribute to be used for filtering.attrValue
- attribute value for filtering.
|
Oracle ADF Model and Business Components API Reference 10.1.2 B14022-02 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2005, Oracle. All rights reserved.