Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.5.0)

E10653-06


oracle.jbo.server
Class EntityRowSetImpl

java.lang.Object
  extended by oracle.jbo.common.PropertiesHelper
      extended by oracle.jbo.common.RowSetHelper
          extended by oracle.jbo.server.ViewRowSetImpl
              extended by oracle.jbo.server.EntityRowSetImpl

All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.Set, WSRowSetIteratorMarshaller, WSRowSetMarshaller, XmlSerializable, ExprWrappable, NavigatableRowIterator, Properties, RowIterator, RowSet, RowSetIterator, VariableManagerOwner, VariableManagerOwnerBase, XMLInterface
Direct Known Subclasses:
CmrAccessorEntRowSet

public class EntityRowSetImpl
extends ViewRowSetImpl
implements java.util.Set

EntityRowSetImpl represents the ResultSet of an association.

See Also:
Serialized Form

Field Summary
static byte ENTITYROWSET_INCONSISTENT
           
static byte ENTITYROWSET_NEW_AND_MODIFIED
           
static byte ENTITYROWSET_UNINITIALIZED
           
static byte mDefaultMode
           

 

Fields inherited from class oracle.jbo.server.ViewRowSetImpl
FINDER_RANGE_SIZE_DEFAULT, FINDER_RANGE_SIZE_MAX, FINDER_RANGE_SIZE_SKIP, FINDER_RANGE_SIZE_UNINITIALIZED, mDefaultFinderRangeSize, mDefaultView, mDefaultViewLinkMode, mMasterViews, mParamValues, mQRef, mUserParams, mViewMap, mViews, mWhereParams, VIEWLINK_MODE_CONSISTENT, VIEWLINK_MODE_DEFAULT, VIEWLINK_MODE_INCONSISTENT, VIEWLINK_MODE_UNINITIALIZED

 

Fields inherited from class oracle.jbo.common.RowSetHelper
listeners, mMgmtListeners, mName

 

Fields inherited from class oracle.jbo.common.PropertiesHelper
mProperties

 

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

 

Constructor Summary
protected EntityRowSetImpl(ViewObjectImpl vo, java.lang.String name, AssociationDefImpl assocDesc, java.lang.Object[] paramValues)
          Constructs a EntityRowSetImpl for a ViewRowSetImpl.

 

Method Summary
 boolean add(java.lang.Object o)
           
 boolean addAll(java.util.Collection c)
           
 void clear()
           
 boolean contains(java.lang.Object o)
           
 boolean containsAll(java.util.Collection c)
           
 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.
 Row[] findByKey(Key key, int maxNumOfRows, boolean skipWhere)
           
 Row[] findInCacheByKey(Key key, int maxNumOfRows)
           
 java.lang.String getElementTagName()
           
 java.lang.String getFullName()
           
 java.util.Hashtable getProperties()
          Returns all Properties
 boolean isAssociationConsistent()
          Returns the association-consistent flag for this row set.
 boolean isEmpty()
           
 java.util.Iterator iterator()
           
 void readXML(Element elem, int depthCount)
           
 void readXML(Element elem, int depthCount, XSLStylesheet xslt)
           
 boolean remove(java.lang.Object o)
           
 boolean removeAll(java.util.Collection c)
           
 boolean retainAll(java.util.Collection c)
           
 void setAssociationConsistent(boolean isConsistent)
          Sets the association-consistent flag for this row set.
 int size()
           
 java.lang.Object[] toArray()
           
 java.lang.Object[] toArray(java.lang.Object[] a)
           
 void writeAsXml(XmlOutput out, Node node, Criteria rules)
           
 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 voAttrRules)
          Renders data in a canonical XML-format.
 Node writeXML(long options, java.util.HashMap map, XSLStylesheet xslt)
           

 

Methods inherited from class oracle.jbo.server.ViewRowSetImpl
addListener, addManagementListener, addRowSetManagementListener, cancelQuery, close, closeRowSet, closeRowSetIterator, createAndInitRow, createDetailRowSet, createKey, createRow, createRowSetIterator, deepCopy, defineNamedWhereClauseParam, doesRowFilterMatch, dumpViewRowCache, ensureVariableManager, enumerateRowsInRange, execute, execute, executeDetailQuery, executeEmptyRowSet, executeQuery, findAndSetCurrentRowByKey, findByAltKey, findByViewCriteria, findByViewCriteriaWithBindVars, findInCacheByAltKey, findRowSetIterator, first, forceExecuteQueryOfSharedVO, getAccessMode, getAllRowsInRange, getApplicationModule, getCappedRowCount, getCliIteratorState, getCollMgmtInfo, getCurrentRow, getCurrentRowIndex, getCurrentRowSlot, getDefaultRowSetIterator, getDeferredEstimatedRowCount, getDetailEstimatedRowCount, getDetailRowSets, getEstimatedRangePageCount, getEstimatedRowCount, getFetchedRowCount, getFilteredRows, getFilteredRows, getFilteredRowsInRange, getFilteredRowsInRange, getIterMode, getMasterRowSetIterators, getMasterViewRowSetIterators, getMasterViewRowSetIteratorsList, getMessageBundleClass, getNamedWhereClauseParam, getNamedWhereClauseParams, getNextRangeSet, getParameters, getParameters, getParametersAsStorageTypes, getParametersAsStorageTypes, getPreviousRangeSet, getProperty, getQueryCollection, getRangeIndexOf, getRangePagingCacheFactor, getRangeSize, getRangeStart, getResourceBundleDef, getRow, getRow, getRowAtRangeIndex, getRowCount, getRowCountInRange, getRowFilterValues, getRowFromHandle, getRows, getRowSet, getRowSetIterator, getRowSetIterators, getSyncLock, getVariableManager, getVariableValue, getViewLinkMode, getViewObject, getWhereClauseParams, hasDefaultRowSetIterator, hasNext, hasPrevious, hasVariables, initQueryCollection, insertRow, insertRowAt, insertRowAtRangeIndex, isAllRowsFetched, isDefaultRowSet, isDefaultRS, isDirty, isExecuted, isExecutedInternal, isExecutedNotEmpty, isFetchComplete, isForwardOnly, isMaxFetchSizeExceeded, isNameGenerated, isNotifiedRefresh, isPassivationEnabled, isRangeAtBottom, isRangeAtTop, isRangePaging, isRowValidation, isScrollable, last, makeRowCopy, needsRefresh, next, preFetchRowsByKeys, preFetchRowsByKeys, prepareForBatchMode, previous, printActiveObjsTab, printColl, printRUChain, reduceUserParamsToSize, refreshCache, refreshCollection, refreshWhereClauseParams, removeCurrentRow, removeCurrentRowAndRetain, removeCurrentRowFromCollection, removeListener, removeManagementListener, removeMasterRowSetIterator, removeNamedWhereClauseParam, removeRowAndRetainAt, removeRowAt, removeRowFromCollectionAt, removeRowHandle, removeRowSetManagementListener, reset, resetExecuted, scrollRange, scrollRangeTo, scrollToRangePage, setAccessMode, setCollectionForRowFilter, setCurrentRow, setCurrentRowAtRangeIndex, setExecuteParameters, setForwardOnly, setIterMode, setMasterRowSetIterator, setNamedWhereClauseParam, setNamedWhereClauseParams, setOwnedByQC, setPassivationEnabled, setPassivationEnabledInternal, setRangePagingCacheFactor, setRangeSize, setRangeStart, setReceiveAllInsertEvents, setRowFilterValues, setRowValidation, setViewLinkMode, setWhereClauseParam, setWhereClauseParams, skipNamedWhereClauseParam

 

Methods inherited from class oracle.jbo.common.RowSetHelper
fireMgmtIteratorClosed, fireMgmtIteratorReset, fireNavigationEvent, fireRangeRefreshed, fireRangeScrolled, fireRowDeleted, fireRowInserted, fireRowUpdated, getListeners, getListenersList, getManagementListenersList, getName, hasListeners, hasManagementListeners, setName, updateNamedWhereParamValues

 

Methods inherited from class oracle.jbo.common.PropertiesHelper
closeObject, getImageLoc, getProperty, isReadOnly, refreshProperties, refreshProperty, setProperty

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface java.util.Set
equals, hashCode

 

Methods inherited from interface oracle.jbo.RowSet
getName

 

Methods inherited from interface oracle.jbo.Properties
getProperty, refreshProperty

 

Methods inherited from interface oracle.jbo.XMLInterface
readXML, readXML, writeXML, writeXML, writeXML, writeXML

 

Field Detail

ENTITYROWSET_UNINITIALIZED

public static final byte ENTITYROWSET_UNINITIALIZED
See Also:
Constant Field Values

ENTITYROWSET_INCONSISTENT

public static final byte ENTITYROWSET_INCONSISTENT
See Also:
Constant Field Values

ENTITYROWSET_NEW_AND_MODIFIED

public static final byte ENTITYROWSET_NEW_AND_MODIFIED
See Also:
Constant Field Values

mDefaultMode

public static byte mDefaultMode

Constructor Detail

EntityRowSetImpl

protected EntityRowSetImpl(ViewObjectImpl vo,
                           java.lang.String name,
                           AssociationDefImpl assocDesc,
                           java.lang.Object[] paramValues)
Constructs a EntityRowSetImpl for a ViewRowSetImpl.
Parameters:
vo - the ViewObjectImpl
assocDesc - the association
paramValues - parameters

Method Detail

getProperties

public java.util.Hashtable getProperties()
Returns all Properties
Specified by:
getProperties in interface Properties
Overrides:
getProperties in class ViewRowSetImpl
Returns:
a hashtable of properties.

setAssociationConsistent

public void setAssociationConsistent(boolean isConsistent)
Description copied from class: ViewRowSetImpl
Sets the association-consistent flag for this row set.

See ViewObjectImpl.setAssociationConsistent for details.

Specified by:
setAssociationConsistent in interface RowSet
Overrides:
setAssociationConsistent in class ViewRowSetImpl
Parameters:
isConsistent - indicates whether association-consistency should be on or not.
See Also:
ViewObjectImpl.setAssociationConsistent(boolean)

isAssociationConsistent

public boolean isAssociationConsistent()
Description copied from class: ViewRowSetImpl
Returns the association-consistent flag for this row set.

See ViewObjectImpl.isAssociationConsistent for details.

Specified by:
isAssociationConsistent in interface RowSet
Overrides:
isAssociationConsistent in class ViewRowSetImpl
Returns:
the association-consistent flag for this row set.
See Also:
ViewObjectImpl.isAssociationConsistent()

size

public int size()
Specified by:
size in interface java.util.Collection
Specified by:
size in interface java.util.Set

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Collection
Specified by:
isEmpty in interface java.util.Set

contains

public boolean contains(java.lang.Object o)
Specified by:
contains in interface java.util.Collection
Specified by:
contains in interface java.util.Set

iterator

public java.util.Iterator iterator()
Specified by:
iterator in interface java.lang.Iterable
Specified by:
iterator in interface java.util.Collection
Specified by:
iterator in interface java.util.Set

toArray

public java.lang.Object[] toArray()
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.Set

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.Set

add

public boolean add(java.lang.Object o)
Specified by:
add in interface java.util.Collection
Specified by:
add in interface java.util.Set

remove

public boolean remove(java.lang.Object o)
Specified by:
remove in interface java.util.Collection
Specified by:
remove in interface java.util.Set

containsAll

public boolean containsAll(java.util.Collection c)
Specified by:
containsAll in interface java.util.Collection
Specified by:
containsAll in interface java.util.Set

addAll

public boolean addAll(java.util.Collection c)
Specified by:
addAll in interface java.util.Collection
Specified by:
addAll in interface java.util.Set

retainAll

public boolean retainAll(java.util.Collection c)
Specified by:
retainAll in interface java.util.Collection
Specified by:
retainAll in interface java.util.Set

removeAll

public boolean removeAll(java.util.Collection c)
Specified by:
removeAll in interface java.util.Collection
Specified by:
removeAll in interface java.util.Set

clear

public void clear()
Specified by:
clear in interface java.util.Collection
Specified by:
clear in interface java.util.Set

findInCacheByKey

public Row[] findInCacheByKey(Key key,
                              int maxNumOfRows)
Overrides:
findInCacheByKey in class ViewRowSetImpl

findByKey

public Row[] findByKey(Key key,
                       int maxNumOfRows)
Description copied from class: ViewRowSetImpl
Finds and returns View rows that match the specified key.

See RowIterator.findByKey(oracle.jbo.Key, int) for details.

Specified by:
findByKey in interface RowIterator
Overrides:
findByKey in class ViewRowSetImpl
Parameters:
key - the key to match.
maxNumOfRows - the maximum size of the array to return, or -1 to return all rows.
Returns:
an array of rows matching the key.

findByKey

public Row[] findByKey(Key key,
                       int maxNumOfRows,
                       boolean skipWhere)
Overrides:
findByKey in class ViewRowSetImpl

findByEntity

public Row[] findByEntity(int eRowHandle,
                          int maxNumOfRows)
Description copied from interface: RowIterator
Finds and returns View rows that use the Entity row, identified by the Entity row handle, eRowHandle.
Specified by:
findByEntity in interface RowIterator
Overrides:
findByEntity in class ViewRowSetImpl
Parameters:
eRowHandle - the Entity row handle.
maxNumOfRows - the maximum size of the row array to return, or -1 to return all rows.
Returns:
an array of View rows that use the Entity row.

getFullName

public java.lang.String getFullName()

writeXML

public final Node writeXML(long options,
                           java.util.HashMap voAttrRules)
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:

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
voAttrRules - HashMap containing Definition names of ViewObjects and an array of AttributeDef to render for a ViewObject of that definition type.

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:

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(long options,
                     java.util.HashMap map,
                     XSLStylesheet xslt)
Specified by:
writeXML in interface XMLInterface

writeXML

public Node writeXML(int depthCount,
                     long options,
                     XSLStylesheet xslt)
Specified by:
writeXML in interface XMLInterface

readXML

public void readXML(Element elem,
                    int depthCount,
                    XSLStylesheet xslt)
Specified by:
readXML in interface XMLInterface

getElementTagName

public java.lang.String getElementTagName()
Specified by:
getElementTagName in interface XmlSerializable

writeAsXml

public void writeAsXml(XmlOutput out,
                       Node node,
                       Criteria rules)
Specified by:
writeAsXml in interface XmlSerializable

readXML

public void readXML(Element elem,
                    int depthCount)
Specified by:
readXML in interface XMLInterface

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.5.0)

E10653-06


Copyright © 1997, 2011, Oracle. All rights reserved.