oracle.jbo.common.ws
Class WSRowSetImpl

java.lang.Object
  java.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.WSRowSetImpl

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, java.util.Map, WSRowSet, NavigatableRowIterator, Properties, RowIterator, RowNavigationListener, RowSet, RowSetIterator, RowSetListener, VariableManagerOwner, VariableManagerOwnerBase, XMLInterface

public class WSRowSetImpl
extends WSRowSetIteratorBase
implements WSRowSet, java.io.Serializable, RowSetListener

See Also:

Serialized Form

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

COPY_OPT_ALL_ROWS, COPY_OPT_LIMIT_RANGE, FORWARD_ONLY, RANGE_PAGING, RANGE_PAGING_AUTO_POST, RANGE_PAGING_INCR, SCROLLABLE

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

Fields inherited from interface oracle.jbo.XMLInterface

XML_IGNORE_DEPTH_COUNT, XML_OPT_ALL_ROWS, XML_OPT_ASSOC_CONSISTENT, XML_OPT_CHANGES_ONLY, XML_OPT_LIMIT_RANGE, XML_PASSIVATION_USE

Method Summary

boolean	cancelQuery() Cancels a running query.
void	closeRowSet() Closes the row set.
void	closeRowSetIterator() Closes this row set iterator.
RowSet	createDetailRowSet(java.lang.String rsName, java.lang.String linkDefName) Creates a detail Row Set.
RowSetIterator	createRowSetIterator(java.lang.String name) Creates an iterator for the row set.
RowSet	deepCopy(java.util.HashMap voAttrMap, long options) This method performs a copy of view rows and the Entity row references of the view rows that belong to this RowSet.
void	defineNamedWhereClauseParam(java.lang.String name, java.lang.Object defaultValue, int[] indices) Defines a named bind variable to use with the view object's where-clause.
void	executeEmptyRowSet()
void	executeQuery() Executes the query.
void	executeQuery2(boolean resetCurrency, boolean force, boolean emptyRowSet)
RowSetIterator	findOrCreateRowSetIterator(java.lang.String name)
RowSetIterator	findRowSetIterator(java.lang.String name) Gets the named row set iterator that was created at runtime for this row set.
WSRowSetIteratorImpl	findWSRowSetIterator(java.lang.String name)
byte	getAccessMode()
AccTravDef	getAccessorTraversalDef()
ApplicationModule	getApplicationModule() Gets the row set's application module that contains this row set.
long	getCappedRowCount(long cap)
long	getDeferredEstimatedRowCount() If this ViewObject is marked to not perform the estimatedRowCount query, then return -1 until either the estimatedRowCount is called and the count is known or the RowSet is fetched completely in which case the actual row count is known.
RowSet[]	getDetailRowSets() Gets an array of detail Row Sets for which this Iterator is the master.
long	getEstimatedRowCount() Counts the number of rows in the collection defined by the view object's query.
java.lang.Object	getImplObject()
int	getIterMode() Gets the current iteration mode.
RowSetIterator[]	getMasterRowSetIterators() Return all controlling masters of this row set.
java.lang.Object	getNamedWhereClauseParam(java.lang.String name) Gets the value of a named where-clause parameter for this row set.
AttributeList	getNamedWhereClauseParams() Gets all the Name, value pairs of a named where-clause parameter of the viewObject.
WSObject	getParent()
java.util.Hashtable	getProperties() Gets the table of properties.
java.lang.Object	getProperty(java.lang.String hintName) Retrieves the specified property, if it exists.
java.lang.Object	getProperty(java.lang.String hintName, LocaleContext locale)
int	getRangePagingCacheFactor()
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[]	getRowSetIterators() Gets all row set iterators that belong to this row set.
java.lang.Object	getSyncLock() Gets the locking object for this Row Set Iterator.
ViewObject	getViewObject() Gets the view object that owns this row set.
java.lang.Object[]	getWhereClauseParams() Gets the bind variable values to be used with the view object's where-clause.
boolean	hasAccessorTraversalDef()
boolean	isAssociationConsistent() Returns the flag indicating whether association-consistent mode is on or not.
boolean	isDefaultRowSet() Internal: Applications should not use this method.
boolean	isExecuted() Returns true if the current ViewObject's query has been executed for this row set.
boolean	isExecuteQuery()
boolean	isFetchComplete() Tests if the query result set has been fetched to the end.
boolean	isForwardOnly() Tests if the row set is constrained to sequential access.
boolean	isMaxFetchSizeExceeded() Tests if the query result has been fetched to the end and the end was reached due to hitting the maxFetchSize limit
boolean	isOnLine()
boolean	isRefreshDataModel()
boolean	isRowValidation() Gets the validation flag on this iterator.
void	markForError(java.lang.Exception ex, boolean hasImplObject)
void	markForExecuteQuery(boolean resetCurrency, boolean force, boolean emptyRowSet)
void	navigated(NavigationEvent event) Invoked when the current-row designation changes.
void	rangeRefreshed(RangeRefreshEvent event) Invoked when the range changes.
void	rangeScrolled(ScrollEvent event) Invoked when the range is scrolled.
void	readXML(Element elem, int depthCount)
void	readXML(Element elem, int depthCount, XSLStylesheet xslt)
void	refreshDataModel()
void	refreshDataModel2(boolean resetCurrency, boolean force)
java.lang.Object	refreshProperty(java.lang.String hintName) Retrieves the specified property, if it exists.
boolean	removeMasterRowSetIterator(RowSetIterator masterRSI) Removes a master row set iterator.
void	removeNamedWhereClauseParam(java.lang.String name) Removes a named where-clause parameter.
void	requestEstimatedRowCount()
void	resetExecuted() This methods invalidates all the iterators on this rowset and marks the rowset as not executed.
void	rowDeleted(DeleteEvent event) Invoked when a row has been deleted.
void	rowInserted(InsertEvent event) Invoked when a row has been inserted.
void	rowUpdated(UpdateEvent event) Invoked when an attribute of the row has been changed.
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	setAccessMode(byte mode) Constrains the row access based on the following settings:
void	setAccessorTraversalByNamePaths(java.lang.String[] namePaths)
void	setAccessorTraversalDef(AccTravDef accTravDef)
void	setAssociationConsistent(boolean isAssociationConsistent) Sets the association-consistent flag for this row set.
void	setForwardOnly(boolean isForwardOnly) Constrains the row set to sequential access.
void	setImplObject(java.lang.Object o)
void	setIterMode(int mode) Sets the iteration mode for this Row Iterator.
boolean	setMasterRowSetIterator(RowSetIterator masterRSI) Sets the master iterator.
void	setNamedWhereClauseParam(java.lang.String name, java.lang.Object value) Sets the value of a named where-clause parameter for this row set.
void	setNamedWhereClauseParams(AttributeList attrlist) Sets the value of a named where-clause parameters for the entire viewObject.
void	setRangePagingCacheFactor(int f)
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.
void	setWhereClauseParam(int index, java.lang.Object value) Specifies a single bind variable value to use with the view object's where-clause.
void	setWhereClauseParams(java.lang.Object[] values) Specifies the bind variable values to use with the view object's where-clause.
void	skipNamedWhereClauseParam(java.lang.String name) Skips the named where-clause parameter for this row set.
Node	writeXML(int depthCount, long options) Renders data in a canonical XML-format.
Node	writeXML(int depthCount, long options, XSLStylesheet xslt)
Node	writeXML(long options, java.util.HashMap voAttrMap) Renders data in a canonical XML-format.
Node	writeXML(long options, java.util.HashMap voAttrMap, XSLStylesheet xslt)

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

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

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

getName

Methods inherited from interface oracle.jbo.RowSetIterator

addManagementListener, getEstimatedRangePageCount, getFilteredRows, getFilteredRowsInRange, getNextRangeSet, getPreviousRangeSet, isNameGenerated, removeManagementListener, scrollToRangePage

Methods inherited from interface oracle.jbo.NavigatableRowIterator

addListener, removeListener

Methods inherited from interface oracle.jbo.RowIterator

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

Methods inherited from interface oracle.jbo.VariableManagerOwnerBase

ensureVariableManager, getMessageBundleClass, getResourceBundleDef, getVariableManager, hasVariables

Method Detail

isOnLine

public boolean isOnLine()

getParent

public WSObject getParent()

Specified by:

getParent in class WSObject

setAccessorTraversalByNamePaths

public void setAccessorTraversalByNamePaths(java.lang.String[] namePaths)

Specified by:

setAccessorTraversalByNamePaths in interface WSRowSet

getAccessorTraversalDef

public AccTravDef getAccessorTraversalDef()

Specified by:

getAccessorTraversalDef in interface WSRowSet

setAccessorTraversalDef

public void setAccessorTraversalDef(AccTravDef accTravDef)

Specified by:

setAccessorTraversalDef in interface WSRowSet

hasAccessorTraversalDef

public boolean hasAccessorTraversalDef()

Specified by:

hasAccessorTraversalDef in interface WSRowSet

getImplObject

public java.lang.Object getImplObject()

Specified by:

getImplObject in class WSObject

setImplObject

public void setImplObject(java.lang.Object o)

Specified by:

setImplObject in class WSObject

markForError

public void markForError(java.lang.Exception ex,
                         boolean hasImplObject)

Specified by:

markForError in class WSObject

isDefaultRowSet

public boolean isDefaultRowSet()

Internal: Applications should not use this method.

Specified by:

isDefaultRowSet in interface RowSet

Returns:

Indicates whether this row set is the default row set for the View Object.

setMasterRowSetIterator

public boolean setMasterRowSetIterator(RowSetIterator masterRSI)

Description copied from interface: RowSet

Sets the master iterator.

Specified by:

setMasterRowSetIterator in interface RowSet

Parameters:

masterRSI - the new master row set iterator for this row set.

Returns:

true if the operation succeeded.

getViewObject

public ViewObject getViewObject()

Description copied from interface: RowSet

Gets the view object that owns this row set.

If this row set is the result of calling a view link accessor, the returned view object is an internal view object. ViewObject.isInternal() indicates whether the view object is internal or not. Even if a view link is defined between the master and detail view object, and even if an instance of them are included in the application module's data model, calling the view link by default uses a separate view object instance from the one in the AM's data model. To access the view link accessor's ViewObject, use the following code snippet (assuming that the detail side is called "MyDetail"):

    RowSet detailRS = (RowSet) masterViewRow.getMyDetail();
    ViewObject detailVO = detailRS.getViewObject();
 

Specified by:

getViewObject in interface RowSet

Returns:

the parent view object.

setWhereClauseParams

public void setWhereClauseParams(java.lang.Object[] values)

Description copied from interface: RowSet

Specifies the bind variable values to use with the view object's where-clause.

Setting the where-clause bind values through this method does not automatically execute the query. You must call RowSet.executeQuery() to apply the new bind values.

Specified by:

setWhereClauseParams in interface RowSet

Parameters:

values - an array of bind values. If the view object is using the JDBC style bindings ("?" for bind variable), values[n] is bound to the bind variable that appears in the n-th order (0 based indexing). If the view object is using the Oracle style bindings (":1", ":2", etc. for bind variable), values[n] is bound to the bind variable :(n+1), i.e., values[0] is bound to :1, values[1] is bound to :2, etc.

setWhereClauseParam

public void setWhereClauseParam(int index,
                                java.lang.Object value)

Description copied from interface: RowSet

Specifies a single bind variable value to use with the view object's where-clause.

Setting the where-clause bind values through this method does not automatically execute the query. You must call RowSet.executeQuery() to apply the new bind values.

Specified by:

setWhereClauseParam in interface RowSet

Parameters:

index - the index identifying the bind variable. If the view object is using the JDBC style bindings ("?" for bind variable), value is bound to the bind variable that appears in the index-th order (0 based indexing). If the view object is using the Oracle style bindings (":1", ":2", etc. for bind variable), value is bound to the bind variable :(index+1). If index is 0, value is bound to :1. If index is 1, value is bound to :2.

value - the bind variable value.

defineNamedWhereClauseParam

public void defineNamedWhereClauseParam(java.lang.String name,
                                        java.lang.Object defaultValue,
                                        int[] indices)

Description copied from interface: RowSet

Defines a named bind variable to use with the view object's where-clause.

This named where-clause parameter will be defined as a variable on the view object. That is, if a named where-clause parameter is defined through one row set, all other row sets that belongs to the same parent view object will "see" that parameter.

Through the defaultValue, one can specify the default value for this where-clause parameter. If no default value is supplied, null will be used as the parameter value.

The indices parameter specifies where-clause parameter indices into which this named parameter will be bound. The same value can be bound into multiple indices. For example, if { 1, 2 } is specified for indices, the value will be bound for where-clause parameter indices of 1 and 2. I.e., this parameter will produce setWhereClauseParam(1, value) and setWhereClauseParam(2, value).

This method can be invoked to redefine an existing named where-clause paramter (to change the default value and the indices) only if the named parameter is found on the view object. If the named parameter/variable is found on one of the parent objects, a new where-clause parameter definition is still added to the view object.

When redefining, a check is made to ensure that the existing variable has no kind specification (null) or is of the "where" kind (which means that the existing variable is a where-clause parameter). If not, an InvalidParamException is thrown.

Defining a named where-clause parameter does not automatically execute the query. You must call RowSet.executeQuery() to apply the new bind value.

Specified by:

defineNamedWhereClauseParam in interface RowSet

Parameters:

name - the name of the where-clause parameter.

defaultValue - specifies the default value for this where-clause parameter. This default value can be overridden through a call to setNamedWhereClauseParam().

indices - where-clause indices into which this parameter value should be bound. See above.

removeNamedWhereClauseParam

public void removeNamedWhereClauseParam(java.lang.String name)

Description copied from interface: RowSet

Removes a named where-clause parameter.

This method removes previously defined named where-clause parameter. A check is made to ensure that the variable being removed is a where-clause parameter (variable kind = "where"). If not, an InvalidParamException is thrown.

If the named where-clause parameter is found but it does not belong to the view object that owns this row set, an InvalidOperException is thrown. This means one is disallowed from removing a named where-clause parameter that belongs to the View definition, for example.

Removing a named where-clause parameter does not automatically execute the query. You must call RowSet.executeQuery() for the removal to take effect.

Specified by:

removeNamedWhereClauseParam in interface RowSet

Parameters:

name - the name of the where-clause parameter to remove.

getNamedWhereClauseParam

public java.lang.Object getNamedWhereClauseParam(java.lang.String name)

Description copied from interface: RowSet

Gets the value of a named where-clause parameter for this row set.

