Package org.apache.openjpa.persistence

Class AbstractQuery<X>

java.lang.Object
org.apache.openjpa.persistence.AbstractQuery<X>
All Implemented Interfaces:
jakarta.persistence.Query, jakarta.persistence.TypedQuery<X>, OpenJPAQuery<X>, OpenJPAQuerySPI<X>
Direct Known Subclasses:
QueryImpl
public abstract class AbstractQuery<X> extends Object implements OpenJPAQuerySPI<X>
An abstract implementation of the Query interface.

  • Field Details

    • _relaxBindParameterTypeChecking

      protected boolean _relaxBindParameterTypeChecking

    • _convertPositionalParams

      protected boolean _convertPositionalParams

    • _qmd

      protected final QueryMetaData _qmd

    • _em

      protected transient EntityManagerImpl _em

    • _boundParams

      protected Map<jakarta.persistence.Parameter<?>,Object> _boundParams

    • _declaredParams

      protected Map<Object,jakarta.persistence.Parameter<?>> _declaredParams

  • Constructor Details

  • Method Details

    • isProcedure

      public boolean isProcedure()

    • isNative

      public boolean isNative()

    • assertOpen

      protected abstract void assertOpen()

    • lock

      protected abstract void lock()

    • unlock

      protected abstract void unlock()

    • getParamTypes

      protected abstract OrderedMap<Object,Class<?>> getParamTypes()
      Returns:
      a map of parameter name to type for this query.

    • setParameter

      public OpenJPAQuery<X> setParameter(int pos, Object value)
      Binds the parameter identified by the given position to the given value. The parameter are bound to a value in the context of this query. The same parameter may be bound to a different value in the context of another query.
      For non-native queries, the given position must be a valid position in the declared parameters.
      As native queries may not be parsed and hence their declared parameters may not be known, setting an positional parameter has the side-effect of a positional parameter being declared.
      Specified by:
      setParameter in interface OpenJPAQuery<X>
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>
      Parameters:
      position - positive, integer position of the parameter
      value - an assignment compatible value
      Returns:
      the same query instance
      Throws:
      IllegalArgumentException - if position does not correspond to a positional parameter of the query or if the argument is of incorrect type

    • setParameter

      public OpenJPAQuery<X> setParameter(int position, Calendar value, jakarta.persistence.TemporalType t)
      Sets the value of the given positional parameter after conversion of the given value to the given Temporal Type.
      Specified by:
      setParameter in interface OpenJPAQuery<X>
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • setParameter

      public OpenJPAQuery<X> setParameter(int position, Date value, jakarta.persistence.TemporalType type)
      Sets the value of the given named parameter after conversion of the given value to the given Temporal Type.
      Specified by:
      setParameter in interface OpenJPAQuery<X>
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • hasPositionalParameters

      public boolean hasPositionalParameters()
      Affirms if declared parameters use position identifier.
      Specified by:
      hasPositionalParameters in interface OpenJPAQuery<X>

    • getPositionalParameters

      public Object[] getPositionalParameters()
      Gets the array of positional parameter values. The n-th array element represents (n+1)-th positional parameter. If a parameter has been declared but not bound to a value then the value is null and hence is indistinguishable from the value being actually null. If the parameter indexing is not contiguous then the unspecified parameters are considered as null.
      Specified by:
      getPositionalParameters in interface OpenJPAQuery<X>

    • setParameters

      public OpenJPAQuery<X> setParameters(Object... params)
      Binds the given values as positional parameters. The n-th array element value is set to a Parameter with (n+1)-th positional identifier.
      Specified by:
      setParameters in interface OpenJPAQuery<X>

    • getNamedParameters

      public Map<String,Object> getNamedParameters()
      Gets the value of all the named parameters. If a parameter has been declared but not bound to a value then the value is null and hence is indistinguishable from the value being actually null.
      Specified by:
      getNamedParameters in interface OpenJPAQuery<X>

    • setParameters

      public OpenJPAQuery<X> setParameters(Map params)
      Sets the values of the parameters from the given Map. The keys of the given map designate the name of the declared parameter.
      Specified by:
      setParameters in interface OpenJPAQuery<X>

    • getParameter

      public <T> jakarta.persistence.Parameter<T> getParameter(String name, Class<T> type)
      Get the parameter of the given name and type.
      Specified by:
      getParameter in interface jakarta.persistence.Query
      Throws:
      IllegalArgumentException - if the parameter of the specified name does not exist or is not assignable to the type
      IllegalStateException - if invoked on a native query

    • getParameter

      public <T> jakarta.persistence.Parameter<T> getParameter(int pos, Class<T> type)
      Get the positional parameter with the given position and type.
      Specified by:
      getParameter in interface jakarta.persistence.Query
      Throws:
      IllegalArgumentException - if the parameter with the specified position does not exist or is not assignable to the type
      IllegalStateException - if invoked on a native query unless the same parameter position is bound already.

    • getParameterValue

      public <T> T getParameterValue(jakarta.persistence.Parameter<T> p)
      Return the value bound to the parameter.
      Specified by:
      getParameterValue in interface jakarta.persistence.Query
      Parameters:
      param - parameter object
      Returns:
      parameter value
      Throws:
      IllegalStateException - if the parameter has not been been bound
      IllegalArgumentException - if the parameter does not belong to this query

    • getParameters

      public Set<jakarta.persistence.Parameter<?>> getParameters()
      Gets the parameters declared in this query.
      Specified by:
      getParameters in interface jakarta.persistence.Query

    • setParameter

      public <T> OpenJPAQuery<X> setParameter(jakarta.persistence.Parameter<T> p, T arg1)
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • setParameter

      public OpenJPAQuery<X> setParameter(jakarta.persistence.Parameter<Date> p, Date date, jakarta.persistence.TemporalType type)
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • setParameter

      public jakarta.persistence.TypedQuery<X> setParameter(jakarta.persistence.Parameter<Calendar> p, Calendar cal, jakarta.persistence.TemporalType type)
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • getParameter

      public jakarta.persistence.Parameter<?> getParameter(String name)
      Get the parameter object corresponding to the declared parameter of the given name. This method is not required to be supported for native queries.
      Specified by:
      getParameter in interface jakarta.persistence.Query
      Throws:
      IllegalArgumentException - if the parameter of the specified name does not exist
      IllegalStateException - if invoked on a native query

    • getParameter

      public jakarta.persistence.Parameter<?> getParameter(int pos)
      Get the positional parameter with the given position. The parameter may just have been declared and not bound to a value.
      Specified by:
      getParameter in interface jakarta.persistence.Query
      Parameters:
      position - specified in the user query.
      Returns:
      parameter object
      Throws:
      IllegalArgumentException - if the parameter with the given position does not exist

    • getParameterValue

      public Object getParameterValue(String name)
      Return the value bound to the parameter.
      Specified by:
      getParameterValue in interface jakarta.persistence.Query
      Parameters:
      name - name of the parameter
      Returns:
      parameter value
      Throws:
      IllegalStateException - if this parameter has not been bound

    • getParameterValue

      public Object getParameterValue(int pos)
      Return the value bound to the parameter.
      Specified by:
      getParameterValue in interface jakarta.persistence.Query
      Parameters:
      pos - position of the parameter
      Returns:
      parameter value
      Throws:
      IllegalStateException - if this parameter has not been bound

    • getBoundParameterKeys

      public Set<?> getBoundParameterKeys()
      Gets the parameter keys bound with this query. Parameter key can be Integer, String or a ParameterExpression itself but all parameters keys of a particular query are of the same type.

    • getDeclaredParameterKeys

      public Set<?> getDeclaredParameterKeys()
      Gets the declared parameter keys in the given query. This information is only available after the query has been parsed. As native language queries are not parsed, this information is not available for them.
      Returns:
      set of parameter identifiers in a parsed query

    • getDeclaredParameterKeys

      public <T> Set<T> getDeclaredParameterKeys(Class<T> keyType)

    • getDeclaredParameters

      public Map<Object,jakarta.persistence.Parameter<?>> getDeclaredParameters()
      Gets the parameter instances declared in this query. All parameter keys are of the same type. It is not allowed to mix keys of different type such as named and positional keys. For string-based queries, the parser supplies the information about the declared parameters as a LinkedMap of expected parameter value type indexed by parameter identifier. For non string-based queries that a facade itself may construct (e.g. CriteriaQuery), the parameters must be declared by the caller. This receiver constructs concrete Parameter instances from the given parameter identifiers.
      Returns:
      a Map where the key represents the original identifier of the parameter (can be a String, Integer or a ParameterExpression itself) and the value is the concrete Parameter instance either constructed as a result of this call or supplied by declaring the parameter explicitly via #declareParameter(Parameter).

    • declareParameter

      public void declareParameter(Object key, jakarta.persistence.Parameter<?> param)
      Declares the given parameter for this query. Used by non-string based queries that are constructed by the facade itself rather than OpenJPA parsing the query to detect the declared parameters.
      Parameters:
      key - this is the key to identify the parameter later in the context of this query. Valid key types are Integer, String or ParameterExpression itself.
      the - parameter instance to be declared

    • isBound

      public boolean isBound(jakarta.persistence.Parameter<?> param)
      Affirms if the given parameter is bound to a value for this query.
      Specified by:
      isBound in interface jakarta.persistence.Query

    • setParameter

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

    • setParameter

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

    • setParameter

      public OpenJPAQuery<X> setParameter(String name, Object value)
      Sets the parameter of the given name to the given value.
      Specified by:
      setParameter in interface OpenJPAQuery<X>
      Specified by:
      setParameter in interface jakarta.persistence.Query
      Specified by:
      setParameter in interface jakarta.persistence.TypedQuery<X>

    • getRelaxBindParameterTypeChecking

      public boolean getRelaxBindParameterTypeChecking()
      Description copied from interface: OpenJPAQuery
      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.
      Specified by:
      getRelaxBindParameterTypeChecking in interface OpenJPAQuery<X>
      Returns:
      the booelan state. False by default, i.e. the type of a bind parameter value is checked strongly against the target property type.

    • setRelaxBindParameterTypeChecking

      public void setRelaxBindParameterTypeChecking(Object value)
      Description copied from interface: OpenJPAQuery
      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.
      Specified by:
      setRelaxBindParameterTypeChecking in interface OpenJPAQuery<X>
      Parameters:
      value - a String or Boolean value.
      See Also: