Package org.apache.openjpa.persistence

Interface OpenJPAQuery<X>

All Superinterfaces:
jakarta.persistence.Query, jakarta.persistence.TypedQuery<X>
All Known Subinterfaces:
OpenJPAQuerySPI<X>
All Known Implementing Classes:
AbstractQuery, QueryImpl
public interface OpenJPAQuery<X> extends jakarta.persistence.TypedQuery<X>
Interface implemented by OpenJPA queries.
Since:
0.4.0
Author:
Abe White

  • Field Details

  • Method Details

    • getEntityManager

      OpenJPAEntityManager getEntityManager()
      The owning entity manager.

    • getLanguage

      String getLanguage()
      Query language.

    • getOperation

      QueryOperationType getOperation()
      Query operation type.

    • getFetchPlan

      FetchPlan getFetchPlan()
      Fetch plan for controlling the loading of results.

    • getQueryString

      String getQueryString()
      Query string.

    • getIgnoreChanges

      boolean getIgnoreChanges()
      Whether to ignore changes in the current transaction.

    • setIgnoreChanges

      OpenJPAQuery<X> setIgnoreChanges(boolean ignore)
      Whether to ignore changes in the current transaction.

    • getCandidateCollection

      Collection getCandidateCollection()
      Return the candidate collection, or null if an extent was specified instead of a collection.

    • setCandidateCollection

      OpenJPAQuery<X> setCandidateCollection(Collection coll)
      Set a collection of candidates.

    • getResultClass

      Class getResultClass()
      Query result element type.

    • setResultClass

      OpenJPAQuery<X> setResultClass(Class type)
      Query result element type.

    • hasSubclasses

      boolean hasSubclasses()
      Whether subclasses are included in the query results.

    • setSubclasses

      OpenJPAQuery<X> setSubclasses(boolean subs)
      Whether subclasses are included in the query results.

    • getFirstResult

      int getFirstResult()
      Return the 0-based start index for the returned results.
      Specified by:
      getFirstResult in interface jakarta.persistence.Query

    • getMaxResults

      int getMaxResults()
      Return the maximum number of results to retrieve. or Integer.MAX_VALUE for no limit.
      Specified by:
      getMaxResults in interface jakarta.persistence.Query

    • compile

      OpenJPAQuery<X> compile()
      Compile the query.

    • hasPositionalParameters

      boolean hasPositionalParameters()
      Whether this query has positional parameters.

    • getPositionalParameters

      Object[] getPositionalParameters()
      The positional parameters for the query; empty array if none or if query uses named parameters.

    • getNamedParameters

      Map<String,Object> getNamedParameters()
      The named parameters for the query; empty map if none or if query uses positional parameters.

    • setParameters

      OpenJPAQuery<X> setParameters(Map params)
      Set parameters.

    • setParameters

      OpenJPAQuery<X> setParameters(Object... params)
      Set parameters.

    • closeAll

      OpenJPAQuery<X> closeAll()
      Close all open query results.

    • getDataStoreActions

      String[] getDataStoreActions(Map params)
      Returns a description of the commands that will be sent to the datastore in order to execute this query. This will typically be in the native query language of the database (e.g., SQL).
      Parameters:
      params - the named parameter map for the query invocation

    • setMaxResults

      OpenJPAQuery<X> setMaxResults(int maxResult)
      Specified by:
      setMaxResults in interface jakarta.persistence.Query
      Specified by:
      setMaxResults in interface jakarta.persistence.TypedQuery<X>

    • setFirstResult

      OpenJPAQuery<X> setFirstResult(int startPosition)
      Specified by:
      setFirstResult in interface jakarta.persistence.Query
      Specified by:
      setFirstResult in interface jakarta.persistence.TypedQuery<X>

    • setHint

      OpenJPAQuery<X> setHint(String hintName, Object value)
      Specified by:
      setHint in interface jakarta.persistence.Query
      Specified by:
      setHint in interface jakarta.persistence.TypedQuery<X>

    • setParameter

      OpenJPAQuery<X> setParameter(String name, Object value)
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • setParameter

      OpenJPAQuery<X> setParameter(String name, Date value, jakarta.persistence.TemporalType temporalType)
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • setParameter

      OpenJPAQuery<X> setParameter(String name, Calendar value, jakarta.persistence.TemporalType temporalType)
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • setParameter

      OpenJPAQuery<X> setParameter(int position, Object value)
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • setParameter

      OpenJPAQuery<X> setParameter(int position, Date value, jakarta.persistence.TemporalType temporalType)
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • setParameter

      OpenJPAQuery<X> setParameter(int position, Calendar value, jakarta.persistence.TemporalType temporalType)
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • setRelaxBindParameterTypeChecking

      void setRelaxBindParameterTypeChecking(Object hint)
      Sets whether the type of user-supplied bind parameter value and the type of target persistent property they bind to are checked with strong or weak constraint.
      The same can be set via hint without puncturing standard JPA API.
      Parameters:
      hint - a String or Boolean value.
      See Also:

    • getRelaxBindParameterTypeChecking

      boolean getRelaxBindParameterTypeChecking()
      Gets whether the type of user-supplied bind parameter value and the type of target persistent property they bind to are checked with strong or weak constraint.
      Returns:
      the booelan state. False by default, i.e. the type of a bind parameter value is checked strongly against the target property type.

    • setFlushMode

      OpenJPAQuery<X> setFlushMode(jakarta.persistence.FlushModeType flushMode)
      Specified by:
      setFlushMode in interface jakarta.persistence.Query
      Specified by:
      setFlushMode in interface jakarta.persistence.TypedQuery<X>

    • getFlushMode

      jakarta.persistence.FlushModeType getFlushMode()
      Return the current flush mode.
      Specified by:
      getFlushMode in interface jakarta.persistence.Query

    • addFilterListener

      @Deprecated OpenJPAQuery<X> addFilterListener(FilterListener listener)
      Deprecated.
      cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.

    • removeFilterListener

      @Deprecated OpenJPAQuery<X> removeFilterListener(FilterListener listener)
      Deprecated.
      cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.

    • addAggregateListener

      @Deprecated OpenJPAQuery<X> addAggregateListener(AggregateListener listener)
      Deprecated.
      cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.

    • removeAggregateListener

      @Deprecated OpenJPAQuery<X> removeAggregateListener(AggregateListener listener)
      Deprecated.
      cast to QueryImpl instead. This method pierces the published-API boundary, as does the SPI cast.

    • getSupportedHints

      Set<String> getSupportedHints()
      Gets hints supported by this query.
      Since:
      2.0.0