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

E10653-05

oracle.jbo.server
Class DSViewObjectImpl

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.DSViewObjectImpl
All Implemented Interfaces:
java.util.EventListener, ViewCriteriaClauseBuilder, ViewCriteriaManagerOwner, ViewObjectDynAttr, WSRowSetIteratorMarshaller, WSRowSetMarshaller, ComponentObject, GenericHints, NavigatableRowIterator, OperationContainer, Properties, RowIterator, RowMatchBindValueSupplier, RowNavigationListener, RowSet, RowSetIterator, RowSetListener, AttributeDependencyManager, EntityListener, TransactionListener, TransactionPostListener, StructureDef, VariableManagerOwner, VariableManagerOwnerBase, ViewCriteriaManager, ViewObject, XMLInterface

public class DSViewObjectImpl
extends ViewObjectImpl

Since:
release specific (what release of product did this appear in)

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, INTERNAL_EXPR_VALUE_OVERRIDES, mAssocClause, mAssocFromClause, mAssocRefs, mAttrDefs, mAttrDefsTab, mAutoPostChanges, mChangedAttrIndices, mChgAttrIndUseCount, mDefaultMaxActiveNodes, mDefaultMaxRowsPerNode, mDefaultRowSetMap, mDynAttrOffset, 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_MODE_SKIP_WHERE, 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, XML_PASSIVATION_USE
 
Fields inherited from interface oracle.jbo.GenericHints
PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP
 
Fields inherited from interface oracle.jbo.ViewCriteriaManager
DFLT_VIEW_CRITERIA_NAME, IMPLICIT_VIEW_CRITERIA_NAME, QUICKSEARCH_VIEW_CRITERIA_NAME
 
Constructor Summary
DSViewObjectImpl()
           
 
Method Summary
protected  RowFilter buildRowFilter(java.lang.Object[] paramValues)
           
protected  ViewRowImpl createRowFromResultSet(java.lang.Object qc, java.sql.ResultSet resultSet)
           
protected  void executeQueryForCollection(java.lang.Object qcObj, java.lang.Object[] params, int noUserParams)
          Override from VO to execute the other side
 long getQueryHitCount(ViewRowSetImpl viewRowSet, Row[] masterRows)
           
protected  boolean hasNextForCollection(java.lang.Object qc)
          ;cefmnov* Override from VO to find if the source collection has any more rows.
 void rangeRefreshed(RangeRefreshEvent event)
          Invoked when the range changes.
 void setFetchSize(short size)
          Sets the number of rows that JDBC will fetch from the database during one round trip.
 int setRangeSize(int size)
          Sets the range size for the iterator.
 int setRangeStart(int start)
          Positions the range.
 
Methods inherited from class oracle.jbo.server.ViewObjectImpl
_internal_dbg_debug_data, activateCurrentRow, activateDynamicAttributeDefs, activateIteratorState, activateNewRowTracker, activateNewRowTracker, activateState, activateState, activateState, activateTransientAttribute, activateTransients, activateTransients, addDynamicAttribute, addDynamicAttributeWithType, addForwardDependency, addListener, addManagementListener, addOperation, addOrderByClause, addQueryMode, addRowOperation, addRowSet, addViewCriteriaToWhereClause, addViewLink, addWhereClause, adjustERCWithChangedRows, afterCommit, afterEntityRemove, afterRemove, afterRollback, appendXMLElementNodes, appendXMLElementNodes, applyBindVariableForCriteria, applyPersonalization, applyViewCriteria, applyViewCriteria, beforeCommit, beforeEntityRemove, beforeRollback, bindFinderRS, bindParametersForCollection, bindRangePagingParams, buildEffectiveDateFromClauseFragment, buildEffectiveDateWhereClauseFragment, buildFromClause, buildKey, buildNewCollection, buildOperationDefinitions, buildOrderByClause, buildQualifyingRowFilters, buildQuery, buildQuery, buildRangePagingQuery, buildRowOperationDefinitions, buildSelectClause, buildSubquery, buildViewCriteriaClauses, buildWhereClause, cancelQuery, checkPassivateViewAttributes, clearCache, clearViewCriterias, closeFreedStatements, closeRowSet, closeRowSetIterator, createAndInitRow, createAndInitRowForCollection, createDetailRowSet, createFinderVO, createInstance, createInstanceFromResultSet, createInstanceWithEntities, createKey, createNewRowForCollection, createRow, createRowSet, createRowSetIterator, createVariableValueManager, createVariableValueManagerForRS, createViewAccessorRS, createViewCriteria, createViewLinkAccessor, createViewLinkAccessorRS, createViewLinkAccessorVO, createViewLinkScanBaseRS, createViewRowSet, createXMLDefinition, criteriaChanged, criteriaSelReqBindVarsChanged, deepCopy, defineNamedWhereClauseParam, doesRowFilterMatch, dumpQCs, enumerateRowsInRange, executeDetailQuery, executeEmptyRowSet, executeQuery, findAltKeyDef, findAndSetCurrentRowByKey, findAttributeDef, findByAltKey, findByEntity, findByKey, findByKey, findByViewCriteria, findByViewCriteriaForViewRowSet, findByViewCriteriaWithBindVars, findByViewCriteriaWithBindVars, findInCacheByAltKey, findInCacheByKey, findListBindingDef, findOrCreateLocalViewObject, findOrCreateLocalViewObject, findPrimaryKeyColumns, 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, getBackwardDependencies, getBackwardDependencyAttributes, getBindingStyle, getBindValsForSqlGen, getByKeyFinderRS, getCachedQueryCollection, getCalculatedAttributeCount, getCallableStatement, getCappedQueryHitCount, getCappedRowCount, getCliIteratorState, getColumnNameForQuery, getCriteriaAdapter, getCriteriaItemAttributeHints, getCriteriaItemClause, getCurrentRow, getCurrentRowIndex, getCurrentRowSlot, getDBSortCriteria, getDBTransaction, getDef, getDefaultAccessMode, getDefaultRangePagingCacheFactor, getDefaultRangeSize, getDefaultRowSet, getDefaultRowSetInternal, getDeferEstimatedRowCountProperty, getDeferredEstimatedRowCount, getDefFullName, getDefName, getDeleteParticipants, getDetailEstimatedRowCount, getDetailRowSets, getDiscrColLoadIndices, getDynamicAttributeCount, getDynamicAttributeOffset, getEntityDef, getEntityDefCount, getEntityDefs, getEstimatedRangePageCount, getEstimatedRowCount, getFetchedRowCount, getFetchMode, getFetchSize, getFilteredRows, getFilteredRows, getFilteredRowsInRange, getFilteredRowsInRange, getForwardDependencies, getForwardDependencyAttributes, getFromClause, getFromClauseFlags, getFullLoggingName, getFullSqlMode, getImageLoc, getImplObject, getInsertParticipants, getIterMode, getKeyAttributeDefs, getListBindingDefsInternal, getLockParticipants, getMasterKeyValues, getMasterRowSetIterators, getMaxFetchSize, getNamedWhereClauseParam, getNamedWhereClauseParams, getNextRangeSet, getOperationDefinitions, getOrderByClause, getParametersAsStorageTypes, getPreparedStatement, getPreviousRangeSet, getPrimaryKeys, getProxyClassName, getProxyInterfaceName, getQualifyingRowFilters, getQuery, getQueryCollection, getQueryHint, getQueryHitCount, getQueryMode, getQueryOptimizerHint, getQueryTimeOut, getRangeIndexOf, getRangePageStartForCollection, getRangePagingCacheFactor, getRangeSize, getRangeStart, getReqdVC, getRequiredViewCriteria, getRow, getRowAtRangeIndex, getRowClass, getRowComparator, getRowCount, getRowCountInRange, getRowFilters, getRowFilterValues, getRowFromHandle, getRowLimit, getRowMatch, getRowMatchBindValue, getRowMatchFromViewCriteria, getRowOperationDefinitions, getRowProxyClassName, getRowQualifier, getRowSet, getRowSetForSqlGen, getRowSetImpl, getRowSetIterator, getRowSetIterators, getRowSets, getRowSetsInternal, getScanRowFilterAttributeDefs, getSelectClause, getSelectClauseFlags, getSignature, getSortBy, getSortCriteria, getSubclassDef, getSubclassDefFromStructureDef, getSubstitutedDefNames, getSyncLock, getTransPostHandle, getUserDataForCollection, getUserDefinedQuery, getViewAccessorDefsInternal, getViewAttributeDefImpls, getViewCriteria, getViewCriteria, getViewCriteriaClause, getViewCriteriaClause, getViewCriteriaManager, getViewCriteriaManagerInternal, getViewDef, getViewLinkAccessorInfo, getViewLinkDestinationAttributes, getViewLinkNames, getViewLinks, getViewObject, getWhereClause, getWhereClauseFlags, getWhereClauseParams, getXMLElementTag, getXMLRowElementTag, handleActivatedRowNotFound, hasDefaultRowSet, hasNext, hasPrevious, hideAttributeDef, initFromDef, insertRow, insertRowAtRangeIndex, isAssociationConsistent, isAttributeKey, isAutoPostChanges, isAutoRefreshEnabled, isCollectionPresent, isDefaultAssocConsistent, isDefaultRowSet, isDynamicAttribute, isDynamicAttribute, isEffectiveDated, isEntityReferenceSelected, 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, prepareVOForQuery, previous, printXMLDefinition, processDatabaseChangeNotification, processNewSelectSet, processSortCriteria, putViewCriteria, qualifiesRowFilter, rangeScrolled, readFromXml, readRowXML, readRowXML, readXML, readXML, refreshCollection, refreshWhereClauseParams, registerDatabaseChangeListener, releaseUserDataForCollection, remove, removeApplyViewCriteriaName, removeCurrentRow, removeCurrentRowAndRetain, removeCurrentRowFromCollection, removeListener, removeManagementListener, removeMasterRowSetIterator, removeNamedWhereClauseParam, removeRowHandle, removeRowSet, removeViewCriteria, reset, resetCriteria, resetExecuted, resetSelectedAttributeDefs, resetSelectedAttributeDefs, resetSession, retrieveByKey, retrieveByKey, retrieveByKey, rowDeleted, rowInserted, rowQualifies, rowUpdated, scrollRange, scrollRangeTo, scrollToRangePage, selectAttributeDefs, setAccessMode, setApplyJoinedViewCriteriaNames, setApplyViewCriteriaName, setApplyViewCriteriaName, setApplyViewCriteriaNames, setAssociationConsistent, setAutoPostChanges, setBindingStyle, setCurrentRow, setCurrentRowAtRangeIndex, setCurrentUnionViewCriteriaName, setDBSortCriteria, setDefaultAccessMode, setDefaultAssocConsistent, setDefaultRangePagingCacheFactor, setDefaultRangeSize, setFetchCompleteForCollection, setFetchMode, 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, setReqdVC, setRequiredViewCriteria, setResultSetForCollection, setRowFilterValues, setRowMatch, setRowMatchFromViewCriteria, setRowQualifier, setRowValidation, setSelectClause, setSelectClauseFlags, setSortBy, setThrowOnListBindingMismatch, setTransPostHandle, setUserDataForCollection, setViewCriteriaAdapter, setViewLinkAccessorRetained, setWhereClause, setWhereClauseFlags, setWhereClauseParam, setWhereClauseParams, shouldPutJoinConstraintInWhereClause, showCursorUsage, skipNamedWhereClauseParam, sortRows, sourceChanged, substituteAttribute, throwOnListBindingMismatch, unpinDetailQC, unselectAttributeDefs, updateRowSetFromXML, validate, validateRangeSizeForRangePaging, writeXML, writeXML, writeXML, writeXML
 
