Package org.eclipse.persistence.queries

Class InMemoryQueryIndirectionPolicy

java.lang.Object
org.eclipse.persistence.queries.InMemoryQueryIndirectionPolicy
All Implemented Interfaces:
Serializable
public class InMemoryQueryIndirectionPolicy extends Object implements 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:
Author:
Gordon Yorke

  • Field Details

    • 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:

    • 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:

    • 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:

    • 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:

    • policy

      protected int policy

    • query

      protected ObjectLevelReadQuery query
      Used to set the policy state in the query.

  • Constructor Details

    • InMemoryQueryIndirectionPolicy

      public InMemoryQueryIndirectionPolicy()

    • InMemoryQueryIndirectionPolicy

      public InMemoryQueryIndirectionPolicy(int policyValue)

    • InMemoryQueryIndirectionPolicy

      public InMemoryQueryIndirectionPolicy(int policy, ObjectLevelReadQuery query)

  • Method Details

    • 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)

    • getQuery

      public ObjectLevelReadQuery getQuery()
      INTERNAL: Return the query.

    • setQuery

      public void setQuery(ObjectLevelReadQuery query)
      INTERNAL: Set the query.