public abstract class WSRowSetIteratorBase extends WSAMComponent implements RowSetIterator, java.io.Serializable
| Modifier and Type | Field and Description |
|---|---|
protected java.util.ArrayList |
mListeners |
protected java.util.ArrayList |
mMgmtListeners |
protected java.lang.String |
mName |
mVariableOpersMAP_NULL_VALUEITER_MODE_LAST_PAGE_FULL, ITER_MODE_LAST_PAGE_PARTIAL, SLOT_BEFORE_FIRST, SLOT_BEYOND_LAST, SLOT_DELETED, SLOT_VALID| Modifier and Type | Method and Description |
|---|---|
void |
addListener(java.lang.Object listener)
Adds a subscriber (listener) to be notified of
RowSetListener
events generated by this row set iterator. |
void |
addManagementListener(RowSetManagementListener listener)
Adds a subscriber (listener) to be notified of
RowSetManagementListener
events generated by this Row Set Iterator. |
abstract void |
closeRowSetIterator()
Closes this row set iterator.
|
Row |
createAndInitRow(AttributeList nvp)
Creates and initializes a new Row object, but does not insert it into
the Row Set.
|
abstract RowSet |
createDetailRowSet(java.lang.String rsName,
java.lang.String linkDefName)
Creates a detail Row Set.
|
Key |
createKey(AttributeList nvp)
Given a list of name-value pairs, creates a Key object that
matches the key structure for the ViewObject for this RowItertor.
|
Row |
createRow()
Creates a new Row object, but does not insert it into the Row Set.
|
java.util.Enumeration |
enumerateRowsInRange()
Gets an
Enumeration of all rows in the Row Set. |
void |
findAndSetCurrentRowByKey(Key key,
int rangeIndex) |
RowIterator |
findByAltKey(java.lang.String keyName,
Key key,
int maxNumOfRows,
boolean skipWhere)
Same as
|
Row[] |
findByEntity(int eRowHandle,
int maxNumOfRows)
Finds and returns View rows that use the Entity row, identified by
the Entity row handle,
eRowHandle. |
Row[] |
findByKey(Key key,
int maxNumOfRows)
Finds and returns View rows that match the specified key.
|
RowIterator |
findByViewCriteria(ViewCriteria vc,
int maxNumOfRows,
int queryMode)
Finds and returns View rows that match the specified View Criteria.
|
Row |
first()
Gets the first row in the iterator.
|
Row[] |
getAllRowsInRange()
Extracts the rows in the range.
|
Row |
getCurrentRow()
Accesses the current row.
|
int |
getCurrentRowIndex()
Gets the absolute index (not range index) of the current row.
|
int |
getCurrentRowSlot()
Gets the slot status of the current row.
|
abstract RowSet[] |
getDetailRowSets()
Gets an array of detail Row Sets for which this Iterator is the master.
|
int |
getEstimatedRangePageCount()
Returns getEstimatedRowCount()/rangePageSize, if rangeSize > 0.
|
int |
getFetchedRowCount()
Counts the number of rows fetched from database into the Row Set collection
up to this point.
|
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. |
abstract int |
getIterMode()
Gets the current iteration mode.
|
java.lang.String |
getName()
Returns the name of this Variable Manager Owner.
|
Row[] |
getNextRangeSet()
Gets the next set of rows in the range.
|
Row[] |
getPreviousRangeSet()
Gets the previous set of rows in the range.
|
int |
getRangeIndexOf(Row row)
Get the index of the given row relative to the beginning of the range.
|
abstract int |
getRangeSize()
Gets the size of the Row Set Iterator range.
|
abstract int |
getRangeStart()
Gets the absolute row index of the first row in the Row Set Iterator range.
|
Row |
getRow(Key key)
Returns the first row whose key matches
key. |
Row |
getRowAtRangeIndex(int index)
Accesses a row through its range index.
|
int |
getRowCount()
Counts the total number of rows in the Row Set.
|
int |
getRowCountInRange()
Gets the size of the Row Set Iterator range.
|
abstract RowSet |
getRowSet()
Gets the Row Set that this Iterator belongs to.
|
abstract java.lang.Object |
getSyncLock()
Gets the locking object for this Row Set Iterator.
|
boolean |
hasNext()
Tests for the existence of a row after the current row.
|
boolean |
hasPrevious()
Tests for the existence of a row before the current row.
|
void |
insertRow(Row row)
Inserts a row to the Row Set, before the current row.
|
void |
insertRowAtRangeIndex(int index,
Row row)
Inserts a row to the Row Set at the given range index.
|
boolean |
isConnected() |
boolean |
isNameGenerated()
Tests if the Iterator's name was generated by the system.
|
boolean |
isRangeAtBottom()
Tests if the Row Set Iterator range is at the end of the result set.
|
boolean |
isRangeAtTop()
Tests if the Row Set Iterator range is at the beginning of the result set.
|
abstract boolean |
isRowValidation()
Gets the validation flag on this iterator.
|
Row |
last()
Gets the last row in the iterator.
|
Row |
next()
Gets the next row in the iterator.
|
Row |
previous()
Gets the previous row in the iterator.
|
protected void |
registerWSListeners() |
void |
removeCurrentRow()
Removes the current Row object from the Row Set.
|
Row |
removeCurrentRowAndRetain()
Removes the current Row object from the collection and retain it for
insertion into another location.
|
void |
removeCurrentRowFromCollection()
Removes the current Row object from the collection.
|
void |
removeListener(java.lang.Object listener)
Removes a subscriber (listener) for
RowSetListener
events generated by this row set iterator. |
void |
removeManagementListener(RowSetManagementListener listener)
Removes a subscriber (listener) for
RowSetManagementListener
events generated by this row set iterator. |
void |
reset()
Moves the currency to the slot before the first row.
|
abstract int |
scrollRange(int amount)
Moves the Row Set Iterator range up or down a given number of rows.
|
abstract int |
scrollRangeTo(Row row,
int index)
Scrolls the range to place a given row at a given range index.
|
int |
scrollToRangePage(int pageIndex)
Moves the row set range start to the given page index
where every page consists of RangeSize number of rows.
|
boolean |
setCurrentRow(Row row)
Designates a given row as the current row.
|
boolean |
setCurrentRowAtRangeIndex(int index)
Designates a given index as the current row.
|
abstract void |
setIterMode(int mode)
Sets the iteration mode for this Row Iterator.
|
abstract int |
setRangeSize(int size)
Modifies the size of the Row Set Iterator range.
|
abstract int |
setRangeStart(int start)
Moves the Row Set Iterator range.
|
abstract void |
setRowValidation(boolean flag)
Sets the validation flag on this iterator.
|
getMessageBundleClass, getResourceBundleDefcloseObject, ensureVariableManager, get, getFullName, getId, getImageLoc, getImplObject, getParent, getVariableManager, hasVariables, isReadOnly, markForError, setImplObject, setNameentrySet, equals, hashCode, internalGet, internalPut, put, setThrowIfPropertyNotFoundOnGetclear, clone, containsKey, containsValue, isEmpty, keySet, putAll, remove, size, toString, valuesfinalize, getClass, notify, notifyAll, wait, wait, waitensureVariableManager, getMessageBundleClass, getResourceBundleDef, getVariableManager, hasVariablesprotected java.lang.String mName
protected transient java.util.ArrayList mListeners
protected transient java.util.ArrayList mMgmtListeners
public final boolean isConnected()
protected void registerWSListeners()
public final java.lang.String getName()
VariableManagerOwnergetName in interface RowSetIteratorgetName in interface VariableManagerOwnergetName in class WSObjectpublic final boolean isNameGenerated()
RowSetIteratorisNameGenerated in interface RowSetIteratortrue if the name was generated by the system.
false if the name was given by the user and
not generated by the system.public final Row[] getNextRangeSet()
RowSetIteratorgetNextRangeSet() 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 ScrollEventRowSetListener.rangeScrolled(oracle.jbo.ScrollEvent)RowSetListenerNavigatableRowIterator.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
NavigationEventRowSetListener.navigated(oracle.jbo.NavigationEvent)
getNextRangeSet in interface RowSetIteratorpublic final Row[] getPreviousRangeSet()
RowSetIteratorgetPreviousRangeSet() 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 ScrollEventRowSetListener.rangeScrolled(oracle.jbo.ScrollEvent)RowSetListenerNavigatableRowIterator.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
NavigationEventRowSetListener.navigated(oracle.jbo.NavigationEvent)
getPreviousRangeSet in interface RowSetIteratorpublic int getEstimatedRangePageCount()
RowSetIteratorThis number may fluxuate when the View Object is syncronized with its Entity Object.
getEstimatedRangePageCount in interface RowSetIteratorpublic int scrollToRangePage(int pageIndex)
RowSetIterator(rangeSize * (pageSize-1)) - getRangeStart();
scrollToRangePage in interface RowSetIteratorpageIndex - the page number to go to in the result set.public abstract RowSet getRowSet()
RowSetIteratorgetRowSet in interface RowSetIteratorpublic abstract RowSet[] getDetailRowSets()
RowSetIteratorIn 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 RowSetIteratorRowSet.public abstract RowSet createDetailRowSet(java.lang.String rsName, java.lang.String linkDefName)
RowSetIteratorRowSetIterator.getDetailRowSets()This method creates a new detail Row Set for this Iterator.
createDetailRowSet in interface RowSetIteratorrsName - 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 final void addManagementListener(RowSetManagementListener listener)
RowSetIteratorRowSetManagementListener
events generated by this Row Set Iterator.
addManagementListener in interface RowSetIteratorlistener - the subscriber to be added. It should implement
RowSetManagementListener.public final void removeManagementListener(RowSetManagementListener listener)
RowSetIteratorRowSetManagementListener
events generated by this row set iterator.
removeManagementListener in interface RowSetIteratorlistener - the subscriber to be removed.public abstract void closeRowSetIterator()
RowSetIteratorcloseRowSetIterator
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 RowSetIteratorpublic abstract java.lang.Object getSyncLock()
RowSetIteratorApplicationModule.getSyncLock()
for details.getSyncLock in interface RowSetIteratorpublic final void addListener(java.lang.Object listener)
NavigatableRowIteratorRowSetListener
events generated by this row set iterator.addListener in interface NavigatableRowIteratorlistener - the subscriber to be added. It should implement
RowSetListener.public final void removeListener(java.lang.Object listener)
NavigatableRowIteratorRowSetListener
events generated by this row set iterator.removeListener in interface NavigatableRowIteratorlistener - the subscriber to be removed.public final Row next()
RowIteratornext() is called on an iterator whose Row Set has
not yet been RowSet.executeQuery()executeQuery() himself before calling next().
We refer to this as implicit query execution or
implicit Row Set execution.
Before moving to the next row, next() validates the current row
(if the iterator has a current row) through a call to Row.validate()
If the currency is on the last row of the range and next() is
called, the range is scolled down by one row to bring the next row into
the visible range. In particular, if the range size is 1, next()
scrolls the range down by 1 row.
When this method is called, the current row of the iterator
may be outside the range. (Note that the current row does not
have to be within the range.) If so, next() will
scroll the range, so that the row that will be the current row
at the conclusion of this method will be positioned in the middle
of the range.
If the iterator is just opened or reset (see RowIterator.reset()next() will return the first row if one exists.
In this situation, next() is functionally equivalent
to RowIterator.first()
If the iterator is at the last row of the Row Set, next()
push the currency into the imaginary slot after the last row.
This will set the current slot status to SLOT_BEYOND_LAST.
When the next row is required, a check is made to see if the row
has already been brought into the collection. If not, the row is fetched from
database. Note that the View Object's fetch mode affects how rows
are fetched from database into the collection. See
ViewObjectImpl.getFetchMode()
If successful, this method designates the next row as the current row (the currency finally moves).
This method generates events to notify the changes to the iterator.
If scrolling occurs because of conditions described above, a
ScrollEventRowSetListener.rangeScrolled(oracle.jbo.ScrollEvent)RowSetListenerNavigatableRowIterator.addListener(Object)addListener).
If the currency is changed, it generates a
NavigationEventRowSetListener.navigated(oracle.jbo.NavigationEvent)
next in interface RowIteratorRownull
if there is no next row.public final Row previous()
RowIteratorprevious() is called on an iterator whose Row Set has
not yet been RowSet.executeQuery()executeQuery() himself before calling previous().
We refer to this as implicit query execution or
implicit Row Set execution.
Before moving to the previous row, previous() validates the current row
(if the iterator has a current row) through a call to Row.validate()
If the currency is on the first row of the range and previous() is
called, the range is scolled up by one row to bring the previous row into
the visible range. In particular, if the range size is 1, previous()
scrolls the range up by 1 row.
When this method is called, the current row of the iterator
may be outside the range. (Note that the current row does not
have to be within the range.) If so, previous() will
scroll the range, so that the row that will be the current row
at the conclusion of this method will be positioned in the middle
of the range.
If the iterator is just opened or reset (see RowIterator.reset()previous() will null as the currency is
already on the imaginary slot before the first row.
If the iterator is at the first row of the Row Set, previous()
push the currency into the imaginary slot before the first row.
This will set the current slot status to SLOT_BEFORE_FIRST.
If successful, this method designates the previous row as the current row (the currency finally moves).
This method generates events to notify the changes to the iterator.
If scrolling occurs because of conditions described above, a
ScrollEventRowSetListener.rangeScrolled(oracle.jbo.ScrollEvent)RowSetListenerNavigatableRowIterator.addListener(Object)addListener).
If the currency is changed, it generates a
NavigationEventRowSetListener.navigated(oracle.jbo.NavigationEvent)
previous in interface RowIteratorRownull
if there is no previous row.public final Row first()
RowIteratorfirst() is called on an iterator whose Row Set has
not yet been RowSet.executeQuery()executeQuery() himself before calling first().
We refer to this as implicit query execution or
implicit Row Set execution.
This method checks to see if the currency is not on the first row.
If not, it resets the currency to the imaginary slot before the
first row and then calls RowIterator.next()
If the currency is on the slot before the first row, it
simply calls next(). In this case, first()
is equivalent to next().
If the currency is already on the first row, nothing happens.
If first() is called on an empty Row Set (a Row Set that
has no row), the currency is set to the slot after the last row, and
null is returned.
This method generates events to notify the changes to the iterator,
e.g., ScrollEventNavigationEventRowIterator.next()
first in interface RowIteratorRownull
if there is no first row. In that case (null return),
the current slot status will be RowIterator.SLOT_BEYOND_LASTpublic final Row last()
RowIteratorlast() is called on an iterator whose Row Set has
not yet been RowSet.executeQuery()executeQuery() himself before calling last().
We refer to this as implicit query execution or
implicit Row Set execution.
Before moving to the last row, last() validates the current row
(if the iterator has a current row) through a call to Row.validate()
This method retrieves all rows from the Row Set and scrolls (if necessary)
to the last row. If some of these rows have not yet been fetched
from database, it fetches them. The View Object's fetch mode affects how rows
are fetched from database into the collection. See
ViewObjectImpl.getFetchMode()
If successful, this method designates the last row as the current row.
If last() is called on an empty Row Set, the currency moves
to the slot beyond the last row. The current slot status is set to
RowIterator.SLOT_BEYOND_LAST
The caller of this method should be aware that it may take a long time to complete as all rows from the Row Set are fetched.
The number of rows in the range at the completion of this method is affected by the "iteration mode". See Iteration Modes above for details.
This method generates events to notify the changes to the iterator.
If scrolling occurs because of conditions described above, a
ScrollEventRowSetListener.rangeScrolled(oracle.jbo.ScrollEvent)RowSetListenerNavigatableRowIterator.addListener(Object)addListener).
If the currency is changed, it generates a
NavigationEventRowSetListener.navigated(oracle.jbo.NavigationEvent)
last in interface RowIteratorRownull
if there is no last row.public final void reset()
RowIterator
After this method, the current slot status will be RowIterator.SLOT_BEFORE_FIRSTRowIterator.next()
It sends a ScrollEventRowSetListener.rangeScrolled(oracle.jbo.ScrollEvent)RowSetListenerNavigatableRowIterator.addListener(Object)addListener).
reset in interface RowIteratorpublic final boolean hasNext()
RowIteratorhasNext in interface RowIteratortrue if there is a next row.
Specifically, if the Row Set is empty or if the currency
is on the last row or the slot after the last row
(current slot status == RowIterator.SLOT_BEYOND_LASTfalse. Otherwise, true.public final boolean hasPrevious()
RowIterator
If the Row Set is forward-only, it returns false.
hasPrevious in interface RowIteratortrue if there is a previous row.
Specifically, if the Row Set is empty or forward-only or
if the currency is on the first row or the slot before the first row
(current slot status == RowIterator.SLOT_BEFORE_FIRSTfalse. Otherwise, true.public final int getFetchedRowCount()
RowIteratorgetFetchedRowCount in interface RowIteratorpublic final int getRowCount()
RowIteratorNote that this method retrieves all rows from the database then returns the number of rows in the Row Set collection.
getRowCount in interface RowIteratorpublic final Row getRow(Key key)
RowIteratorkey.
If the key being passed in has the row handle, it uses the row handle
to locate the row. This is a quick operation. (A key returned from
a call to Row.getKey()
If the key does not have a row handle, or if the handle look up did not find the row in the View row cache, it performs a linear search through the Row Set collection looking for a match. Hence, this method could take quite a long time to complete.
This method is similar to RowIterator.findByKey(Key, int)
However, findByKey() may find the matching Row(s) out of sequence. When a row is not found in the View row cache, findByKey() issues a database query. Matching rows are retrieved and appended to the Row Set collection. For example, suppose the Row Set collection has 200 rows that qualify in the database. Suppose the user retrieved only 10 rows (190 not yet retrieved). Suppose, at this time, the user issues findByKey() that locates the 200-th row (the last row in database result set). That row is appended to the Row Set collection at the 11-th spot. Thus, when you use findByKey(), you may see rows out of sequence. In contrast, getRow() always retrieves rows in sequence.
If the Row Set collection is of any non-trivial size (say over 50), we would recommend findByKey().
findByKey() allows for partial key (only for View Objects that have multiple Entity bases). When a partial key is specified, multiple rows may return. getKey() returns one and only one row (exact match).
getRow in interface RowIteratorkey - the key.public final Row getRowAtRangeIndex(int index)
RowIteratorgetRowAtRangeIndex in interface RowIteratorindex - an index in the range: 0 to getRangeSize() - 1.null if the index is out of range.public final Row getCurrentRow()
RowIteratorgetCurrentRow in interface RowIteratorpublic final int getCurrentRowIndex()
RowIteratorgetCurrentRowIndex in interface RowIteratorpublic final int getCurrentRowSlot()
RowIteratorgetCurrentRowSlot in interface RowIteratorSLOT_.public final boolean setCurrentRow(Row row)
RowIteratorsetCurrentRow in interface RowIteratorrow - the new current row.true if the operation succeeded.public final Row createAndInitRow(AttributeList nvp)
RowIteratorcreateRow() mainly
in that this method allows the user to pass in a list of name-value
pairs with which row attributes are initialized.
nvp is a named value pair. When building an nvp from
scratch, use NameValuePairs to build a new nvp.
Here is an example:
NameValuePairs nvp = new NameValuePairs();
nvp.setAttribute("EmpTyp", "C");
Row row = voEmp.createAndInitRow(nvp);
This method is particularly useful when creating a subclass
View Row or Entity Row. You can include polymorphic discriminator
attribute values in nvp and correct subclass row
object will be created.
When this method is called, underlying entities are created.
After the new entities are created, a new view row is created.
After that ViewRowImpl.create(oracle.jbo.AttributeList)
is called with this nvp. ViewRowImpl.create(AttributeList)
walks thru the list of entities and calls
EntityImpl.create(AttributeList) with the same
nvp for each entity in the view row.
createAndInitRow in interface RowIteratornvp - a list of name-value pairs.public final Row createRow()
RowIteratorcreateRow in interface RowIteratorpublic final void insertRow(Row row)
RowIteratorinsertRow in interface RowIteratorrow - the Row object to be added.public final void removeCurrentRow()
RowIteratorremoveCurrentRow in interface RowIteratorpublic final void removeCurrentRowFromCollection()
RowIterator
It does not cause the row to be deleted from the database table.
It just removes the row from the row collection. However, once the
row is removed, it cannot be used any more. If you want to
remove the current row from collection and insert it elsewhere,
call RowIterator.removeCurrentRowAndRetain()RowIterator.insertRow(oracle.jbo.Row)
removeCurrentRowFromCollection in interface RowIteratorpublic final Row removeCurrentRowAndRetain()
RowIteratorIt does not cause the row to be deleted from the database table. It just removes the row from the row collection.
This method differs from RowIterator.removeCurrentRowFromCollection()
To do so, call RowIterator.removeCurrentRowAndRetain()RowIterator.insertRow(oracle.jbo.Row)
removeCurrentRowAndRetain in interface RowIteratorpublic abstract int setRangeSize(int size)
RowIteratorThis method takes effect when the next set of data is fetched. For an example usage of setRangeSize, see setRangeStart.
setRangeSize in interface RowIteratorsize - 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 abstract int getRangeSize()
RowIteratorgetRangeSize in interface RowIteratorpublic abstract int getRangeStart()
RowIteratorThe absolute index is 0-based, and is the row's index relative to the entire result set.
getRangeStart in interface RowIteratorpublic abstract int setRangeStart(int start)
RowIteratorNote 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 RowIteratorstart - the absolute index of the new first row in the Row Set Iterator range.public abstract int scrollRange(int amount)
RowIteratorscrollRange in interface RowIteratoramount - the number of rows to scroll.
A negative value scrolls upward.public abstract int scrollRangeTo(Row row, int index)
RowIteratorscrollRangeTo in interface RowIteratorrow - the row.index - the range index at which the row is to be found.public final boolean setCurrentRowAtRangeIndex(int index)
RowIteratorsetCurrentRowAtRangeIndex in interface RowIteratorindex - the index of the new current row.true if the operation succeeded.public final void insertRowAtRangeIndex(int index,
Row row)
RowIteratorindex is
relative to the range, i.e., index of 0 would mean to insert
before the first row of the range. Allowed values for index
is 0 to range size. If index equals range size, the row
is inserted right after the last row in the range. This method call does not
alter the current position of the iterator, nor does it affect the range
position.
insertRowAtRangeIndex in interface RowIteratorindex - the point where row is to be added.row - the Row object to be added.public final int getRangeIndexOf(Row row)
RowIteratorgetRangeIndexOf in interface RowIteratorrow - a Row object.
or -1 if the row is not in range.row,public final int getRowCountInRange()
RowIteratorgetRowCountInRange in interface RowIteratorpublic final boolean isRangeAtBottom()
RowIteratorisRangeAtBottom in interface RowIteratortrue if the last row of the range is
the last row of the result set.public final boolean isRangeAtTop()
RowIteratorisRangeAtTop in interface RowIteratortrue if the first row of the range is
the first row of the result set.public final java.util.Enumeration enumerateRowsInRange()
RowIteratorEnumeration of all rows in the Row Set.
enumerateRowsInRange in interface RowIteratorEnumeration interface.public final Row[] getAllRowsInRange()
RowIteratorgetAllRowsInRange in interface RowIteratorsetViewSize().public final Row[] getFilteredRows(java.lang.String attrName, java.lang.Object attrValue)
RowSetIteratorattrValue.
Note that this method does not affect the current RowSetIterator.
getFilteredRows in interface RowSetIteratorattrName - name of the attribute to be used for filtering.attrValue - attribute value for filtering.public final Row[] getFilteredRowsInRange(java.lang.String attrName, java.lang.Object attrValue)
RowSetIteratorattrValue.
This method uses getAllRowsInRange() to retrieve
all rows and then match the rows.
getFilteredRowsInRange in interface RowSetIteratorattrName - name of the attribute to be used for filtering.attrValue - attribute value for filtering.public final Row[] findByKey(Key key, int maxNumOfRows)
RowIteratorIf this View Object has multiple Entity Object bases, the key need not be specified for all. However, if a key is specified for n-th Entity Object, and if this Entity Object's primary key consists of multiple parts, all parts of the key must be specified.
If not all Entity keys are included, multiple rows may
match the partial key. The maxNumOfRows parameter
is used to specify the maximum number of rows to return.
For example, suppose the View Object has Emp and DeptLocation as its Entity Object bases. Suppose further that Emp has a one part primary key (employee number) and DeptLocation has a two part primary key (dept name and location).
The user can make the following call to look for all employees working in ACCOUNTING's NEW YORK office:
// The key will consist of 3 parts. The first part is
// for the employee number (which is null, meaning not
// specified). The second part is the department name.
// The third is the location.
Object [] keyValues = new Object[3];
keyValues[0] = null; // All employees
keyValues[1] = "ACCOUNTING";
keyValues[4] = "NEW YORK"; // third Entity Object, key part 1
Row[] rows = myAM.findByKey(new Key(keyValues), -1);
In this example, if you were to include the key for DeptLocation, you must specify both key parts.
Note that the position of the key must patch the order of the Entity Object bases and their keys. In the above example, keyValues[0] is always the employee number. You cannot specify the employee number in keyValues[1] or keyValues[2].
This method works even on a View Object which has no Entity Object
base. For this to work, however, the ViewObject's key
attribute list must have been set up through a call to
ViewObjectImpl.setKeyAttributeDefs(int[])
Then, the following code block will retrieve all rows whose attribute 0 is "PERM" and attribute 2 is 30.
// First set up the key attributes
myVO.setKeyAttributeDefs(new int[] { 0, 2 });
// The key will consist of 2 parts. The first part is
// for attribtue 0 and the second is for attribute 2.
Object [] keyValues = new Object[2];
keyValues[0] = "PERM";
keyValues[1] = new Integer(30);
Row[] rows = myAM.findByKey(new Key(keyValues), -1);
Internally, findByKey() works as follows for
a View Object with Entity Object bases: It takes the first
non-null entity key from key.
It uses it to find the Entity row in the cache. If it
finds it, then it looks at all View rows in the Row Set collection
that uses that Entity row and apply the remaining keys to qualify them.
It may or may not find as many rows as requested.
If the requested number of rows have been found, the array
returns. Otherwise, a check is made to see if the View Object's
fetch size is unlimited (which is -1, see
ViewObject.setMaxFetchSize(int)
Otherwise (the requested number of rows not yet found and
the Row Set has not yet fetched all rows or the fetch size
is not -1), the search continues. We now use the key
build a where-clause for an internal View Object. That
where-clause is applied and qualifying rows are retrieved from
it to find the requested number of rows.
For a View Object which has no Entity Object base, we simply skip the step of looking in the Entity Object cache. Other than that, the logic is applied.
As new rows are retrieved from database they are added to the
Row Set collection. Thus, the user can work with these rows immediately,
e.g., call RowIterator.setCurrentRow(Row)
This method does not fire any navigation event, nor does it move the range or the current row. Also, as rows are added to the Row Set collection, no insertion event fires (as this is analogous to fetching rows).
See RowIterator.getRow(Key)getRow(Key).
findByKey in interface RowIteratorkey - the key to match.maxNumOfRows - the maximum size of the array to return,
or -1 to return all rows.public final RowIterator findByAltKey(java.lang.String keyName, Key key, int maxNumOfRows, boolean skipWhere)
RowIteratorRowIterator.findByKey(Key, int)keyName parameter.
A skipWhere parameter controls
whether or notthe current view object's where-clause is included
in the db query if a db query is issued to get the row(s).
It returns a RowIterator and not a row array. You
can enumerate through rows of this row iterator.
findByAltKey in interface RowIteratorkeyName - the name of the alternate key. If null
the primary key is specified, i.e., this function call
becomes equivalent to findByKey with
skipWhere = false.key - the alternate key to match.maxNumOfRows - the maximum size of the array to return,
or -1 to return all rows.skipWhere - A flag that controls whether, when a db query is issued
to get the matching row(s), the view object's current
where-clause is to be included in the query or not.public final RowIterator findByViewCriteria(ViewCriteria vc, int maxNumOfRows, int queryMode)
RowIteratorViewCriteria
The queryMode parameter controls the manner in which
the qualifying View rows are searched. See the QUERY_MODE_...
constants in ViewObject
If QUERY_MODE_SCAN_VIEW_ROWS is specified,
the existing View rows in the current Row Set are scanned for
matching rows.
If QUERY_MODE_SCAN_ENTITY_ROWS is specified,
the Entity cache is searched for qualifying rows. If qualifying
rows are found, they are added to the current Row Set. I.e.,
they become part of the current row collection. Internally,
a finder View Object is created to search the Entity cache and
to produce View rows from the Entity cache.
If QUERY_MODE_SCAN_DATABASE_TABLES is specified,
a database query is issued to find matching rows. The View
Criteria is converted into a where-clause.
ViewObject.applyViewCriteria(ViewCriteria)
Upon completion of this operation, the finder View Object is closed and removed.
findByViewCriteria in interface RowIteratorvc - the View Criteria to be used to qualify View rows.maxNumOfRows - the maximum size of the array to return,
or -1 to return all rows. If a value
other than -1 is specified and if the
specified number of rows is reached, the method
returns without performing any further operation.queryMode - the mode in which qualify View rows are scanned.
See above for further info.public final Key createKey(AttributeList nvp)
RowIteratorcreateKey in interface RowIteratorpublic final Row[] findByEntity(int eRowHandle, int maxNumOfRows)
RowIteratoreRowHandle.
findByEntity in interface RowIteratoreRowHandle - the Entity row handle.maxNumOfRows - the maximum size of the row array to return,
or -1 to return all rows.public abstract boolean isRowValidation()
RowIteratorisRowValidation in interface RowIteratorpublic abstract void setRowValidation(boolean flag)
RowIteratorsetRowValidation in interface RowIteratorflag - Whether to turn row validation off or not.public abstract int getIterMode()
RowIteratorgetIterMode in interface RowIteratorpublic abstract void setIterMode(int mode)
RowIteratorsetIterMode in interface RowIteratormode - 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".public final void findAndSetCurrentRowByKey(Key key, int rangeIndex)