Methods inherited from class oracle.jbo.server.ComponentObjectImpl
addListener, create, createRef, ensureVariableManager, findOperationDefinitions, getAllProperties, getCompListeners, getCompListenersList, getDefinitionManager, getFullNameForPersDef, getHintValue, getLabel, getLabelPlural, getMessageBundleClass, getProxyClassName, getResourceBundleDef, getRootApplicationModule, getStringFromMessageBundle, getTooltip, getVariableManager, hasVariables, isDead, isPersonalized, isRegWithPiggyMan, resolvePropertyRaw, setName, setParent
 
Methods inherited from class oracle.jbo.server.NamedObjectImpl
setParent, setPropertiesMap
 
Methods inherited from class oracle.jbo.common.NamedObjectImpl
allocatePropertyMap, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionsMap, getPropertyMap, getResourcesFromBundle, isPropertyExpression, mergePropertyMap, refreshProperty, removeProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setFullName, setPropertiesMap2, setProperty, setProperty, setPropertyExpression, 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.GenericHints
getHintValue, getLabel, getLabelPlural, getTooltip
 
Methods inherited from interface oracle.jbo.Properties
getProperties, getProperty, getProperty, refreshProperty
 

Constructor Detail

DSViewObjectImpl

public DSViewObjectImpl()
Method Detail

executeQueryForCollection

protected void executeQueryForCollection(java.lang.Object qcObj,
                                         java.lang.Object[] params,
                                         int noUserParams)
Override from VO to execute the other side

Overrides:
executeQueryForCollection in class ViewObjectImpl
Parameters:
qcObj - 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.

buildRowFilter

protected RowFilter buildRowFilter(java.lang.Object[] paramValues)
Overrides:
buildRowFilter in class ViewObjectImpl

createRowFromResultSet

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

hasNextForCollection

protected boolean hasNextForCollection(java.lang.Object qc)
;cefmnov* Override from VO to find if the source collection has any more rows.

Overrides:
hasNextForCollection in class ViewObjectImpl

getQueryHitCount

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

setFetchSize

public void setFetchSize(short size)
Description copied from class: ViewObjectImpl
Sets the number of rows that JDBC will fetch from the database during one round trip.

The framework will use this value to set the JDBC row pre-fetch size. Note that the row pre-fetch size has performance ramifications. A larger fetch size is more expensive in terms of memory usage than a smaller size. The default fetch size is 1 row.

If the value of ViewObjectImpl.setFetchMode(byte) is FETCH_ALL, then the value of setFetchSize is disregarded.

For each View Object, this method is customizable. Deciding what value to use could be made at runtime based on how many rows are expected for a particular View Object.

Overrides:
setFetchSize in class ViewObjectImpl
Parameters:
size - number of rows to fetch from the database. 1 is the default.
See Also:
ViewObjectImpl.setFetchMode(byte)

setRangeSize

public int setRangeSize(int size)
Description copied from class: ViewObjectImpl
Sets the range size for the iterator.

The following code example creates one View Object, uses the default iterator to display one row at a time, and creates a second iterator on the same View Object to display a range of five rows.

  // Create the View Object within the context defined by the
  // Application Module. The View Object provides a default iterator.
     ViewObject vo = appMod.createViewObject(voName, voDefFile);

  // Create another iterator.
     RowSetIterator secondIter = vo.createRowSetIterator("Two");
     secondIter.setRangeSize(5);
 

Specified by:
setRangeSize in interface RowIterator
Overrides:
setRangeSize in class ViewObjectImpl
Parameters:
size - the new range size, or -1 if all rows are to be included.
Returns:
the new range size.
See Also:
RowIterator.setRangeStart(int)

setRangeStart

public int setRangeStart(int start)
Description copied from class: ViewObjectImpl
Positions the range.

This method scrolls the range to make the row of the specified start index the first row of the range. If successful, RowSetListener.rangeScrolled() is called to send a ScrollEvent to registered RowSetListener.

If start indicates a row beyond the last row, the range will be scrolled to the end of the row set.

In the following code sample, the range starts with the fourth row. Assume that printRows is a helper function defined elsewhere.

    vo.setRangeStart(4);
    vo.setRangeSize(3);
    // this command prints rows 4 - 6.
    printRows(vo.getAllRowsInRange(), vo.getRangeStart());
 

Specified by:
setRangeStart in interface RowIterator
Overrides:
setRangeStart in class ViewObjectImpl
Parameters:
start - an absolute row index.
Returns:
the absolute row index of the first row of the resulting range.
See Also:
ScrollEvent, RowSetListener

rangeRefreshed

public void rangeRefreshed(RangeRefreshEvent event)
Description copied from interface: RowSetListener
Invoked when the range changes.

Specified by:
rangeRefreshed in interface RowSetListener
Overrides:
rangeRefreshed in class ViewObjectImpl
Parameters:
event - a description of the new ranges.

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

E10653-05

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