|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractMap
oracle.jbo.common.JboAbstractMap
oracle.jbo.common.ws.WSObject
oracle.jbo.common.ws.WSAMComponent
oracle.jbo.common.ws.WSRowSetIteratorBase
oracle.jbo.common.ws.WSRowSetIteratorImpl
public class WSRowSetIteratorImpl
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.util.AbstractMap |
---|
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V> |
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Field Summary |
---|
Fields inherited from class oracle.jbo.common.ws.WSRowSetIteratorBase |
---|
mListeners, mMgmtListeners, mName |
Fields inherited from class oracle.jbo.common.ws.WSObject |
---|
mVariableOpers |
Fields inherited from class oracle.jbo.common.JboAbstractMap |
---|
MAP_NULL_VALUE |
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 |
closeRowSetIterator()
Closes this row set iterator. |
RowSet |
createDetailRowSet(java.lang.String rsName,
java.lang.String linkDefName)
Creates a detail Row Set. |
ApplicationModule |
getApplicationModule()
|
RowSet[] |
getDetailRowSets()
Gets an array of detail Row Sets for which this Iterator is the master. |
java.lang.Object |
getImplObject()
|
int |
getIterMode()
Gets the current iteration mode. |
WSObject |
getParent()
|
int |
getRangeSize()
Gets the size of the Row Set Iterator range. |
int |
getRangeStart()
Gets the absolute row index of the first row in the Row Set Iterator range. |
RowSet |
getRowSet()
Gets the Row Set that this Iterator belongs to. |
RowSetIterator |
getRowSetIteratorImpl()
|
java.lang.Object |
getSyncLock()
Gets the locking object for this Row Set Iterator. |
boolean |
isOnLine()
|
boolean |
isRowValidation()
Gets the validation flag on this iterator. |
boolean |
isSyncIteratorState()
|
void |
markForError(java.lang.Exception ex,
boolean hasImplObject)
|
int |
scrollRange(int amount)
Moves the Row Set Iterator range up or down a given number of rows. |
int |
scrollRangeTo(Row row,
int index)
Scrolls the range to place a given row at a given range index. |
void |
setImplObject(java.lang.Object o)
|
void |
setIterMode(int mode)
Sets the iteration mode for this Row Iterator. |
int |
setRangeSize(int size)
Modifies the size of the Row Set Iterator range. |
int |
setRangeStart(int start)
Moves the Row Set Iterator range. |
void |
setRowValidation(boolean flag)
Sets the validation flag on this iterator. |
Methods inherited from class oracle.jbo.common.ws.WSAMComponent |
---|
getMessageBundleClass, getResourceBundleDef |
Methods inherited from class oracle.jbo.common.ws.WSObject |
---|
closeObject, ensureVariableManager, get, getFullName, getId, getImageLoc, getVariableManager, hasVariables, isReadOnly, setName |
Methods inherited from class oracle.jbo.common.JboAbstractMap |
---|
entrySet, equals, hashCode, internalGet, internalPut, put, setThrowIfPropertyNotFoundOnGet |
Methods inherited from class java.util.AbstractMap |
---|
clear, clone, containsKey, containsValue, isEmpty, keySet, putAll, remove, size, toString, values |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.jbo.RowSetIterator |
---|
addManagementListener, getEstimatedRangePageCount, getFilteredRows, getFilteredRowsInRange, getName, getNextRangeSet, getPreviousRangeSet, isNameGenerated, removeManagementListener, scrollToRangePage |
Methods inherited from interface oracle.jbo.NavigatableRowIterator |
---|
addListener, removeListener |
Methods inherited from interface oracle.jbo.VariableManagerOwnerBase |
---|
ensureVariableManager, getMessageBundleClass, getResourceBundleDef, getVariableManager, hasVariables |
Method Detail |
---|
public boolean isOnLine()
public WSObject getParent()
getParent
in class WSObject
public RowSetIterator getRowSetIteratorImpl()
public java.lang.Object getImplObject()
getImplObject
in class WSObject
public void setImplObject(java.lang.Object o)
setImplObject
in class WSObject
public void markForError(java.lang.Exception ex, boolean hasImplObject)
markForError
in class WSObject
public ApplicationModule getApplicationModule()
public boolean isSyncIteratorState()
public RowSet getRowSet()
RowSetIterator
getRowSet
in interface RowSetIterator
getRowSet
in class WSRowSetIteratorBase
public RowSet[] getDetailRowSets()
RowSetIterator
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.
getDetailRowSets
in interface RowSetIterator
getDetailRowSets
in class WSRowSetIteratorBase
RowSet
.public RowSet createDetailRowSet(java.lang.String rsName, java.lang.String linkDefName)
RowSetIterator
RowSetIterator.getDetailRowSets()
for explanation of detail Row Sets.
This method creates a new detail Row Set for this Iterator.
createDetailRowSet
in interface RowSetIterator
createDetailRowSet
in class WSRowSetIteratorBase
rsName
- the name of the new detail Row Set.linkDefName
- 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 closeRowSetIterator()
RowSetIterator
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.
closeRowSetIterator
in interface RowSetIterator
closeRowSetIterator
in class WSRowSetIteratorBase
public java.lang.Object getSyncLock()
RowSetIterator
ApplicationModule.getSyncLock()
for details.
getSyncLock
in interface RowSetIterator
getSyncLock
in class WSRowSetIteratorBase
public int setRangeSize(int size)
RowIterator
This method takes effect when the next set of data is fetched. For an example usage of setRangeSize, see setRangeStart.
setRangeSize
in interface RowIterator
setRangeSize
in class WSRowSetIteratorBase
size
- the new number of rows in the iterator range. Size of
0 is treated same as 1. Size < -1 is treated same as -1.
RowIterator.setRangeStart(int)
public int getRangeSize()
RowIterator
getRangeSize
in interface RowIterator
getRangeSize
in class WSRowSetIteratorBase
public int getRangeStart()
RowIterator
The absolute index is 0-based, and is the row's index relative to the entire result set.
getRangeStart
in interface RowIterator
getRangeStart
in class WSRowSetIteratorBase
public int setRangeStart(int start)
RowIterator
Note that the index is 0-based. When you call setRangeStart(1), the range start will be positioned at the second table row.
Another behavior of setRangeStart (and also setRangeSize) is that it tries to position the range, so as to fill up the range as much as possible. For example, assume you have View Object vo focused on a table with four rows (A, B, C, D), and you execute the following code:
vo.setRangeStart(4); vo.setRangeSize(3); Row[] rows = vo.getAllRowsInRange();
In this case, rows contains the last 3 rows (B, C, D). When you call setRangeStart(4), it will try to position you at row 4. Since the index is 0-based, it finds that there is no row. Since the default range size is 1, it will position you to the last row (row index 3).
Then, when you call getRangeSize(3), it tries to fill up the range from the bottom. This is why you get (B, C, D).
setRangeStart
in interface RowIterator
setRangeStart
in class WSRowSetIteratorBase
start
- the absolute index of the new first row in the Row Set Iterator range.public int scrollRange(int amount)
RowIterator
scrollRange
in interface RowIterator
scrollRange
in class WSRowSetIteratorBase
amount
- the number of rows to scroll.
A negative value scrolls upward.
public int scrollRangeTo(Row row, int index)
RowIterator
scrollRangeTo
in interface RowIterator
scrollRangeTo
in class WSRowSetIteratorBase
row
- the row.index
- the range index at which the row is to be found.
public void setRowValidation(boolean flag)
RowIterator
setRowValidation
in interface RowIterator
setRowValidation
in class WSRowSetIteratorBase
flag
- Whether to turn row validation off or not.public boolean isRowValidation()
RowIterator
isRowValidation
in interface RowIterator
isRowValidation
in class WSRowSetIteratorBase
public int getIterMode()
RowIterator
getIterMode
in interface RowIterator
getIterMode
in class WSRowSetIteratorBase
public void setIterMode(int mode)
RowIterator
setIterMode
in interface RowIterator
setIterMode
in class WSRowSetIteratorBase
mode
- should be ITER_MODE_LAST_PAGE_PARTIAL if the iteration mode is
to be "partial-last-page", ITER_MODE_LAST_PAGE_FULL if it
is to be "full-last-page".
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |