oracle.jbo.server.ejb.facade
Class CmrAccessorViewRowSet

java.lang.Object
  oracle.jbo.common.PropertiesHelper
      oracle.jbo.common.RowSetHelper
          oracle.jbo.server.ViewRowSetImpl
              oracle.jbo.server.ejb.facade.CmrAccessorViewRowSet

All Implemented Interfaces:

java.io.Serializable, WSRowSetIteratorMarshaller, WSRowSetMarshaller, XmlSerializable, NavigatableRowIterator, Properties, RowIterator, RowSet, RowSetIterator, VariableManagerOwner, VariableManagerOwnerBase, XMLInterface

public class CmrAccessorViewRowSet
extends ViewRowSetImpl

See Also:

Serialized Form

Field Summary

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

CmrAccessorViewRowSet(ViewObjectImpl vo, Row masterRow, boolean isDefaultRS)

Method Summary

java.lang.String	getElementTagName()
java.lang.String	getFullName()
java.lang.Object[]	getParameters(boolean nullValueFlag, Row[] masterRows)
protected boolean	initQueryCollection(int forceFlag, RowFilter rowFilter) Sets up QueryCollection for the view row set.
void	readXML(Element elem, int depthCount)
void	readXML(Element elem, int depthCount, XSLStylesheet xslt)
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, findByEntity, findByKey, findByKey, findByViewCriteria, findByViewCriteriaWithBindVars, findInCacheByAltKey, findInCacheByKey, findRowSetIterator, first, 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, getParametersAsStorageTypes, getParametersAsStorageTypes, getPreviousRangeSet, getProperties, 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, insertRow, insertRowAt, insertRowAtRangeIndex, isAllRowsFetched, isAssociationConsistent, 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, setAssociationConsistent, 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 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

Constructor Detail

CmrAccessorViewRowSet

protected CmrAccessorViewRowSet(ViewObjectImpl vo,
                                Row masterRow,
                                boolean isDefaultRS)

Method Detail

initQueryCollection

protected boolean initQueryCollection(int forceFlag,
                                      RowFilter rowFilter)

Description copied from class: ViewRowSetImpl

Sets up QueryCollection for the view row set.

Overrides:

initQueryCollection in class ViewRowSetImpl

Parameters:

forceFlag - indicates whether to force-create the query collection or not. If this flag is 0, we try to find an existing in the query collection list (of the View Object). If it is 1, we force a new QC, except if the VO's max-fetch-size = 0 in which case we look for existing. If -1, we force a new QC, regardless of the VO's max-fetch-size.

rowFilter - filter to initialize the query collection.

Returns:

indicates whether a new query collection was created or not.

getParameters

public java.lang.Object[] getParameters(boolean nullValueFlag,
                                        Row[] masterRows)

Overrides:

getParameters in class ViewRowSetImpl

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:

• 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

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:

• 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(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