Class InMemoryQueryIndirectionPolicy

  • All Implemented Interfaces:
    java.io.Serializable

    public class InMemoryQueryIndirectionPolicy
    extends java.lang.Object
    implements 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.

    See Also:
    Serialized Form
    Author:
    Gordon Yorke
    Since:
    TopLink/Java 3.6.3
    • Field Detail

      • SHOULD_THROW_INDIRECTION_EXCEPTION

        public static final int SHOULD_THROW_INDIRECTION_EXCEPTION
        If a non-instantiated indirection object is encountered an exception is thrown.
        See Also:
        Constant Field Values
      • SHOULD_TRIGGER_INDIRECTION

        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.
        See Also:
        Constant Field Values
      • SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED

        public static final int SHOULD_IGNORE_EXCEPTION_RETURN_CONFORMED
        If a non-instantiated indirection object is encountered the object is assumed to conform.
        See Also:
        Constant Field Values
      • SHOULD_IGNORE_EXCEPTION_RETURN_NOT_CONFORMED

        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.
        See Also:
        Constant Field Values
      • policy

        protected int policy
    • Constructor Detail

      • InMemoryQueryIndirectionPolicy

        public InMemoryQueryIndirectionPolicy()
      • InMemoryQueryIndirectionPolicy

        public InMemoryQueryIndirectionPolicy​(int policyValue)
      • InMemoryQueryIndirectionPolicy

        public InMemoryQueryIndirectionPolicy​(int policy,
                                              ObjectLevelReadQuery query)
    • Method Detail

      • shouldTriggerIndirection

        public boolean shouldTriggerIndirection()
      • shouldThrowIndirectionException

        public boolean shouldThrowIndirectionException()
      • shouldIgnoreIndirectionExceptionReturnConformed

        public boolean shouldIgnoreIndirectionExceptionReturnConformed()
      • shouldIgnoreIndirectionExceptionReturnNotConformed

        public boolean shouldIgnoreIndirectionExceptionReturnNotConformed()
      • ignoreIndirectionExceptionReturnNotConformed

        public void ignoreIndirectionExceptionReturnNotConformed()
      • ignoreIndirectionExceptionReturnConformed

        public void ignoreIndirectionExceptionReturnConformed()
      • triggerIndirection

        public void triggerIndirection()
      • throwIndirectionException

        public void throwIndirectionException()
      • getPolicy

        public int getPolicy()
      • setPolicy

        public void setPolicy​(int policy)