oracle.toplink.queryframework
Class ValueReadQuery

java.lang.Object
  oracle.toplink.queryframework.DatabaseQuery
      oracle.toplink.queryframework.ReadQuery
          oracle.toplink.queryframework.DataReadQuery
              oracle.toplink.queryframework.DirectReadQuery
                  oracle.toplink.queryframework.ValueReadQuery

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.toplink.internal.helper.FalseUndefinedTrue

public class ValueReadQuery
extends DirectReadQuery

Purpose: Concrete class to perform a read of a single data value.

Responsibilities: Used in conjunction with CursoredStream size and Platform getSequence. This can be used to read a single data value (i.e. one field). A single data value is returned, or null if no rows are returned.

Since:

TOPLink/Java 1.2

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.toplink.queryframework.DatabaseQuery

CascadeAggregateDelete, CascadeAllParts, CascadeByMapping, CascadeDependentParts, CascadePrivateParts, NoCascading

Constructor Summary

ValueReadQuery()
Initialize the state of the query.

ValueReadQuery(Call call)
Initialize the query to use the specified call.

ValueReadQuery(java.lang.String sqlString)
Initialize the query to use the specified SQL string.

Method Summary

boolean

isValueReadQuery() Return if this is a value read query.

Methods inherited from class oracle.toplink.queryframework.DirectReadQuery

getValueConverter, isDirectReadQuery, setValueConverter

Methods inherited from class oracle.toplink.queryframework.DataReadQuery

getContainerPolicy, isDataReadQuery, setContainerPolicy, useCollectionClass, useCursoredStream, useCursoredStream, useCursoredStream, useScrollableCursor, useScrollableCursor, useScrollableCursor

Methods inherited from class oracle.toplink.queryframework.ReadQuery

cacheQueryResults, clearQueryResults, clearQueryResults, doNotCacheQueryResults, getFetchSize, getFirstResult, getMaxRows, getQueryResultsCachePolicy, isReadQuery, setFetchSize, setFirstResult, setMaxRows, setQueryResultsCachePolicy, setShouldCacheQueryResults, shouldCacheQueryResults

Methods inherited from class oracle.toplink.queryframework.DatabaseQuery

addArgument, addArgument, addArgument, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, cacheStatement, cascadeAllParts, cascadeByMapping, cascadePrivateParts, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, getCall, getCalls, getDatasourceCall, getDatasourceCalls, getEJBQLString, getFlushOnExecute, getHintString, getJPQLString, getName, getQueryTimeout, getRedirector, getReferenceClass, getSelectionCriteria, getSessionName, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isDataModifyQuery, isDeleteAllQuery, isDeleteObjectQuery, isExpressionQuery, isInsertObjectQuery, isModifyAllQuery, isModifyQuery, isNativeConnectionRequired, isObjectBuildingQuery, isObjectLevelModifyQuery, isObjectLevelReadQuery, isReadAllQuery, isReadObjectQuery, isReportQuery, isSQLCallQuery, isUpdateAllQuery, isUpdateObjectQuery, isWriteObjectQuery, maintainCache, prepareCall, setCall, setDatasourceCall, setEJBQLString, setFlushOnExecute, setHintString, setIsNativeConnectionRequired, setJPQLString, setName, setQueryTimeout, setRedirector, setSelectionCriteria, setSessionName, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldUseWrapperPolicy, setSQLStatement, setSQLString, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeByMapping, shouldCascadeParts, shouldCascadePrivateParts, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldMaintainCache, shouldPrepare, shouldUseWrapperPolicy, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ValueReadQuery

public ValueReadQuery()

Initialize the state of the query.

ValueReadQuery

public ValueReadQuery(java.lang.String sqlString)

Initialize the query to use the specified SQL string. Warning: Allowing an unverified SQL string to be passed into this method makes your application vulnerable to SQL injection attacks.

ValueReadQuery

public ValueReadQuery(Call call)

Initialize the query to use the specified call.

Method Detail

isValueReadQuery

public boolean isValueReadQuery()

Return if this is a value read query.

Overrides:

isValueReadQuery in class DatabaseQuery