EclipseLink Core 4.0.2 · org.eclipse.persistence.queries.DatabaseQuery

Modifier and Type	Class and Description
public static enum	DatabaseQuery.ParameterType Used for parameter retreival in JPQL

Field Summary

Modifier and Type	Field and Description
protected transient Collection<Accessor>	accessors Connection to use for database access, required for server session connection pooling.
protected Boolean	allowNativeSQLQuery Property used to override a persistence unit level that disallows native SQL queries.
protected List<DatabaseField>	argumentFields PERF: Argument fields are cached in prepare to avoid rebuilding on each execution.
protected List<DatabaseQuery.ParameterType>	argumentParameterTypes
protected List<String>	arguments Arguments can be given and specified to predefined queries to allow reuse.
protected List<String>	argumentTypeNames Used to build a list of argumentTypes by name pre-initialization
protected List<Class<?>>	argumentTypes Needed to differentiate queries with the same name.
protected List<Object>	argumentValues Arguments values can be given and specified to predefined queries to allow reuse.
public static final String	BATCH_FETCH_PROPERTY INTERNAL: Property used for batch fetching in non object queries.
public static final int	CascadeAggregateDelete
public static final int	CascadeAllParts
public static final int	CascadeByMapping
public static final int	CascadeDependentParts
protected int	cascadePolicy Policy that determines how the query will cascade to its object's parts.
public static final int	CascadePrivateParts
protected transient ClassDescriptor	descriptor The descriptor cached on the prepare for object level queries.
protected List<ClassDescriptor>	descriptors The list of descriptors this query deals with.
protected boolean	doNotRedirect Can be set to true in the case there is a redirector or a default redirector but the user does not want the query redirected.
protected transient AbstractSession	executionSession Only used after the query is cloned for execution to store the execution session under which the query was executed.
protected Boolean	flushOnExecute
protected String	hintString Used for adding hints to the query string in oracle
protected volatile Boolean	isCustomQueryUsed PERF: Store if this query will use the descriptor custom query.
protected boolean	isExecutionClone PERF: Determines if the query has already been cloned for execution, to avoid duplicate cloning.
protected boolean	isNativeConnectionRequired Allow connection unwrapping to be configured.
protected boolean	isPrepared Queries prepare common stated in themselves.
protected boolean	isUserDefined Internal flag used to bypass user define queries when executing one for custom sql/query support.
protected boolean	isUserDefinedSQLCall Internal flag used to bypass user define queries when executing one for custom sql/query support.
protected transient String	monitorName Return the name to use for the query in performance monitoring.
protected String	name Queries can be given a name and registered with a descriptor to allow common queries to be reused.
public static final int	NoCascading
protected List<DatabaseField>	nullableArguments List of arguments to check for null.
protected String	parameterDelimiter Allow the reserved pound char used to delimit bind parameters to be overridden
protected PartitioningPolicy	partitioningPolicy Allow queries to be targeted at specific connection pools.
protected Map<Object, Object>	properties Internally used by the mappings as a temporary store.
protected DatabaseQueryMechanism	queryMechanism The query mechanism determines the mechanism on how the database will be accessed.
protected int	queryTimeout queryTimeout has three possible settings: DefaultTimeout, NoTimeout, and 1..N This applies to both DatabaseQuery.queryTimeout and DescriptorQueryManager.queryTimeout DatabaseQuery.queryTimeout: - DefaultTimeout: get queryTimeout from DescriptorQueryManager - NoTimeout, 1..N: overrides queryTimeout in DescriptorQueryManager DescriptorQueryManager.queryTimeout: - DefaultTimeout: get queryTimeout from parent DescriptorQueryManager.
protected TimeUnit	queryTimeoutUnit
protected QueryRedirector	redirector A redirector allows for a queries execution to be the execution of a piece of code.
protected transient AbstractSession	session Only used after the query is cloned for execution to store the session under which the query was executed.
protected String	sessionName Used to override the default session in the session broker.
protected Boolean	shouldBindAllParameters Bind all arguments to the SQL statement.
protected Boolean	shouldCacheStatement Cache the prepared statement, this requires full parameter binding as well.
protected boolean	shouldCloneCall Used to indicate whether or not the call needs to be cloned.
protected boolean	shouldMaintainCache Flag used for a query to bypass the identitymap and unit of work.
protected boolean	shouldPrepare Allow for the prepare of queries to be turned off, this allow for dynamic non-pre SQL generated queries.
protected boolean	shouldRetrieveBypassCache JPA flags to control the shared cache
protected boolean	shouldReturnGeneratedKeys
protected boolean	shouldStoreBypassCache
protected boolean	shouldUseWrapperPolicy Use the WrapperPolicy for the objects returned by the query
protected boolean	shouldValidateUpdateCallCacheUse Allow additional validation to be performed before using the update call cache
protected DatabaseMapping	sourceMapping Table per class requires multiple query executions.
protected AbstractRecord	translationRow Mappings and the descriptor use parameterized mechanisms that will be translated with the data from the row.

Access	Constructor and Description
protected	DatabaseQuery() PUBLIC: Initialize the state of the query

Method Summary

Modifier and Type	Method and Description
public void	addArgument(String argumentName) PUBLIC: Add the argument named argumentName.
public void	addArgument(String argumentName, Class<?> type) PUBLIC: Add the argument named argumentName and its class type.
public void	addArgument(String argumentName, Class<?> type, DatabaseQuery.ParameterType parameterType) INTERNAL: Add the argument named argumentName.
public void	addArgument(String argumentName, Class<?> type, boolean nullable) PUBLIC: Add the argument named argumentName and its class type.
public void	addArgument(String argumentName, Class<?> type, DatabaseQuery.ParameterType argumentParameterType, boolean nullable) INTERNAL: Add the argument named argumentName.
public void	addArgument(String argumentName, String typeAsString) PUBLIC: Add the argument named argumentName and its class type.
public void	addArgumentByTypeName(String argumentName, String typeAsString) INTERNAL: Add an argument to the query, but do not resolve the class yet.
public void	addArgumentValue(Object argumentValue) PUBLIC: Add the argumentValue.
public void	addArgumentValues(List<E> theArgumentValues) PUBLIC: Add the argumentValues to the query.
public void	addCall(Call call) PUBLIC: Used to define a store procedure or SQL query.
public void	addStatement(SQLStatement statement) PUBLIC: Used to define a statement level query.
public void	bindAllParameters() PUBLIC: Bind all arguments to any SQL statement.
public List<DatabaseField>	buildArgumentFields() INTERNAL: Build the list of arguments fields from the argument names and types.
protected void	buildSelectionCriteria(AbstractSession session) INTERNAL: In the case of EJBQL, an expression needs to be generated.
public void	cacheStatement() PUBLIC: Cache the prepared statements, this requires full parameter binding as well.
public void	cascadeAllParts() PUBLIC: Cascade the query and its properties on the queries object(s) and all objects related to the queries object(s).
public void	cascadeByMapping() PUBLIC: Cascade the query and its properties on the queries object(s) and all related objects where the mapping has been set to cascade the merge.
public void	cascadeOnlyDependentParts() INTERNAL: Used by unit of work, only cascades constraint dependencies.
public void	cascadePrivateParts() PUBLIC: Cascade the query and its properties on the queries object(s) and all privately owned objects related to the queries object(s).
public void	checkDescriptor(AbstractSession session) INTERNAL: Ensure that the descriptor has been set.
public Object	checkEarlyReturn(AbstractSession session, AbstractRecord translationRow) INTERNAL: Check to see if this query already knows the return value without performing any further work.
protected DatabaseQuery	checkForCustomQuery(AbstractSession session, AbstractRecord translationRow) INTERNAL: Check to see if a custom query should be used for this query.
public void	checkPrepare(AbstractSession session, AbstractRecord translationRow) INTERNAL: Check to see if this query needs to be prepare and prepare it.
public void	checkPrepare(AbstractSession session, AbstractRecord translationRow, boolean force) INTERNAL: Check to see if this query needs to be prepare and prepare it.
public Object	clone() Overrides java.lang.Object.clone. INTERNAL: Clone the query
protected void	clonedQueryExecutionComplete(DatabaseQuery query, AbstractSession session) INTERNAL Used to give the subclasses opportunity to copy aspects of the cloned query to the original query.
public void	convertClassNamesToClasses(ClassLoader classLoader) INTERNAL: Convert all the class-name-based settings in this query to actual class-based settings This method is implemented by subclasses as necessary.
public void	copyFromQuery(DatabaseQuery query) INTERNAL: Copy all setting from the query.
public void	dontBindAllParameters() PUBLIC: Do not Bind all arguments to any SQL statement.
public void	dontCacheStatement() PUBLIC: Don't cache the prepared statements, this requires full parameter binding as well.
public void	dontCascadeParts() PUBLIC: Do not cascade the query and its properties on the queries object(s) relationships.
public void	dontMaintainCache() PUBLIC: Set for the identity map (cache) to be ignored completely.
public Object	Returns: An object, the result of executing the query. execute(AbstractSession - the session in which the receiver will be executed. session, AbstractRecord translationRow) INTERNAL: Execute the query.
public abstract Object	Returns: - the result of executing the query. executeDatabaseQuery() INTERNAL: Execute the query
public Object	Returns: An object, the result of executing the query. executeInUnitOfWork(UnitOfWorkImpl - the session in which the receiver will be executed. unitOfWork, AbstractRecord - the arguments translationRow) INTERNAL: Override query execution where Session is a UnitOfWork.
public Object	extractRemoteResult(Transporter transporter) INTERNAL: Extract the correct query result from the transporter.
public Accessor	getAccessor() INTERNAL: Return the accessor.
public Collection<Accessor>	getAccessors() INTERNAL: Return the accessors.
public List<DatabaseQuery.ParameterType>	getArgumentParameterTypes() INTERNAL: Used to calculate parameter types in JPQL
public List<String>	getArguments() INTERNAL: Return the arguments for use with the pre-defined query option
public List<String>	getArgumentTypeNames() INTERNAL: Return the argumentTypeNames for use with the pre-defined query option These are used pre-initialization to construct the argumentTypes list.
public List<Class<?>>	getArgumentTypes() INTERNAL: Return the argumentTypes for use with the pre-defined query option
public List<Object>	getArgumentValues() INTERNAL: Return the argumentValues for use with argumented queries.
public Map<Object, Object>	getBatchObjects() INTERNAL: Return temporary map of batched objects.
public DatabaseCall	getCall() OBSOLETE: Return the call for this query.
public int	getCascadePolicy() INTERNAL: Return the cascade policy.
public Call	getDatasourceCall() ADVANCED: Return the call for this query.
public List<E>	getDatasourceCalls() ADVANCED: Return the calls for this query.
protected QueryRedirector	getDefaultRedirector() INTERNAL: Returns the specific default redirector for this query type.
public ClassDescriptor	getDescriptor() INTERNAL: Return the descriptor assigned with the reference class
public List<ClassDescriptor>	getDescriptors() INTERNAL: This is here only for JPA queries and currently only populated for JPA queries.
public String	getDomainClassNounName(String sessionName) INTERNAL: TopLink_sessionName_domainClass.
public boolean	getDoNotRedirect() This method is used in combination with redirected queries.
public String	getEJBQLString() PUBLIC: Return the EJBQL string of the query.
public AbstractSession	getExecutionSession() INTERNAL: Return the execution session.
public Boolean	getFlushOnExecute() PUBLIC: If executed against a RepeatableWriteUnitOfWork if this attribute is true EclipseLink will write changes to the database before executing the query.
public String	getHintString() PUBLIC: Return the current database hint string of the query.
public String	getJPQLString() PUBLIC: Return the JPQL string of the query.
public String	getMonitorName() INTERNAL: Return the name to use for the query in performance monitoring.
public String	getName() PUBLIC: Return the name of the query
public List<DatabaseField>	getNullableArguments() INTERNAL: Return the list of arguments to check for null.
public String	getParameterDelimiter() INTERNAL: Return the String used to delimit an SQL parameter.
public char	getParameterDelimiterChar() INTERNAL: Return the char used to delimit an SQL parameter.
public PartitioningPolicy	getPartitioningPolicy() PUBLIC: Return the query's partitioning policy.
public Map<Object, Object>	getProperties() INTERNAL: Property support for use by mappings.
public synchronized Object	getProperty(Object property) INTERNAL: Property support used by mappings to store temporary stuff in the query.
public DatabaseQueryMechanism	getQueryMechanism() INTERNAL: Return the mechanism assigned to the query
public String	getQueryNounName(String sessionName) INTERNAL: TopLink_sessionName_domainClass_queryClass_queryName (if exist).
public int	getQueryTimeout() PUBLIC: Return the number of seconds the driver will wait for a Statement to execute to the given number of seconds.
public TimeUnit	getQueryTimeoutUnit() PUBLIC: Return the unit of time the driver will wait for a Statement to execute.
public QueryRedirector	getRedirector() PUBLIC: Return the query redirector.
public QueryRedirector	getRedirectorForQuery() PUBLIC: Return the query redirector.
public Class<?>	getReferenceClass() PUBLIC: Return the domain class associated with this query.
public String	getReferenceClassName() INTERNAL: return the name of the reference class.
public Expression	getSelectionCriteria() PUBLIC: Return the selection criteria of the query.
public String	getSensorName(String operationName, String sessionName) INTERNAL: TopLink_sessionName_domainClass_queryClass_queryName (if exist)_operationName (if exist).
public AbstractSession	getSession() INTERNAL: Return the current session.
public String	getSessionName() PUBLIC: Return the name of the session that the query should be executed under.
public Boolean	getShouldBindAllParameters() INTERNAL: Returns the internal tri-state value of shouldBindParameters used far cascading these settings
public DatabaseMapping	getSourceMapping() INTERNAL:
public SQLStatement	getSQLStatement() PUBLIC: Return the SQL statement of the query.
public String	getSQLString() ADVANCED: Return the SQL string of the query.
public List<E>	getSQLStrings() ADVANCED: Return the SQL strings of the query.
public String	getTranslatedSQLString(Session session, DataRecord translationRow) ADVANCED: This can be used to access a queries translated SQL if they have been prepared, (i.e. query.prepareCall()).
public List<E>	getTranslatedSQLStrings(Session session, DataRecord translationRow) ADVANCED: This can be used to access a queries translated SQL if they have been prepared, (i.e. query.prepareCall()).
public AbstractRecord	getTranslationRow() INTERNAL: Return the row for translation
public boolean	hasAccessor() INTERNAL: returns true if the accessor has already been set.
public boolean	hasArguments() INTERNAL: Return if any arguments exist in the query.
public boolean	hasNullableArguments() INTERNAL: Return if the query has any nullable arguments.
public boolean	hasProperties() INTERNAL: Return if any properties exist in the query.
public boolean	hasQueryMechanism() INTERNAL: Check if the mechanism has been set yet, used for lazy init.
public boolean	hasSessionName() PUBLIC: Return if a name of the session that the query should be executed under has been specified.
public void	ignoreBindAllParameters() PUBLIC: Session's shouldBindAllParameters() defines whether to bind or not (default setting)
public void	ignoreCacheStatement() PUBLIC: Session's shouldCacheAllStatements() defines whether to cache or not (default setting)
public boolean	isCallQuery() PUBLIC: Return true if this query uses SQL, a stored procedure, or SDK call.
public boolean	isCascadeOfAggregateDelete() INTERNAL: Returns true if this query has been created as the result of cascading a delete of an aggregate collection in a UnitOfWork CR 2811
public Boolean	isCustomQueryUsed() INTERNAL: PERF: Return if this query will use the descriptor custom query instead of executing itself.
protected boolean	isCustomSelectionQuery() INTERNAL: If the query mechanism is a call query mechanism and there are no arguments on the query then it must be a foreign reference custom selection query.
public boolean	isDataModifyQuery() PUBLIC: Return if this is a data modify query.
public boolean	isDataReadQuery() PUBLIC: Return if this is a data read query.
public boolean	isDefaultPropertiesQuery() INTERNAL: Return true if the query uses default properties.
public boolean	isDeleteAllQuery() PUBLIC: Return if this is a delete all query.
public boolean	isDeleteObjectQuery() PUBLIC: Return if this is a delete object query.
public boolean	isDirectReadQuery() PUBLIC: Return if this is a direct read query.
public boolean	isExecutionClone() INTERNAL: PERF: Return if the query is an execution clone.
public boolean	isExpressionQuery() PUBLIC: Return true if this query uses an expression query mechanism
public boolean	isInsertObjectQuery() PUBLIC: Return true if this is an insert object query.
public boolean	isJPQLCallQuery() PUBLIC: Return true if this query uses an JPQL query mechanism .
public boolean	isModifyAllQuery() PUBLIC: Return true if this is a modify all query.
public boolean	isModifyQuery() PUBLIC: Return true if this is a modify query.
public boolean	isNativeConnectionRequired() ADVANCED: Return if the descriptor requires usage of a native (unwrapped) JDBC connection.
public boolean	isObjectBuildingQuery() PUBLIC: Return if this is an object building query.
public boolean	isObjectLevelModifyQuery() PUBLIC: Return true if this is an object level modify query.
public boolean	isObjectLevelReadQuery() PUBLIC: Return true if this is an object level read query.
public boolean	isPrepared() INTERNAL: Queries are prepared when they are executed and then do not need to be prepared on subsequent executions.
public boolean	isReadAllQuery() PUBLIC: Return true if this is a read all query.
public boolean	isReadObjectQuery() PUBLIC: Return true if this is a read object query.
public boolean	isReadQuery() PUBLIC: Return true if this is a read query.
public boolean	isReportQuery() PUBLIC: Return true if this is a report query.
public boolean	isResultSetMappingQuery() PUBLIC: Return true if this is a result set mapping query.
public boolean	isSQLCallQuery() PUBLIC: Return true if this query uses an SQL query mechanism .
public boolean	isUpdateAllQuery() PUBLIC: Return true if this is an update all query.
public boolean	isUpdateObjectQuery() PUBLIC: Return true if this is an update object query.
public boolean	isUserDefined() INTERNAL: Return true if the query is a custom user defined query.
public boolean	isUserDefinedSQLCall() INTERNAL: Return true if the query is a custom user defined SQL call query.
public boolean	isValueReadQuery() PUBLIC: Return if this is a value read query.
public boolean	isWriteObjectQuery() PUBLIC: Return true if this is a write object query.
public void	maintainCache() PUBLIC: Set for the identity map (cache) to be maintained.
protected void	prepare() INTERNAL: This is different from 'prepareForExecution' in that this is called on the original query, and the other is called on the copy of the query.
public void	prepareCall(Session session, DataRecord translationRow) ADVANCED: Pre-generate the call/SQL for the query.
protected void	prepareCustomQuery(DatabaseQuery customQuery) INTERNAL: Set the properties needed to be cascaded into the custom query.
public void	prepareForExecution() INTERNAL: Prepare the receiver for execution in a session.
protected void	prepareForRemoteExecution()
public void	prepareFromQuery(DatabaseQuery query) INTERNAL: Prepare the query from the prepared query.
public void	prepareInternal(AbstractSession session) INTERNAL: Call the prepare on the query.
public Object	redirectQuery(QueryRedirector redirector, DatabaseQuery queryToRedirect, AbstractSession session, AbstractRecord translationRow) INTERNAL: Use a EclipseLink redirector to redirect this query to a method.
protected Object	remoteExecute()
public Object	remoteExecute(AbstractSession session) INTERNAL:
public void	removeProperty(Object property) INTERNAL: Property support used by mappings.
public Map<K, V>	replaceValueHoldersIn(Object object, RemoteSessionController controller) INTERNAL: replace the value holders in the specified result object(s)
public void	resetMonitorName() INTERNAL: Return the name to use for the query in performance monitoring.
public void	retrieveBypassCache() ADVANCED: JPA flag used to control the behavior of the shared cache.
public AbstractRecord	rowFromArguments(List<E> argumentValues, AbstractSession session) INTERNAL: Translate argumentValues into a database row.
public void	setAccessor(Accessor accessor) INTERNAL: Set the accessor, the query must always use the same accessor for database access.
public void	setAccessors(Collection<Accessor> accessors) INTERNAL: Set the list of connection accessors to execute the query on.
public void	setAllowNativeSQLQuery(Boolean allowNativeSQLQuery) INTERNAL: Set to true if this individual query should be marked to bypass a persistence unit level disallow SQL queries flag.
public void	setArguments(List<String> arguments) INTERNAL: Set the arguments for use with the pre-defined query option.
public void	setArgumentTypeNames(List<String> argumentTypeNames) INTERNAL: Set the argumentTypes for use with the pre-defined query option
public void	setArgumentTypes(List<Class<?>> argumentTypes) INTERNAL: Set the argumentTypes for use with the pre-defined query option
public void	setArgumentValues(List<Object> theArgumentValues) INTERNAL: Set the argumentValues for use with argumented queries.
public void	setBatchObjects(Map<Object, Object> batchObjects) INTERNAL: Set temporary map of batched objects.
public void	setCall(Call call) PUBLIC: Used to define a store procedure or SQL query.
public void	setCascadePolicy(int policyConstant) INTERNAL: Set the cascade policy.
public void	setDatasourceCall(Call call) PUBLIC: Used to define a store procedure or SQL query.
public void	setDescriptor(ClassDescriptor descriptor) INTERNAL: Set the descriptor for the query.
public void	setDoNotRedirect(boolean doNotRedirect) This method is used in combination with redirected queries.
public void	setEJBQLString(String ejbqlString) PUBLIC: Set the EJBQL string of the query.
protected void	setExecutionSession(AbstractSession executionSession) INTERNAL: Set the execution session.
public void	setFlushOnExecute(Boolean flushMode) PUBLIC: If executed against a RepeatableWriteUnitOfWork if this attribute is true EclipseLink will write changes to the database before executing the query.
public void	setHintString(String the hint string to be added into the SQL call. newHintString) Used to set a database hint string on the query.
protected void	setIsCustomQueryUsed(final boolean Custom query flag as `boolean`. isCustomQueryUsed) INTERNAL: PERF: Set if this query will use the descriptor custom query instead of executing itself.
public void	setIsExecutionClone(boolean isExecutionClone) INTERNAL: PERF: Set if the query is an execution clone.
public void	setIsNativeConnectionRequired(boolean isNativeConnectionRequired) ADVANCED: Set if the descriptor requires usage of a native (unwrapped) JDBC connection.
public void	setIsPrepared(boolean isPrepared) INTERNAL: If changes are made to the query that affect the derived SQL or Call parameters the query needs to be prepared again.
public void	setIsUserDefined(boolean isUserDefined) INTERNAL: Set if the query is a custom user defined query.
public void	setIsUserDefinedSQLCall(boolean isUserDefinedSQLCall) INTERNAL: Set if the query is a custom user defined sql call query.
public void	setJPQLString(String jpqlString) PUBLIC: Set the JPQL string of the query.
public void	setName(String queryName) PUBLIC: Set the query's name.
public void	setNullableArguments(List<DatabaseField> nullableArguments) INTERNAL: Set the list of arguments to check for null.
public void	setParameterDelimiter(String aParameterDelimiter) INTERNAL: Set the String char used to delimit an SQL parameter.
public void	setPartitioningPolicy(PartitioningPolicy partitioningPolicy) PUBLIC: Set the query's partitioning policy.
public void	setProperties(Map<Object, Object> properties) INTERNAL: Property support used by mappings.
public synchronized void	setProperty(Object property, Object value) INTERNAL: Property support used by mappings to store temporary stuff.
protected void	setQueryMechanism(DatabaseQueryMechanism queryMechanism) Set the query mechanism for the query.
public void	setQueryTimeout(int queryTimeout) PUBLIC: Set the number of seconds the driver will wait for a Statement to execute to the given number of seconds.
public void	setQueryTimeoutUnit(TimeUnit queryTimeoutUnit)
public void	setRedirector(QueryRedirector redirector) PUBLIC: Set the query redirector.
public void	setSelectionCriteria(Expression expression) PUBLIC: To any user of this object.
public void	setSession(AbstractSession session) INTERNAL: Set the session for the query
public void	setSessionName(String sessionName) PUBLIC: Set the name of the session that the query should be executed under.
public void	setShouldBindAllParameters(boolean shouldBindAllParameters) PUBLIC: Bind all arguments to any SQL statement.
public void	setShouldBindAllParameters(Boolean bindAllParams) INTERNAL: Sets the internal tri-state value of shouldBindAllParams Used to cascade this value to other queries
public void	setShouldCacheStatement(boolean shouldCacheStatement) PUBLIC: Cache the prepared statements, this requires full parameter binding as well.
public void	setShouldMaintainCache(boolean shouldMaintainCache) PUBLIC: Set if the identity map (cache) should be used or not.
public void	setShouldPrepare(boolean shouldPrepare) PUBLIC: Set if the query should be prepared.
public void	setShouldRetrieveBypassCache(boolean shouldRetrieveBypassCache) ADVANCED: JPA flag used to control the behavior of the shared cache.
public void	setShouldReturnGeneratedKeys(boolean shouldReturnGeneratedKeys) ADVANCED: JPA flag used to control the behavior of IDENTITY generation.
public void	setShouldStoreBypassCache(boolean shouldStoreBypassCache) ADVANCED: JPA flag used to control the behavior of the shared cache.
public void	setShouldUseWrapperPolicy(boolean shouldUseWrapperPolicy) ADVANCED: The wrapper policy can be enable on a query.
public void	setShouldValidateUpdateCallCacheUse(boolean shouldCheckUpdateCallCacheUse) INTERNAL: Set if additional validation should be performed before the query uses the update call cache.
public void	setSourceMapping(DatabaseMapping sourceMapping) INTERNAL:
public void	setSQLStatement(SQLStatement sqlStatement) PUBLIC: To any user of this object.
public void	setSQLString(String sqlString) PUBLIC: To any user of this object.
public void	setTranslationRow(AbstractRecord translationRow) INTERNAL: Set the row for translation
public boolean	shouldAllowNativeSQLQuery(boolean projectAllowsNativeQueries) INTERNAL: Return true if this individual query should allow native a SQL call to be issued.
public boolean	shouldBindAllParameters() PUBLIC: Bind all arguments to any SQL statement.
public boolean	shouldCacheStatement() PUBLIC: Cache the prepared statements, this requires full parameter binding as well.
public boolean	shouldCascadeAllParts() PUBLIC: Flag used to determine if all parts should be cascaded
public boolean	shouldCascadeByMapping() PUBLIC: Mappings should be checked to determined if the current operation should be cascaded to the objects referenced.
public boolean	shouldCascadeOnlyDependentParts() INTERNAL: Flag used for unit of works cascade policy.
public boolean	shouldCascadeParts() PUBLIC: Flag used to determine if any parts should be cascaded
public boolean	shouldCascadePrivateParts() PUBLIC: Flag used to determine if any private parts should be cascaded
public boolean	shouldCloneCall() INTERNAL: Flag used to determine if the call needs to be cloned.
public boolean	shouldIgnoreBindAllParameters() PUBLIC: Local shouldBindAllParameters() should be ignored, Session's shouldBindAllParameters() should be used.
public boolean	shouldIgnoreCacheStatement() PUBLIC: Local shouldCacheStatement() should be ignored, Session's shouldCacheAllStatements() should be used.
public boolean	shouldMaintainCache() PUBLIC: Return if the identity map (cache) should be used or not.
public boolean	shouldPrepare() PUBLIC: Return if the query should be prepared.
public boolean	shouldPrepare(AbstractRecord translationRow, AbstractSession session) INTERNAL: Check if the query should be prepared, or dynamic, depending on the arguments.
public boolean	shouldRetrieveBypassCache() ADVANCED: JPA flag used to control the behavior of the shared cache.
public boolean	shouldReturnGeneratedKeys() ADVANCED: JPA flag used to control the behavior of IDENTITY generation.
public boolean	shouldStoreBypassCache() ADVANCED: JPA flag used to control the behavior of the shared cache.
public boolean	shouldUseWrapperPolicy() ADVANCED: The wrapper policy can be enabled on a query.
public boolean	shouldValidateUpdateCallCacheUse() ADVANCED: Return true if additional validation should be performed before the query uses the update call cache, false otherwise.
public void	storeBypassCache() ADVANCED: JPA flag used to control the behavior of the shared cache.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll wait wait wait

public abstract Class DatabaseQuery

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary