Top Description Fields Constructors Methods
org.eclipse.persistence.queries

public Class InMemoryQueryIndirectionPolicy

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable

Purpose: Provide a means of controlling the behavior of in-memory and conforming queries that access un-instantiated indirection objects in processing the query against cached objects.

Description: This class defines the valid constant values for handling in-memory querying. The constants should be set into the query's inMemoryQueryIndirectionPolicy.

Author
Gordon Yorke
Since
TopLink/Java 3.6.3

Field Summary

Modifier and TypeField and Description
protected int
protected ObjectLevelReadQuery
query

Used to set the policy state in the query.

public static final int
SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED

If a non-instantiated indirection object is encountered the object is assumed to conform.

public static final int
SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED

If a non-instantiated indirection object is encountered the object is assumed to not conform.

public static final int
SHOULD_THROW_INDIRECTION_EXCEPTION

If a non-instantiated indirection object is encountered an exception is thrown.

public static final int
SHOULD_TRIGGER_INDIRECTION

If a non-instantiated indirection object is encountered an exception it is instantiated.

Constructor Summary

AccessConstructor and Description
public
public
public

Method Summary

Modifier and TypeMethod and Description
public int
public ObjectLevelReadQuery
getQuery()

INTERNAL: Return the query.

public void
public void
public void
setPolicy(int policy)

public void
setQuery(ObjectLevelReadQuery query)

INTERNAL: Set the query.

public boolean
public boolean
public boolean
public boolean
public void
public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

policyback to summary
protected int policy
queryback to summary
protected ObjectLevelReadQuery query

Used to set the policy state in the query.

SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMEDback to summary
public static final int SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED

If a non-instantiated indirection object is encountered the object is assumed to conform.

SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMEDback to summary
public static final int SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED

If a non-instantiated indirection object is encountered the object is assumed to not conform.

SHOULD_THROW_INDIRECTION_EXCEPTIONback to summary
public static final int SHOULD_THROW_INDIRECTION_EXCEPTION

If a non-instantiated indirection object is encountered an exception is thrown.

SHOULD_TRIGGER_INDIRECTIONback to summary
public static final int SHOULD_TRIGGER_INDIRECTION

If a non-instantiated indirection object is encountered an exception it is instantiated. Caution should be used in using this option.

Constructor Detail

InMemoryQueryIndirectionPolicyback to summary
public InMemoryQueryIndirectionPolicy()
InMemoryQueryIndirectionPolicyback to summary
public InMemoryQueryIndirectionPolicy(int policyValue)
InMemoryQueryIndirectionPolicyback to summary
public InMemoryQueryIndirectionPolicy(int policy, ObjectLevelReadQuery query)

Method Detail

getPolicyback to summary
public int getPolicy()
getQueryback to summary
public ObjectLevelReadQuery getQuery()

INTERNAL: Return the query.

ignoreIndirectionExceptionReturnConformedback to summary
public void ignoreIndirectionExceptionReturnConformed()
ignoreIndirectionExceptionReturnNotConformedback to summary
public void ignoreIndirectionExceptionReturnNotConformed()
setPolicyback to summary
public void setPolicy(int policy)
setQueryback to summary
public void setQuery(ObjectLevelReadQuery query)

INTERNAL: Set the query.

shouldIgnoreIndirectionExceptionReturnConformedback to summary
public boolean shouldIgnoreIndirectionExceptionReturnConformed()
shouldIgnoreIndirectionExceptionReturnNotConformedback to summary
public boolean shouldIgnoreIndirectionExceptionReturnNotConformed()
shouldThrowIndirectionExceptionback to summary
public boolean shouldThrowIndirectionException()
shouldTriggerIndirectionback to summary
public boolean shouldTriggerIndirection()
throwIndirectionExceptionback to summary
public void throwIndirectionException()
triggerIndirectionback to summary
public void triggerIndirection()