If the view object owns multiple row sets, each row set may have its own (different) named where-clause parameter value.

Specified by:

getNamedWhereClauseParam in interface RowSet

Parameters:

name - the name of the where-clause parameter.

setNamedWhereClauseParams

public void setNamedWhereClauseParams(AttributeList attrlist)

Description copied from interface: RowSet

Sets the value of a named where-clause parameters for the entire viewObject.

Setting a named where-clause parameter does not automatically execute the query. You must call RowSet.executeQuery() to apply the new bind value.

Specified by:

setNamedWhereClauseParams in interface RowSet

Parameters:

attrlist - is a Name, value pair of bind variables.

getNamedWhereClauseParams

public AttributeList getNamedWhereClauseParams()

Description copied from interface: RowSet

Gets all the Name, value pairs of a named where-clause parameter of the viewObject.

It uses the method getNamedWhereClauseParam to return all the name,value pairs from VariableValueManager.

Specified by:

getNamedWhereClauseParams in interface RowSet

Returns:

an AttributeList of name, value pairs of all named bind variables.

setNamedWhereClauseParam

public void setNamedWhereClauseParam(java.lang.String name,
                                     java.lang.Object value)

Description copied from interface: RowSet

Sets the value of a named where-clause parameter for this row set.

If the view object owns multiple row sets, each row set may have its own (different) named where-clause parameter value.

Setting a named where-clause parameter does not automatically execute the query. You must call RowSet.executeQuery() to apply the new bind value.

Specified by:

setNamedWhereClauseParam in interface RowSet

Parameters:

name - the name of the where-clause parameter.

value - the where-clause parameter value for this row set.

skipNamedWhereClauseParam

public void skipNamedWhereClauseParam(java.lang.String name)

Description copied from interface: RowSet

Skips the named where-clause parameter for this row set. This method does not remove the named where-clause parameter. However, it "masks out" the named where-clause parameter, so that the parameter is skipped when the query is executed.

Skipping a named where-clause parameter does not automatically execute the query. You must call RowSet.executeQuery() for the skip to take effect.

Specified by:

skipNamedWhereClauseParam in interface RowSet

Parameters:

name - the name of the where-clause parameter.

getWhereClauseParams

public java.lang.Object[] getWhereClauseParams()

Description copied from interface: RowSet

Gets the bind variable values to be used with the view object's where-clause.

Specified by:

getWhereClauseParams in interface RowSet

Returns:

an array of bind-variable values.

executeQuery

public void executeQuery()

Description copied from interface: RowSet

Executes the query.

Specified by:

executeQuery in interface RowSet

executeEmptyRowSet

public void executeEmptyRowSet()

Specified by:

executeEmptyRowSet in interface RowSet

executeQuery2

public void executeQuery2(boolean resetCurrency,
                          boolean force,
                          boolean emptyRowSet)

Specified by:

executeQuery2 in interface WSRowSet

markForExecuteQuery

public void markForExecuteQuery(boolean resetCurrency,
                                boolean force,
                                boolean emptyRowSet)

cancelQuery

public boolean cancelQuery()

Description copied from interface: RowSet

Cancels a running query.

Specified by:

cancelQuery in interface RowSet

Returns:

a flag indicating whether the request to cancel was honored or not. It will return false if the JDBC statement is not executing a query.

isExecuteQuery

public boolean isExecuteQuery()

Specified by:

isExecuteQuery in interface WSRowSet

isRefreshDataModel

public boolean isRefreshDataModel()

Specified by:

isRefreshDataModel in interface WSRowSet

refreshDataModel

public void refreshDataModel()

Specified by:

refreshDataModel in interface WSRowSet

refreshDataModel2

public void refreshDataModel2(boolean resetCurrency,
                              boolean force)

Specified by:

refreshDataModel2 in interface WSRowSet

isExecuted

public boolean isExecuted()

Description copied from interface: RowSet

Returns true if the current ViewObject's query has been executed for this row set.

Specified by:

isExecuted in interface RowSet

Returns:

true if query has been executed.

createRowSetIterator

public RowSetIterator createRowSetIterator(java.lang.String name)

Description copied from interface: RowSet

Creates an iterator for the row set.

Specified by:

createRowSetIterator in interface RowSet

Parameters:

name - the name to be given to the iterator.

Returns:

an iterator for this.

getRowSetIterators

public RowSetIterator[] getRowSetIterators()

Description copied from interface: RowSet

Gets all row set iterators that belong to this row set.

Specified by:

getRowSetIterators in interface RowSet

Returns:

the array of row set iterators.

findRowSetIterator

public RowSetIterator findRowSetIterator(java.lang.String name)

Description copied from interface: RowSet

Gets the named row set iterator that was created at runtime for this row set.

Specified by:

findRowSetIterator in interface RowSet

Parameters:

name - a row set iterator name. If null, it returns the the row set.

Returns:

the row set iterator. null if the named row set iterator is not not found.

findOrCreateRowSetIterator

