Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Type QueryRedirectors

  • @Target(TYPE)
@Retention(RUNTIME)
public @interface QueryRedirectors
    Redirectors allow EclipseLink queries to be intercepted and pre/post processed or redirected. They provide opportunities to extend query functionality beyond standard EclipseLink support.
    See Also:
    QueryRedirector
    Author:
    Gordon Yorke
    Since:
    EclipseLink 1.0

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      Class<?> allQueries
      This AllQueries Query Redirector will be applied to any executing object query that does not have a more precise redirector (like the ReadObjectQuery Redirector) or a redirector set directly on the query.
      Class<?> delete
      A Default Delete Object Query Redirector will be applied to any executing DeleteObjectQuery or DeleteAllQuery that does not have a redirector set directly on the query.
      Class<?> insert
      A Default Insert Query Redirector will be applied to any executing InsertObjectQuery that does not have a redirector set directly on the query.
      Class<?> readAll
      A Default ReadAll Query Redirector will be applied to any executing ReadAllQuery that does not have a redirector set directly on the query.
      Class<?> readObject
      A Default ReadObject Query Redirector will be applied to any executing ReadObjectQuery that does not have a redirector set directly on the query.
      Class<?> report
      A Default ReportQuery Redirector will be applied to any executing ReportQuery that does not have a redirector set directly on the query.
      Class<?> update
      A Default Update Query Redirector will be applied to any executing UpdateObjectQuery or UpdateAllQuery that does not have a redirector set directly on the query.

    • Element Detail

      • allQueries

        Class<?> allQueries
        This AllQueries Query Redirector will be applied to any executing object query that does not have a more precise redirector (like the ReadObjectQuery Redirector) or a redirector set directly on the query. Query redirectors allow the user to intercept query execution preventing it or alternately performing some side effect like auditing.
        Default:
        void.class

      • readAll

        Class<?> readAll
        A Default ReadAll Query Redirector will be applied to any executing ReadAllQuery that does not have a redirector set directly on the query. Query redirectors allow the user to intercept query execution preventing it or alternately performing some side effect like auditing. For users executing a JPA Query through the getResultList() API this is the redirector that will be invoked
        Default:
        void.class

      • readObject

        Class<?> readObject
        A Default ReadObject Query Redirector will be applied to any executing ReadObjectQuery that does not have a redirector set directly on the query. Query redirectors allow the user to intercept query execution preventing it or alternately performing some side effect like auditing. For users executing a JPA Query through the getSingleResult() API or EntityManager.find() this is the redirector that will be invoked
        Default:
        void.class

      • report

        Class<?> report
        A Default ReportQuery Redirector will be applied to any executing ReportQuery that does not have a redirector set directly on the query. Query redirectors allow the user to intercept query execution preventing it or alternately performing some side effect like auditing. For users executing a JPA Query that contains agregate functions or selects multiple entities this is the redirector that will be invoked
        Default:
        void.class

      • update

        Class<?> update
        A Default Update Query Redirector will be applied to any executing UpdateObjectQuery or UpdateAllQuery that does not have a redirector set directly on the query. In EclipseLink an UpdateObjectQuery is executed whenever flushing changes to the datasource. Query redirectors allow the user to intercept query execution preventing it or alternately performing some side effect like auditing.
        Default:
        void.class

      • insert

        Class<?> insert
        A Default Insert Query Redirector will be applied to any executing InsertObjectQuery that does not have a redirector set directly on the query. In EclipseLink an InsertObjectQuery is executed when persisting an object to the datasource. Query redirectors allow the user to intercept query execution preventing it or alternately performing some side effect like auditing.
        Default:
        void.class

      • delete

        Class<?> delete
        A Default Delete Object Query Redirector will be applied to any executing DeleteObjectQuery or DeleteAllQuery that does not have a redirector set directly on the query. Query redirectors allow the user to intercept query execution preventing it or alternately performing some side effect like auditing.
        Default:
        void.class