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

E10653-01

oracle.jbo.server
Class ViewObjectOnRowSets

java.lang.Object
  extended by oracle.jbo.common.NamedObjectImpl
      extended by oracle.jbo.server.NamedObjectImpl
          extended by oracle.jbo.server.ComponentObjectImpl
              extended by oracle.jbo.server.ViewObjectImpl
                  extended by oracle.jbo.server.ViewObjectOnRowSets
All Implemented Interfaces:
java.util.EventListener, ViewCriteriaClauseBuilder, ViewCriteriaManagerOwner, ViewObjectDynAttr, WSRowSetIteratorMarshaller, WSRowSetMarshaller, ComponentObject, NavigatableRowIterator, Properties, RowIterator, RowMatchBindValueSupplier, RowNavigationListener, RowSet, RowSetIterator, RowSetListener, EntityListener, TransactionListener, TransactionPostListener, StructureDef, VariableManagerOwner, VariableManagerOwnerBase, ViewCriteriaManager, ViewObject, XMLInterface

public class ViewObjectOnRowSets
extends ViewObjectImpl


Field Summary
 
Fields inherited from class oracle.jbo.server.ViewObjectImpl
DATA_ROWKEYTAG, DYN_ATTRS, DYN_ATTRS_ENTRY, DYN_ATTRS_EXPR, DYN_ATTRS_NAME, DYN_ATTRS_TYPE, EFFDT_MODE, ENT_HDL_TRACKER, ENT_REF_INDEX, FETCH_ALL, FETCH_AS_NEEDED, FETCH_DEFAULT, FULLSQL_MODE_AUGMENTATION, FULLSQL_MODE_NO_AUGMENTATION, mAssocClause, mAssocFromClause, mAssocRefs, mAttrDefs, mAttrDefsForExtendedVOs, mAttrDefsTab, mAutoPostChanges, mChangedAttrIndices, mChgAttrIndUseCount, mDefaultMaxActiveNodes, mDefaultMaxRowsPerNode, mDefaultRowSetMap, MIN_ACTIVE_NODES, MIN_ROWS_PER_NODE, mKeyAttrRefs, mOptimizerHint, mOrderBy, mUsePersColl, mUserDefinedQuery, mViewDef, mViewRowSet, mWhere, NEW_ROW_HANDLE, NEW_ROW_INDEX, NEW_ROW_TRACKER, PROPERTY_DEFERRED_ESTIMATED_ROWCOUNT, QC_TAG, TRANSIENT_DATA_ROWTAG
 
Fields inherited from class oracle.jbo.common.NamedObjectImpl
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX
 
Fields inherited from interface oracle.jbo.ViewObject
IMAGE_LOC, QUERY_MODE_SCAN_DATABASE_TABLES, QUERY_MODE_SCAN_ENTITY_ROWS, QUERY_MODE_SCAN_UNPOSTED_ENTITY_ROWS, QUERY_MODE_SCAN_VIEW_ROWS, QUERY_TIMEOUT_WAIT_FOREVER, XML_ELEM_PASSIVATE_TRANSIENT
 
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
 
Fields inherited from interface oracle.jbo.ViewCriteriaManager
DFLT_VIEW_CRITERIA_NAME, IMPLICIT_VIEW_CRITERIA_NAME, QUICKSEARCH_VIEW_CRITERIA_NAME
 
Constructor Summary
ViewObjectOnRowSets()
           
 
Method Summary
protected  void create()
           
protected  ViewRowImpl createRowFromResultSet(java.lang.Object qc, java.sql.ResultSet resultSet)
           
protected  void executeQueryForCollection(java.lang.Object qc, java.lang.Object[] params, int noUserParams)
          This method is invoked right before the row set executes the query.
protected  ViewRowImpl getNextMatchingRow(java.lang.Object qc)
           
protected  ViewRowImpl getNextRow(java.lang.Object qc)
           
 long getQueryHitCount(ViewRowSetImpl viewRowSet)
          Counts the number of rows that would be returned if the View Object were executed with the current query.
 long getQueryHitCount(ViewRowSetImpl viewRowSet, Row[] masterRows)
           
protected  boolean hasNextForCollection(java.lang.Object qc)
           
protected  Row[] retrieveByKey(ViewRowSetImpl rs, Key key, int maxNumOfRows, boolean skipWhere)
           
protected  void setDefaultAssocConsistent(boolean isEquiJoin)
           
 void setFromSources(RowSet[] fromSources, java.lang.String[] fromSourceNames)
           
 void setSelectSources(AttributeDefImpl[] baseAttrDefs, RowSet[] selectSources)
           
 void setWhereParserNode(JIParserNode whereParserNode)
           
 
Methods inherited from class oracle.jbo.server.ViewObjectImpl
activateCurrentRow, activateDynamicAttributeDefs, activateIteratorState, activateNewRowTracker, activateNewRowTracker, activateState, activateState, activateState, activateTransientAttribute, activateTransients, activateTransients, addDynamicAttribute, addDynamicAttributeWithType, addListener, addManagementListener, addOrderByClause, addQueryMode, addRowSet, addViewCriteriaToWhereClause, addViewLink, addWhereClause, afterCommit, afterEntityRemove, afterRemove, afterRollback, appendXMLElementNodes, appendXMLElementNodes, applyPersonalization, applyViewCriteria, applyViewCriteria, beforeCommit, beforeEntityRemove, beforeRollback, bindParametersForCollection, bindRangePagingParams, buildEffectiveDateFromClauseFragment, buildEffectiveDateWhereClauseFragment, buildFromClause, buildKey, buildNewCollection, buildOrderByClause, buildQualifyingRowFilters, buildQuery, buildQuery, buildRangePagingQuery, buildRowFilter, buildSelectClause, buildSubquery, buildViewCriteriaClauses, buildWhereClause, cancelQuery, checkPassivateViewAttributes, clearCache, clearViewCriterias, closeFreedStatements, closeRowSet, closeRowSetIterator, containsTableAlias, createAndInitRow, createDetailRowSet, createFinderVO, createInstance, createInstanceFromResultSet, createKey, createNewRowForCollection, createRow, createRowSet, createRowSetIterator, createVariableValueManager, createVariableValueManagerForRS, createViewAccessorRS, createViewCriteria, createViewLinkAccessor, createViewLinkAccessorRS, createViewLinkAccessorVO, createViewLinkScanBaseRS, createXMLDefinition, criteriaChanged, deepCopy, defineNamedWhereClauseParam, doesRowFilterMatch, dumpQCs, enumerateRowsInRange, executeDetailQuery, executeEmptyRowSet, executeQuery, findAltKeyDef, findAndSetCurrentRowByKey, findAttributeDef, findByAltKey, findByEntity, findByKey, findByKey, findByViewCriteria, findByViewCriteriaWithBindVars, findInCacheByAltKey, findInCacheByKey, findListBindingDef, findOrCreateLocalViewObject, findOrCreateLocalViewObject, findRowInQCs, findRowSet, findRowSetIterator, findViewAccessorDef, findViewDefFromDiscrVals, findViewDefFromDiscrVals, findViewLinkAccessor, findViewLinkAccessorVO, first, getAccessMode, getAllCachedQueryCollections, getAllRowsInRange, getAllViewCriteriaNames, getAllViewCriterias, getAltKeyAttrDefs, getApplicationModule, getApplicationModuleForLocalViewObject, getApplyAllViewCriterias, getApplyJoinedViewCriteriaNames, getApplyViewCriteriaNames, getApplyViewCriterias, getAssociationClause, getAttrDefsForEntityAttr, getAttributeCount, getAttributeDef, getAttributeDefs, getAttributeIndexOf, getAttrIndicesForEntityAttr, getAvailableViewCriteriaNames, getBindingStyle, getByKeyFinderRS, getCachedQueryCollection, getCalculatedAttributeCount, getCallableStatement, getCappedQueryHitCount, getCappedRowCount, getCliIteratorState, getColumnNameForQuery, getCriteriaAdapter, getCriteriaItemClause, getCurrentRow, getCurrentRowIndex, getCurrentRowSlot, getDBSortCriteria, getDBTransaction, getDef, getDefaultAccessMode, getDefaultRangePagingCacheFactor, getDefaultRangeSize, getDefaultRowSet, getDefaultRowSetInternal, getDeferredEstimatedRowCount, getDefFullName, getDefName, getDeleteParticipants, getDetailEstimatedRowCount, getDetailRowSets, getDiscrColLoadIndices, getDynamicAttributeCount, getDynamicAttributeOffset, getEntityDef, getEntityDefCount, getEntityDefs, getEstimatedRangePageCount, getEstimatedRowCount, getFetchedRowCount, getFetchMode, getFetchSize, getFilteredRows, getFilteredRows, getFilteredRowsInRange, getFilteredRowsInRange, getFromClause, getFromClauseFlags, getFullSqlMode, getImageLoc, getImplObject, getInsertParticipants, getIterMode, getKeyAttributeDefs, getLockParticipants, getMasterKeyValues, getMasterRowSetIterators, getMaxFetchSize, getNamedWhereClauseParam, getNamedWhereClauseParams, getNextRangeSet, getOrderByClause, getParametersAsStorageTypes, getPreparedStatement, getPreviousRangeSet, getPrimaryKeys, getProxyClassName, getProxyInterfaceName, getQualifyingRowFilters, getQuery, getQueryCollection, getQueryHint, getQueryMode, getQueryOptimizerHint, getQueryTimeOut, getRangeIndexOf, getRangePageStartForCollection, getRangePagingCacheFactor, getRangeSize, getRangeStart, getReqdVC, getRequiredViewCriteria, getRow, getRowAtRangeIndex, getRowClass, getRowComparator, getRowCount, getRowCountInRange, getRowFilters, getRowFilterValues, getRowFromHandle, getRowMatch, getRowMatchBindValue, getRowMatchFromViewCriteria, getRowProxyClassName, getRowQualifier, getRowSet, getRowSetImpl, getRowSetIterator, getRowSetIterators, getRowSets, getScanRowFilterAttributeDefs, getSelectClause, getSelectClauseFlags, getSignature, getSortBy, getSortCriteria, getSubclassDef, getSubstitutedDefNames, getSyncLock, getTransPostHandle, getUserDataForCollection, getUserDefinedQuery, getViewAttributeDefImpls, getViewCriteria, getViewCriteria, getViewCriteriaClause, getViewCriteriaClause, getViewCriteriaManager, getViewDef, getViewLinkDestinationAttributes, getViewLinkNames, getViewLinks, getViewObject, getWhereClause, getWhereClauseFlags, getWhereClauseParams, getXMLElementTag, getXMLRowElementTag, handleActivatedRowNotFound, hasDefaultRowSet, hasNext, hasPrevious, hideAttributeDef, initFromDef, insertRow, insertRowAtRangeIndex, isAssociationConsistent, isAttributeKey, isAutoPostChanges, isAutoRefreshEnabled, isCollectionPresent, isDefaultAssocConsistent, isDynamicAttribute, isDynamicAttribute, isExecuted, isFetchComplete, isForeignKey, isForScan, isForwardOnly, isInternal, isManageRowsByKey, isMasterKeyValues, isMaxFetchSizeExceeded, isNameGenerated, isPassivatableTransientAttribute, isPassivationEnabled, isPostedToDB, isQueryChanged, isRangeAtBottom, isRangeAtTop, isReadOnly, isRowValidation, isRuntimeSQLGeneration, isSelectAllAttributes, isTransientTransactionListener, isTransientTransactionPostListener, isViewLinkAccessorRetained, last, lookupAltKeyDef, lookupAttributeDef, lookupListBindingDef, lookupViewAccessorDef, markQueryCollectionDirty, marshalListBindingDefs, navigated, needsRefresh, next, notifyRowDeleted, notifyRowInserted, notifyRowUpdated, notifyRowUpdated, notifyRowUpdated, notifyRowUpdated, onDatabaseChangeNotification, passivateDynamicAttributeDef, passivateNewRowTracker, passivateState, passivateState, passivateState, passivateTransients, passivateTransients, populateAttributeForRow, postChanges, preFetchRowsByKeys, preFetchRowsByKeys, prepareForActivation, prepareForBatchMode, prepareForPassivation, previous, printXMLDefinition, processDatabaseChangeNotification, processNewSelectSet, processSortCriteria, putViewCriteria, rangeRefreshed, rangeScrolled, readFromXml, readRowXML, readRowXML, readXML, readXML, refreshCollection, refreshWhereClauseParams, registerDatabaseChangeListener, releaseUserDataForCollection, remove, removeApplyViewCriteriaName, removeCurrentRow, removeCurrentRowAndRetain, removeCurrentRowFromCollection, removeListener, removeManagementListener, removeMasterRowSetIterator, removeNamedWhereClauseParam, removeRowHandle, removeRowSet, removeViewCriteria, reset, resetSelectedAttributeDefs, resetSelectedAttributeDefs, resetSession, retrieveByKey, retrieveByKey, rowDeleted, rowInserted, rowQualifies, rowUpdated, scrollRange, scrollRangeTo, scrollToRangePage, selectAttributeDefs, setAccessMode, setApplyJoinedViewCriteriaNames, setApplyViewCriteriaName, setApplyViewCriteriaName, setApplyViewCriteriaNames, setAssociationConsistent, setAutoPostChanges, setBindingStyle, setCurrentRow, setCurrentRowAtRangeIndex, setDBSortCriteria, setDefaultAccessMode, setDefaultRangePagingCacheFactor, setDefaultRangeSize, setFetchCompleteForCollection, setFetchMode, setFetchSize, setForwardOnly, setFromClause, setFromClauseFlags, setFullSqlMode, setIterMode, setKeyAttributeDefs, setListenToEntityEvents, setManageRowsByKey, setMasterRowSetIterator, setMaxFetchSize, setNamedWhereClauseParam, setNamedWhereClauseParams, setNestedSelectForFullSql, setOrderByClause, setPassivatableTransientAttribute, setPassivationEnabled, setPostedToDB, setProxyClassName, setQuery, setQueryAsChanged, setQueryChanged, setQueryHint, setQueryMode, setQueryOptimizerHint, setQueryTimeOut, setRangePagingCacheFactor, setRangeSize, setRangeStart, setReqdVC, setRequiredViewCriteria, setResultSetForCollection, setRowFilterValues, setRowMatch, setRowMatchFromViewCriteria, setRowQualifier, setRowValidation, setSelectClause, setSelectClauseFlags, setSortBy, setTransPostHandle, setUserDataForCollection, setViewCriteriaAdapter, setViewLinkAccessorRetained, setWhereClause, setWhereClauseFlags, setWhereClauseParam, setWhereClauseParams, shouldPutJoinConstraintInWhereClause, showCursorUsage, skipNamedWhereClauseParam, sortRows, sourceChanged, substituteAttribute, unselectAttributeDefs, updateRowSetFromXML, validate, validateRangeSizeForRangePaging, writeXML, writeXML, writeXML, writeXML
 
Methods inherited from class oracle.jbo.server.ComponentObjectImpl
addListener, createRef, ensureVariableManager, getAllProperties, getCompListeners, getCompListenersList, getMessageBundleClass, getProxyClassName, getResourceBundleDef, getRootApplicationModule, getVariableManager, hasVariables, isDead, isRegWithPiggyMan, resolvePropertyRaw, setName, setParent
 
Methods inherited from class oracle.jbo.server.NamedObjectImpl
setParent, setPropertiesMap
 
Methods inherited from class oracle.jbo.common.NamedObjectImpl
getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyMap, getResourcesFromBundle, refreshProperty, removeProperty, removeProperty, requiresNamePrefixedResId, setFullName, setPropertiesMap2, setProperty, setProperty, setPropertyMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.jbo.StructureDef
getFullName, getName
 
Methods inherited from interface oracle.jbo.RowSet
getName
 
Methods inherited from interface oracle.jbo.VariableManagerOwnerBase
ensureVariableManager, getMessageBundleClass, getResourceBundleDef, getVariableManager, hasVariables
 
Methods inherited from interface oracle.jbo.ComponentObject
getFullName, getName
 
Methods inherited from interface oracle.jbo.Properties
getProperties, getProperty, getProperty, refreshProperty
 

Constructor Detail

ViewObjectOnRowSets

public ViewObjectOnRowSets()
Method Detail

create

protected void create()
Overrides:
create in class ComponentObjectImpl

setFromSources

public void setFromSources(RowSet[] fromSources,
                           java.lang.String[] fromSourceNames)

setSelectSources

public void setSelectSources(AttributeDefImpl[] baseAttrDefs,
                             RowSet[] selectSources)

setWhereParserNode

public void setWhereParserNode(JIParserNode whereParserNode)

setDefaultAssocConsistent

protected void setDefaultAssocConsistent(boolean isEquiJoin)
Overrides:
setDefaultAssocConsistent in class ViewObjectImpl

executeQueryForCollection

protected void executeQueryForCollection(java.lang.Object qc,
                                         java.lang.Object[] params,
                                         int noUserParams)
Description copied from class: ViewObjectImpl
This method is invoked right before the row set executes the query. If this method is overridden, the custom logic will be applied to all row sets.

In contrast, if the user overrides the view object's executeQuery(), the custom logic in it only applies only when the user calls executeQuery() on the view object. If he calls executeQuery() on secondary row sets, the custom logic in executeQuery() will not apply.

Overrides:
executeQueryForCollection in class ViewObjectImpl
Parameters:
qc - the query collection about to execute the query.
params - the bind parameters that will be applied to the query.
noUserParams - the number of user bind parameters supplied through the setWhereClauseParam calls.

hasNextForCollection

protected boolean hasNextForCollection(java.lang.Object qc)
Overrides:
hasNextForCollection in class ViewObjectImpl

getNextMatchingRow

protected ViewRowImpl getNextMatchingRow(java.lang.Object qc)

getNextRow

protected ViewRowImpl getNextRow(java.lang.Object qc)

createRowFromResultSet

protected ViewRowImpl createRowFromResultSet(java.lang.Object qc,
                                             java.sql.ResultSet resultSet)
Overrides:
createRowFromResultSet in class ViewObjectImpl

retrieveByKey

protected Row[] retrieveByKey(ViewRowSetImpl rs,
                              Key key,
                              int maxNumOfRows,
                              boolean skipWhere)
Overrides:
retrieveByKey in class ViewObjectImpl

getQueryHitCount

public long getQueryHitCount(ViewRowSetImpl viewRowSet)
Description copied from class: ViewObjectImpl
Counts the number of rows that would be returned if the View Object were executed with the current query.

This method obtains the row count by executing:

    SELECT COUNT(1) FROM query-statement ESTCOUNT
 
Based on the value returned, you might want to adjust the JDBC row prefetch size.

Overrides:
getQueryHitCount in class ViewObjectImpl
Returns:
the number of rows.

getQueryHitCount

public long getQueryHitCount(ViewRowSetImpl viewRowSet,
                             Row[] masterRows)
Overrides:
getQueryHitCount in class ViewObjectImpl

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

E10653-01

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