public RowSetIterator findOrCreateRowSetIterator(java.lang.String name)

Specified by:

findOrCreateRowSetIterator in interface WSRowSet

findWSRowSetIterator

public WSRowSetIteratorImpl findWSRowSetIterator(java.lang.String name)

removeMasterRowSetIterator

public boolean removeMasterRowSetIterator(RowSetIterator masterRSI)

Description copied from interface: RowSet

Removes a master row set iterator.

Specified by:

removeMasterRowSetIterator in interface RowSet

Parameters:

masterRSI - the iterator to be removed.

Returns:

true if masterRS was found, false otherwise.

getMasterRowSetIterators

public RowSetIterator[] getMasterRowSetIterators()

Description copied from interface: RowSet

Return all controlling masters of this row set.

Specified by:

getMasterRowSetIterators in interface RowSet

Returns:

An array of master iterators.

getApplicationModule

public ApplicationModule getApplicationModule()

Description copied from interface: RowSet

Gets the row set's application module that contains this row set.

Strictly speaking, a row set belongs to a view object and the view object to an application module. This method returns the application module that cotains the view object, which contains this row set.

If this row set is the result of calling a View Link accessor, this row set belongs to an internal view object (see ViewObject.isInternal()). Such an internal view object belongs to the root application module. Put differently, if you call this method on a row set which is the result of calling a View Link accessor, it will return the root application module.

Specified by:

getApplicationModule in interface RowSet

Returns:

the ApplicationModule to which this row set belongs.

requestEstimatedRowCount

public void requestEstimatedRowCount()

Specified by:

requestEstimatedRowCount in interface WSRowSet

getEstimatedRowCount

public long getEstimatedRowCount()

Description copied from interface: RowSet

Counts the number of rows in the collection defined by the view object's query.

This method uses a "SELECT COUNT(1) FROM (<query-statement>)" query to obtained the initial count. After that, changes to row count (such as insertion and deletion of rows) is kept up to date.

However, since the row counting query and the query to retrieve actual rows are issued at two different times, it is possible for the accurate count to change between these two points. This is why this method is named getEstimatedRowCount().

Specified by:

getEstimatedRowCount in interface RowSet

Returns:

an estimated number of rows.

getDeferredEstimatedRowCount

public long getDeferredEstimatedRowCount()

Description copied from interface: RowSet

If this ViewObject is marked to not perform the estimatedRowCount query, then return -1 until either the estimatedRowCount is called and the count is known or the RowSet is fetched completely in which case the actual row count is known.

Specified by:

getDeferredEstimatedRowCount in interface RowSet

Returns:

-1 until either EstimatedRowCount or real RowCount is known.

getCappedRowCount

public long getCappedRowCount(long cap)

Specified by:

getCappedRowCount in interface RowSet

isForwardOnly

public boolean isForwardOnly()

Description copied from interface: RowSet

Tests if the row set is constrained to sequential access.

Specified by:

isForwardOnly in interface RowSet

Returns:

true if the row set is restricted to forward-only processing.

See Also:

RowSet.setForwardOnly(boolean)

setForwardOnly

public void setForwardOnly(boolean isForwardOnly)

Description copied from interface: RowSet

Constrains the row set to sequential access.

When set to true, a row preceeding the current row cannot be designated as the new current row. This restriction allows performance to be optimized.

Specified by:

setForwardOnly in interface RowSet

Parameters:

isForwardOnly - true restricts the row set to forward-only processing, false otherwise.

getAccessMode

public byte getAccessMode()

Specified by:

getAccessMode in interface RowSet

Returns:

Returns the current access mode for this row set.

See Also:

RowSet.setAccessMode(byte)

setAccessMode

public void setAccessMode(byte mode)

Description copied from interface: RowSet

Constrains the row access based on the following settings:

Switching access modes for a rowset will not take effect until the next explicit call to executeQuery. Switching accessmode back to SCROLLABLE from any other mode is not allowed.

Specified by:

setAccessMode in interface RowSet

Parameters:

mode - One of the four enumerated values RowSet.SCROLLABLE, RowSet.FORWARD_ONLY, RowSet.RANGE_PAGING, RowSet.RANGE_PAGING_AUTO_POST.

getRangePagingCacheFactor

public int getRangePagingCacheFactor()

Specified by:

getRangePagingCacheFactor in interface RowSet

setRangePagingCacheFactor

public void setRangePagingCacheFactor(int f)

Specified by:

setRangePagingCacheFactor in interface RowSet

setAssociationConsistent

public void setAssociationConsistent(boolean isAssociationConsistent)

Description copied from interface: RowSet

Sets the association-consistent flag for this row set.

Association-consistent mode allows the user to see new rows created/inserted through another view object. Note that this mode is effective only for view objects that are entity based. If the view object has no entity base, this mode has no effect.

Suppose we have an entity named E. Suppose two view objects, V1 and V2 are based on E. (V1 and V2 do not have to come from the same view definition.) Suppose the user creates a new row through V1. This creates an instance of E as well. The new entity row is registered only when its primary key is attribute set. At this time, an event is sent out to all view objects based on E, i.e., V1 and V2.

When V2 receives this event, it enumerates through all its collections (essentially its row sets--strictly speaking its query collections) looking for those whose isAssociationConsistent() value is true. For each row set whose flag value is true (say R2), it checks to see if it has any view row mapped to the new entity row. If not, it create a new view row and maps it to the new entity row. A rowInserted event fires.

Thus, from the user's view point, R2 is "seeing" the new row, although the row has not yet been posted to database. Hence, setting this flag to true enables the user to see new rows before the row is posted/queried when the view object is entity based.

If flag is false or if the view object is not entity based, the user needs to post the new row through Transaction.postChanges() and requery the row set through RowSet.executeQuery() to see the new row.

The default value for this flag can be globally controlled through the jbo.viewlink.consistent property. Its value can be true, false, or DEFAULT. If the property is not specified, the default value is DEFAULT. A similar property jbo.assoc.consistent controls whether the new-row-appearing behavior should be supported for row sets returned from entity association accessor calls. For jbo.assoc.consistent, supported values are true or false.

If the property value is set to true, all row sets will have true for its initial isAssociationConsistent() value. If the property value is set to false, all row sets will have false for its initial value. If the property value is set to DEFAULT (which is the default), the view object will use the following logic to compute its initial isAssociationConsistent() value: if the view object has multiple entity bases that are updateable, then the initial value is false. If the view object has a where-clause, then the initial value is false. Otherwise, it is true.

Once this method is called to set the flag value manually, neither the property setting nor the view object's initial flag value has an effect.

Specified by:

setAssociationConsistent in interface RowSet

Parameters:

isAssociationConsistent - indicates whether association-consistency should be on or not.

isAssociationConsistent

public boolean isAssociationConsistent()

Description copied from interface: RowSet

Returns the flag indicating whether association-consistent mode is on or not.

Specified by:

isAssociationConsistent in interface RowSet

Returns:

true if un-posted new rows are to appear, false otherwise. This flag has no effect if the view object is not entity based.

See Also:

RowSet.setAssociationConsistent(boolean)

closeRowSet

public void closeRowSet()

Description copied from interface: RowSet

Closes the row set. It closes all row set iterators that belong to this row set. If this row set is a detail row set in a master-detail relationship, closeRowSet removes this row set from the master row set iterator.

Specified by:

closeRowSet in interface RowSet

isFetchComplete

public boolean isFetchComplete()

Description copied from interface: RowSet

Tests if the query result set has been fetched to the end.

Specified by:

isFetchComplete in interface RowSet

Returns:

true if the result set has been fetched to the end.

isMaxFetchSizeExceeded

public boolean isMaxFetchSizeExceeded()

Description copied from interface: RowSet

Tests if the query result has been fetched to the end and the end was reached due to hitting the maxFetchSize limit

Specified by:

isMaxFetchSizeExceeded in interface RowSet

Returns:

true if the result set has been fetched to the maxFetchSize limit and there are still more rows in the database.

getProperty

public java.lang.Object getProperty(java.lang.String hintName)

Description copied from interface: Properties

Retrieves the specified property, if it exists.

Specified by:

getProperty in interface Properties

Parameters:

hintName - Property name.

Returns:

the value of the property, if any, otherwise null.

getProperty

public java.lang.Object getProperty(java.lang.String hintName,
                                    LocaleContext locale)

Specified by:

getProperty in interface Properties

refreshProperty

public java.lang.Object refreshProperty(java.lang.String hintName)

Description copied from interface: Properties

Retrieves the specified property, if it exists. If the application running in a 3 tier environment, it retrieves the property from the middle-tier server, refreshing the value on the client side. If the application is running in a 2 tier environment, it is equivalent to getProperty.

Specified by:

refreshProperty in interface Properties

Parameters:

hintName - Property name.

Returns:

the value of the property, if any, otherwise null.

getProperties

public java.util.Hashtable getProperties()

Description copied from interface: Properties

Gets the table of properties.

Specified by:

getProperties in interface Properties

Returns:

a hashtable of properties.

writeXML

public Node writeXML(int depthCount,
                     long options)

Description copied from interface: XMLInterface

Renders data in a canonical XML-format. The classes ViewObjectImpl and ViewRowImpl implement this method to render data in XML.

Use this method whenever data is required in XML format, either to present a UI (after converting XML data into some HTTP format using a stylesheet) or to pass the data as payload for messages via JMS.

The depthcount parameter represents to what level the rendering should recurse. A depthcount of zero (0) means do not traverse any View Links while rendering. One (1) means traverse the View Links on this object but no View Links thereafter, and so on.

The options parameter represents a set of bit flags that will control the writeXML behavior. The following bit flags have been defined:

