oracle.jbo.common.ws
Class WSRowSetIterator

java.lang.Object
  |
  +--oracle.jbo.common.ws.WSObject
        |
        +--oracle.jbo.common.ws.WSRowSetIteratorBase
              |
              +--oracle.jbo.common.ws.WSRowSetIterator

All Implemented Interfaces:

NavigatableRowIterator, RowIterator, RowSetIterator, java.io.Serializable

public class WSRowSetIterator

extends WSRowSetIteratorBase

implements RowSetIterator, java.io.Serializable

See Also:

Serialized Form

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

Type	Method
void	closeRowSetIterator() Closes this row set iterator.
RowSet	createDetailRowSet(java.lang.String rsName, java.lang.String linkDefName) Creates a detail Row Set.
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 range.
int	getRangeStart() Gets the absolute index of the first row in the row set 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.
int	scrollRange(int amount) Moves the row set 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 row set 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 range.
int	setRangeStart(int start) Moves the row set range.
void	setRowValidation(boolean flag) Sets the validation flag on this iterator.

Methods inherited from class oracle.jbo.common.ws.WSRowSetIteratorBase

addListener, addManagementListener, createAndInitRow, createKey, createRow, enumerateRowsInRange, findByEntity, findByKey, first, getAllRowsInRange, getCurrentRow, getCurrentRowIndex, getCurrentRowSlot, getFetchedRowCount, getName, getNextRangeSet, getPreviousRangeSet, getRangeIndexOf, getRow, getRowAtRangeIndex, getRowCount, getRowCountInRange, hasNext, hasPrevious, insertRow, insertRowAtRangeIndex, isConnected, isNameGenerated, isRangeAtBottom, isRangeAtTop, last, next, previous, removeCurrentRow, removeListener, removeManagementListener, reset, setCurrentRow, setCurrentRowAtRangeIndex

Methods inherited from class oracle.jbo.common.ws.WSObject

getId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.jbo.RowSetIterator

addManagementListener, getName, getNextRangeSet, getPreviousRangeSet, isNameGenerated, removeManagementListener

Methods inherited from interface oracle.jbo.NavigatableRowIterator

addListener, removeListener

Methods inherited from interface oracle.jbo.RowIterator

createAndInitRow, createKey, createRow, enumerateRowsInRange, findByEntity, findByKey, first, getAllRowsInRange, getCurrentRow, getCurrentRowIndex, getCurrentRowSlot, getFetchedRowCount, getRangeIndexOf, getRow, getRowAtRangeIndex, getRowCount, getRowCountInRange, hasNext, hasPrevious, insertRow, insertRowAtRangeIndex, isRangeAtBottom, isRangeAtTop, last, next, previous, removeCurrentRow, reset, setCurrentRow, setCurrentRowAtRangeIndex

Method Detail

getParent

public WSObject getParent()

Overrides:

getParent in class WSObject

getRowSetIteratorImpl

public RowSetIterator getRowSetIteratorImpl()

getImplObject

public java.lang.Object getImplObject()

Overrides:

getImplObject in class WSObject

setImplObject

public void setImplObject(java.lang.Object o)

Overrides:

setImplObject in class WSObject

getRowSet

public RowSet getRowSet()

Description copied from interface: RowSetIterator

Gets the Row Set that this Iterator belongs to.

Specified by:

getRowSet in interface RowSetIterator

Overrides:

getRowSet in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowSetIterator

Returns:

the owning Row Set.

getDetailRowSets

public RowSet[] getDetailRowSets()

Description copied from interface: RowSetIterator

Gets an array of detail Row Sets for which this Iterator is the master.

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.

Specified by:

getDetailRowSets in interface RowSetIterator

Overrides:

getDetailRowSets in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowSetIterator

Returns:

an array of detail RowSet.

createDetailRowSet

public RowSet createDetailRowSet(java.lang.String rsName,
                                 java.lang.String linkDefName)

Description copied from interface: RowSetIterator

Creates a detail Row Set. See RowSetIterator.getDetailRowSets() for explanation of detail Row Sets.

This method creates a new detail Row Set for this Iterator.

Specified by:

createDetailRowSet in interface RowSetIterator

Overrides:

createDetailRowSet in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowSetIterator

Parameters:

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).

Returns:

the new detail Row Set.

closeRowSetIterator

public void closeRowSetIterator()

Description copied from interface: RowSetIterator

Closes this row set iterator. If this row set iterator is a master in a master-detail relationship, 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.

Specified by:

closeRowSetIterator in interface RowSetIterator

Overrides:

closeRowSetIterator in class WSRowSetIteratorBase

getSyncLock

public java.lang.Object getSyncLock()

Description copied from interface: RowSetIterator

Gets the locking object for this Row Set Iterator. Actually, this method locks the Application Module to which this Row Set Iterator belongs. See ApplicationModule.getSyncLock() for details.

Specified by:

getSyncLock in interface RowSetIterator

Overrides:

getSyncLock in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowSetIterator

Returns:

the locking object.

setRangeSize

public int setRangeSize(int size)

Description copied from interface: RowIterator

Modifies the size of the row set range.

This method takes effect when the next set of data is fetched. For an example usage of setRangeSize, see setRangeStart.

Specified by:

setRangeSize in interface RowIterator

Overrides:

setRangeSize in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowIterator

Parameters:

size - the new number of rows in the row set range. Size of 0 is treated same as 1. Size < -1 is treated same as -1.

Returns:

the new size of the range.

See Also:

RowIterator.setRangeStart(int)

getRangeSize

public int getRangeSize()

Description copied from interface: RowIterator

Gets the size of the row set range.

Specified by:

getRangeSize in interface RowIterator

Overrides:

getRangeSize in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowIterator

Returns:

the number of rows in the range.

getRangeStart

public int getRangeStart()

Description copied from interface: RowIterator

Gets the absolute index of the first row in the row set range.

The absolute index is 0-based, and is the row's index relative to the entire result set.

Specified by:

getRangeStart in interface RowIterator

Overrides:

getRangeStart in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowIterator

Returns:

an index.

setRangeStart

public int setRangeStart(int start)

Description copied from interface: RowIterator

Moves the row set range.

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).

Specified by:

setRangeStart in interface RowIterator

Overrides:

setRangeStart in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowIterator

Parameters:

start - the absolute index of the new first row in the row set range.

scrollRange

public int scrollRange(int amount)

Description copied from interface: RowIterator

Moves the row set range up or down a given number of rows.

Specified by:

scrollRange in interface RowIterator

Overrides:

scrollRange in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowIterator

Parameters:

amount - the number of rows to scroll. A negative value scrolls upward.

Returns:

the number of rows actually scrolled.

scrollRangeTo

public int scrollRangeTo(Row row,
                         int index)

Description copied from interface: RowIterator

Scrolls the range to place a given row at a given row set index.

Specified by:

scrollRangeTo in interface RowIterator

Overrides:

scrollRangeTo in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowIterator

Parameters:

row - the row.

index - the row's new index.

Returns:

the actual number of rows scrolled. A negative number indicates that the scroll was scrolled upward.

setRowValidation

public void setRowValidation(boolean flag)

Description copied from interface: RowIterator

Sets the validation flag on this iterator. By default a RowIterator validates the current row when navigating to another row. This method can be used to turn this row-validation off by passing 'false' as parameter.

Specified by:

setRowValidation in interface RowIterator

Overrides:

setRowValidation in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowIterator

Parameters:

flag - Whether to turn row validation off or not.

Throws:

InvalidOperException - is thrown if this iterator is the default iterator of a ViewObject or a RowSet.

getIterMode

public int getIterMode()

Description copied from interface: RowIterator

Gets the current iteration mode. See Iteration Modes above for details on iteration mode which controls how the range behaves when it reaches the end of the Row Set.

Specified by:

getIterMode in interface RowIterator

Overrides:

getIterMode in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowIterator

Returns:

ITER_MODE_LAST_PAGE_PARTIAL if the iteration mode is "partial-last-page", ITER_MODE_LAST_PAGE_FULL if it is "full-last-page".

setIterMode

public void setIterMode(int mode)

Description copied from interface: RowIterator

Sets the iteration mode for this Row Iterator. See Iteration Modes above for details on iteration mode which controls how the range behaves when it reaches the end of the Row Set.

Specified by:

setIterMode in interface RowIterator

Overrides:

setIterMode in class WSRowSetIteratorBase

Following copied from interface: oracle.jbo.RowIterator

Parameters:

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".