• public static long XML_OPT_LIMIT_RANGE = 0x00000001 - Controls whether writeXML will only write rows in the range. If this flag is off, all rows in the row set will be written. If this flag is on, only rows in the current range will be written.
• public static long XML_OPT_CHANGES_ONLY = 0x00000002 - Controls whether only changed attribute values of an entity row is written. If this is on, only the attributes whose value has been marked as "changed" will be written. If this is off, all attributes (regardless of whether the attribute value has been changed or not) will be written. This flag is relevant only when writing EntityImpl.

Specified by:

writeXML in interface XMLInterface

Parameters:

depthCount - represents to what level the rendering should recurse.

options - a set of bit flags that will control the writeXML behavior.

writeXML

public Node writeXML(int depthCount,
                     long options,
                     XSLStylesheet xslt)

Specified by:

writeXML in interface XMLInterface

readXML

public void readXML(Element elem,
                    int depthCount)

Specified by:

readXML in interface XMLInterface

readXML

public void readXML(Element elem,
                    int depthCount,
                    XSLStylesheet xslt)

Specified by:

readXML in interface XMLInterface

writeXML

public Node writeXML(long options,
                     java.util.HashMap voAttrMap)

Description copied from interface: XMLInterface

Renders data in a canonical XML-format. The classes ViewObjectImpl and ViewRowImpl implement this method to render data in XML.

Use this method whenever data is required in XML format, either to present a UI (after converting XML data into some HTTP format using a stylesheet) or to pass the data as payload for messages via JMS.

The options parameter represents a set of bit flags that will control the writeXML behavior. The following bit flags have been defined:

• public static long XML_OPT_LIMIT_RANGE = 0x00000001 - Controls whether writeXML will only write rows in the range. If this flag is off, all rows in the row set will be written. If this flag is on, only rows in the current range will be written.
• public static long XML_OPT_CHANGES_ONLY = 0x00000002 - Controls whether only changed attribute values of an entity row is written. If this is on, only the attributes whose value has been marked as "changed" will be written. If this is off, all attributes (regardless of whether the attribute value has been changed or not) will be written. This flag is relevant only when writing EntityImpl.

The voAttrMap parameter represents in a hashmap, the mapping between a given ViewObject's definition type and the corresponding Attributes/accessors to render. A null entry in the hashmap means, render all attributes and accessors of that viewobject type.

Specified by:

writeXML in interface XMLInterface

Parameters:

options - a set of bit flags that will control the writeXML

voAttrMap - HashMap containing Definition names of ViewObjects and an array of AttributeDef to render for a ViewObject of that definition type.

writeXML

public Node writeXML(long options,
                     java.util.HashMap voAttrMap,
                     XSLStylesheet xslt)

Specified by:

writeXML in interface XMLInterface

getRowSet

public RowSet getRowSet()

Description copied from interface: RowSetIterator

Gets the Row Set that this Iterator belongs to.

Specified by:

getRowSet in interface RowSetIterator

Specified by:

getRowSet in class WSRowSetIteratorBase

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

Specified by:

getDetailRowSets in class WSRowSetIteratorBase

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

Specified by:

createDetailRowSet in class WSRowSetIteratorBase

Parameters:

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

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

Specified by:

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

Specified by:

getSyncLock in class WSRowSetIteratorBase

Returns:

the locking object.

setRangeSize

public int setRangeSize(int size)

Description copied from interface: RowIterator

Modifies the size of the Row Set Iterator 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

Specified by:

setRangeSize in class WSRowSetIteratorBase

Parameters:

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.

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 Iterator range.

Specified by:

getRangeSize in interface RowIterator

Specified by:

getRangeSize in class WSRowSetIteratorBase

Returns:

the number of rows in the range.

getRangeStart

public int getRangeStart()

Description copied from interface: RowIterator

Gets the absolute row index of the first row in the Row Set Iterator 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

Specified by:

getRangeStart in class WSRowSetIteratorBase

Returns:

an index.

setRangeStart

public int setRangeStart(int start)

Description copied from interface: RowIterator

Moves the Row Set Iterator 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

Specified by:

setRangeStart in class WSRowSetIteratorBase

Parameters:

start - the absolute index of the new first row in the Row Set Iterator range.

scrollRange

public int scrollRange(int amount)

Description copied from interface: RowIterator

Moves the Row Set Iterator range up or down a given number of rows.

Specified by:

scrollRange in interface RowIterator

Specified by:

scrollRange in class WSRowSetIteratorBase

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 range index.

Specified by:

scrollRangeTo in interface RowIterator

Specified by:

scrollRangeTo in class WSRowSetIteratorBase

Parameters:

row - the row.

index - the range index at which the row is to be found.

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

Specified by:

setRowValidation in class WSRowSetIteratorBase

Parameters:

flag - Whether to turn row validation off or not.

isRowValidation

public boolean isRowValidation()

Description copied from interface: RowIterator

Gets the validation flag on this iterator. By default a RowIterator validates the current row when navigating to another row. This method returns TRUE if this row-validation is turned off.

Specified by:

isRowValidation in interface RowIterator

Specified by:

isRowValidation in class WSRowSetIteratorBase

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

Specified by:

getIterMode in class WSRowSetIteratorBase

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

Specified by:

setIterMode in class WSRowSetIteratorBase

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

rangeRefreshed

public void rangeRefreshed(RangeRefreshEvent event)

Description copied from interface: RowSetListener

Invoked when the range changes.

Specified by:

rangeRefreshed in interface RowSetListener

Parameters:

event - a description of the new ranges.

rangeScrolled

public void rangeScrolled(ScrollEvent event)

Description copied from interface: RowSetListener

Invoked when the range is scrolled.

Specified by:

rangeScrolled in interface RowSetListener

Parameters:

event - a description of the new range.

rowInserted

public void rowInserted(InsertEvent event)

Description copied from interface: RowSetListener

Invoked when a row has been inserted.

Specified by:

rowInserted in interface RowSetListener

Parameters:

event - a description of the new Row object.

rowDeleted

public void rowDeleted(DeleteEvent event)

Description copied from interface: RowSetListener

Invoked when a row has been deleted.

Specified by:

rowDeleted in interface RowSetListener

Parameters:

event - a description of the deleted Row object.

rowUpdated

public void rowUpdated(UpdateEvent event)

Description copied from interface: RowSetListener

Invoked when an attribute of the row has been changed.

Specified by:

rowUpdated in interface RowSetListener

Parameters:

event - a description of the modified Row object.

navigated

public void navigated(NavigationEvent event)

Description copied from interface: RowSetListener

Invoked when the current-row designation changes.

Specified by:

navigated in interface RowNavigationListener

Specified by:

navigated in interface RowSetListener

Parameters:

event - a description of the new and previous current rows.

deepCopy

public RowSet deepCopy(java.util.HashMap voAttrMap,
                       long options)

Description copied from interface: RowSet

This method performs a copy of view rows and the Entity row references of the view rows that belong to this RowSet. To avoid unique key constraint violations, the values of the key attributes are not copied.

voAttrMap attribute could be used to specify a subset of the attributes that need to be copied. The map consists of name value pairs of the view object name and its attributes.

By including the name of the Accessor in the voAttrMap as a key, deep copy could be used to copy rows obtained by traversing the view links.

Example 1: Deep copy a OrderLine RowSet copying attributes value of Item ID, Order ID and Description of a OrderLine view row.

     voOrderLine     = myAM.findViewObject("OrderLine");
     attrFilter      = new HashMap();
     filterAttrDefs  = new ArrayList();
     filterAttrDefs.add("ItemID");
     filterAttrDefs.add("OrderID");
     filterAttrDefs.add("Description");
     attrFilter.put(voOrderLine.getDefFullName(), 
                   (String[]) filterAttrDefs.toArray(new String[filterAttrDefs.size()]));
     RowSet rsOrderLinesCopy = rsOrderLines.deepCopy(attrFilter, RowSet.COPY_OPT_ALL_ROWS);
 

Row API could be used to set the primary keys on the newly created rows and eventually the transaction commit would insert the rows in the database.

Example 2: Deep copy a set of Orders and their Lines. Copy the Customer attribute from an Order and Item ID, Description from Order Lines.

     voOrder         = myAM.findViewObject("Order");
     voOrderLine     = myAM.findViewObject("OrderLine");
     attrFilter      = new HashMap();
     filterAttrDefs  = new ArrayList();
     filterAttrDefs.add("Customer");
     // The name of the Order Line Accessor
     filterAttrDefs.add("Lines");
     attrFilter.put(voOrder.getDefFullName(), 
                   (String[]) filterAttrDefs.toArray(new String[filterAttrDefs.size()]));
     filterAttrDefs  = new ArrayList();
     filterAttrDefs.add("ItemID");
     filterAttrDefs.add("Description");
     attrFilter.put(voOrderLine.getDefFullName(), 
                   (String[]) filterAttrDefs.toArray(new String[filterAttrDefs.size()]));
     RowSet rsCopy = rs.deepCopy(attrFilter, RowSet.COPY_OPT_ALL_ROWS);
 

For each Order row in the copied rowset the accessor could be used to get its Order Lines. If there is Cascade update set on the association, setting the Order number on an Order row would update the foreign key in its Order Line rows.

Specified by:

deepCopy in interface RowSet

Parameters:

voAttrMap - a name value pair of a View Object name and an array of its AttributeDef objects or an array of attribute names. A null value for this parameter results in copying all the non-key attribute values of this RowSet. View Links are not traversed for a null value.

options - valid values are RowSet.COPY_OPT_ALL_ROWS and RowSet.COPY_OPT_LIMIT_RANGE.

Returns:

a deep copy of the RowSet

resetExecuted

public void resetExecuted()

Description copied from interface: RowSet

This methods invalidates all the iterators on this rowset and marks the rowset as not executed.

Specified by:

resetExecuted in interface RowSet