Package io.micronaut.data.model.query

Class DefaultQuery

java.lang.Object
io.micronaut.data.model.query.DefaultQuery
All Implemented Interfaces:
Criteria, QueryModel
Direct Known Subclasses:
AssociationQuery
public class DefaultQuery extends Object implements QueryModel
Models a query that can be executed against a data store.
Since:
1.0
Author:
Graeme Rocher

  • Constructor Details

    • DefaultQuery

      protected DefaultQuery(@NonNull PersistentEntity entity)
      Default constructor.
      Parameters:
      entity - The entity the query applies to.

  • Method Details

    • getJoinPaths

      public Collection<JoinPath> getJoinPaths()
      Specified by:
      getJoinPaths in interface QueryModel
      Returns:
      The join paths.

    • createQuery

      public AssociationQuery createQuery(String associationName)
      Creates an association query.
      Parameters:
      associationName - The assocation name
      Returns:
      The Query instance

    • getPersistentEntity

      @NonNull public PersistentEntity getPersistentEntity()
      Specified by:
      getPersistentEntity in interface QueryModel
      Returns:
      The entity the criteria applies to

    • getCriteria

      public QueryModel.Junction getCriteria()
      Specified by:
      getCriteria in interface QueryModel
      Returns:
      The criteria defined by this query

    • getProjections

      @NonNull public List<QueryModel.Projection> getProjections()
      Specified by:
      getProjections in interface QueryModel
      Returns:
      The projections that apply to this query.

    • getJoinPath

      public Optional<JoinPath> getJoinPath(String path)
      Obtain the joint for for a given association.
      Specified by:
      getJoinPath in interface QueryModel
      Parameters:
      path - The path to the association
      Returns:
      The join type

    • join

      public JoinPath join(@NonNull String path, @NonNull Join.Type joinType, String alias)
      Specifies whether a join query should be used (if join queries are supported by the underlying datastore).
      Specified by:
      join in interface QueryModel
      Parameters:
      path - The path
      joinType - The joinType
      alias - The alias
      Returns:
      The query

    • join

      @NonNull public JoinPath join(String path, Association association, @NonNull Join.Type joinType, @Nullable String alias)
      Description copied from interface: QueryModel
      Join on the given association.
      Specified by:
      join in interface QueryModel
      Parameters:
      path - The join path
      association - The association
      joinType - The join type
      alias - The alias to use.
      Returns:
      The query

    • projections

      public ProjectionList projections()
      Specified by:
      projections in interface QueryModel
      Returns:
      The projections for this query.

    • add

      @NonNull public QueryModel add(@NonNull QueryModel.Criterion criterion)
      Adds the specified criterion instance to the query.
      Specified by:
      add in interface QueryModel
      Parameters:
      criterion - The criterion instance
      Returns:
      This query

    • getEntity

      public PersistentEntity getEntity()
      Returns:
      The PersistentEntity being query

    • disjunction

      public QueryModel.Junction disjunction()
      Creates a disjunction (OR) query.
      Returns:
      The Junction instance

    • conjunction

      public QueryModel.Junction conjunction()
      Creates a conjunction (AND) query.
      Returns:
      The Junction instance

    • negation

      public QueryModel.Junction negation()
      Creates a negation of several criterion.
      Returns:
      The negation

    • max

      public DefaultQuery max(int max)
      Defines the maximum number of results to return.
      Specified by:
      max in interface QueryModel
      Parameters:
      max - The pageSize results
      Returns:
      This query instance

    • getMax

      public int getMax()
      Description copied from interface: QueryModel
      Get the pageSize results to return.
      Specified by:
      getMax in interface QueryModel
      Returns:
      The pageSize results

    • getOffset

      public long getOffset()
      Description copied from interface: QueryModel
      Get the offset of the query.
      Specified by:
      getOffset in interface QueryModel
      Returns:
      The offset

    • forUpdate

      public void forUpdate()
      Description copied from interface: QueryModel
      Lock the selected entities.
      Specified by:
      forUpdate in interface QueryModel

    • isForUpdate

      public boolean isForUpdate()
      Description copied from interface: QueryModel
      Whether to lock the selected entities.
      Specified by:
      isForUpdate in interface QueryModel
      Returns:
      true if the the selected entities should be locked

    • offset

      public DefaultQuery offset(long offset)
      Defines the offset (the first result index) of the query.
      Specified by:
      offset in interface QueryModel
      Parameters:
      offset - The offset
      Returns:
      This query instance

    • getSort

      public Sort getSort()
      Description copied from interface: QueryModel
      The sort to apply.
      Specified by:
      getSort in interface QueryModel
      Returns:
      The sort

    • sort

      @NonNull public QueryModel sort(@NonNull Sort sort)
      Description copied from interface: QueryModel
      Apply the given sort.
      Specified by:
      sort in interface QueryModel
      Parameters:
      sort - The sort to apply
      Returns:
      This query

    • eq

      @NonNull public DefaultQuery eq(@NonNull String property, @NonNull Object parameter)
      Restricts the results by the given properties value.
      Specified by:
      eq in interface Criteria
      Specified by:
      eq in interface QueryModel
      Parameters:
      property - The name of the property
      parameter - The parameter that provides the value
      Returns:
      This query instance

    • allEq

      @NonNull public DefaultQuery allEq(@NonNull Map<String,Object> values)
      Shortcut to restrict the query to multiple given property values.
      Specified by:
      allEq in interface Criteria
      Specified by:
      allEq in interface QueryModel
      Parameters:
      values - The values
      Returns:
      This query instance

    • eqAll

      @NonNull public QueryModel eqAll(@NonNull String propertyName, @NonNull Criteria propertyValue)
      Description copied from interface: Criteria
      Creates a subquery criterion that ensures the given property is equals to all the given returned values.
      Specified by:
      eqAll in interface Criteria
      Specified by:
      eqAll in interface QueryModel
      Parameters:
      propertyName - The property name
      propertyValue - A subquery
      Returns:
      This criterion instance

    • gtAll

      @NonNull public QueryModel gtAll(@NonNull String propertyName, @NonNull Criteria propertyValue)
      Description copied from interface: Criteria
      Creates a subquery criterion that ensures the given property is greater than all the given returned values.
      Specified by:
      gtAll in interface Criteria
      Specified by:
      gtAll in interface QueryModel
      Parameters:
      propertyName - The property name
      propertyValue - A subquery
      Returns:
      This criterion instance

    • ltAll

      @NonNull public QueryModel ltAll(@NonNull String propertyName, @NonNull Criteria propertyValue)
      Description copied from interface: Criteria
      Creates a subquery criterion that ensures the given property is less than all the given returned values.
      Specified by:
      ltAll in interface Criteria
      Specified by:
      ltAll in interface QueryModel
      Parameters:
      propertyName - The property name
      propertyValue - A subquery
      Returns:
      This criterion instance

    • geAll

      @NonNull public QueryModel geAll(@NonNull String propertyName, @NonNull Criteria propertyValue)
      Description copied from interface: Criteria
      Creates a subquery criterion that ensures the given property is greater than or equals to all the given returned values.
      Specified by:
      geAll in interface Criteria
      Specified by:
      geAll in interface QueryModel
      Parameters:
      propertyName - The property name
      propertyValue - A subquery
      Returns:
      This criterion instance

    • leAll

      @NonNull public QueryModel leAll(@NonNull String propertyName, @NonNull Criteria propertyValue)
      Description copied from interface: Criteria
      Creates a subquery criterion that ensures the given property is less than or equal to all the given returned values.
      Specified by:
      leAll in interface Criteria
      Specified by:
      leAll in interface QueryModel
      Parameters:
      propertyName - The property name
      propertyValue - A subquery
      Returns:
      This criterion instance

    • gtSome

      @NonNull public QueryModel gtSome(@NonNull String propertyName, @NonNull Criteria propertyValue)
      Description copied from interface: Criteria
      Creates a subquery criterion that ensures the given property is greater than some of the given values.
      Specified by:
      gtSome in interface Criteria
      Specified by:
      gtSome in interface QueryModel
      Parameters:
      propertyName - The property name
      propertyValue - The property value
      Returns:
      This Criteria instance

    • geSome

      @NonNull public QueryModel geSome(@NonNull String propertyName, @NonNull Criteria propertyValue)
      Description copied from interface: Criteria
      Creates a subquery criterion that ensures the given property is greater than or equal to some of the given values.
      Specified by:
      geSome in interface Criteria
      Specified by:
      geSome in interface QueryModel
      Parameters:
      propertyName - The property name
      propertyValue - The property value
      Returns:
      This Criteria instance

    • ltSome

      @NonNull public QueryModel ltSome(@NonNull String propertyName, @NonNull Criteria propertyValue)
      Description copied from interface: Criteria
      Creates a subquery criterion that ensures the given property is less than some of the given values.
      Specified by:
      ltSome in interface Criteria
      Specified by:
      ltSome in interface QueryModel
      Parameters:
      propertyName - The property name
      propertyValue - The property value
      Returns:
      This Criteria instance

    • leSome

      @NonNull public QueryModel leSome(@NonNull String propertyName, @NonNull Criteria propertyValue)
      Description copied from interface: Criteria
      Creates a subquery criterion that ensures the given property is less than or equal to some of the given values.
      Specified by:
      leSome in interface Criteria
      Specified by:
      leSome in interface QueryModel
      Parameters:
      propertyName - The property name
      propertyValue - The property value
      Returns:
      This Criteria instance

    • versionEq

      public DefaultQuery versionEq(@NonNull Object value)
      Description copied from interface: Criteria
      Creates that restricts the version to the given value.
      Specified by:
      versionEq in interface Criteria
      Specified by:
      versionEq in interface QueryModel
      Parameters:
      value - The parameter that provides the value
      Returns:
      The criteria

    • isEmpty

      @NonNull public DefaultQuery isEmpty(@NonNull String property)
      Used to restrict a value to be empty (such as a blank string or an empty collection).
      Specified by:
      isEmpty in interface Criteria
      Specified by:
      isEmpty in interface QueryModel
      Parameters:
      property - The property name
      Returns:
      The criteria

    • isNotEmpty

      @NonNull public DefaultQuery isNotEmpty(@NonNull String property)
      Used to restrict a value to be not empty (such as a blank string or an empty collection).
      Specified by:
      isNotEmpty in interface Criteria
      Specified by:
      isNotEmpty in interface QueryModel
      Parameters:
      property - The property name
      Returns:
      The criteria

    • isNull

      @NonNull public DefaultQuery isNull(@NonNull String property)
      Used to restrict a property to be null.
      Specified by:
      isNull in interface Criteria
      Specified by:
      isNull in interface QueryModel
      Parameters:
      property - The property name
      Returns:
      The criteria

    • isTrue

      @NonNull public QueryModel isTrue(@NonNull String propertyName)
      Description copied from interface: Criteria
      Creates a criterion that asserts the given property is true.
      Specified by:
      isTrue in interface Criteria
      Specified by:
      isTrue in interface QueryModel
      Parameters:
      propertyName - The property name
      Returns:
      The criteria

    • isFalse

      @NonNull public QueryModel isFalse(@NonNull String propertyName)
      Description copied from interface: Criteria
      Creates a criterion that asserts the given property is false.
      Specified by:
      isFalse in interface Criteria
      Specified by:
      isFalse in interface QueryModel
      Parameters:
      propertyName - The property name
      Returns:
      The criteria

    • isNotNull

      @NonNull public DefaultQuery isNotNull(@NonNull String property)
      Used to restrict a property to be not null.
      Specified by:
      isNotNull in interface Criteria
      Specified by:
      isNotNull in interface QueryModel
      Parameters:
      property - The property name
      Returns:
      The criteria

    • idEq

      @NonNull public DefaultQuery idEq(@NonNull Object value)
      Restricts the results by the given properties value.
      Specified by:
      idEq in interface Criteria
      Specified by:
      idEq in interface QueryModel
      Parameters:
      value - The value to restrict by
      Returns:
      This query instance

    • ne

      @NonNull public QueryModel ne(@NonNull String propertyName, @NonNull Object parameter)
      Description copied from interface: Criteria
      Creates a "not equals" Criterion based on the specified property name and value.
      Specified by:
      ne in interface Criteria
      Specified by:
      ne in interface QueryModel
      Parameters:
      propertyName - The property name
      parameter - The parameter that provides the value
      Returns:
      The criteria

    • gt

      @NonNull public DefaultQuery gt(@NonNull String property, @NonNull Object value)
      Used to restrict a value to be greater than the given value.
      Specified by:
      gt in interface Criteria
      Specified by:
      gt in interface QueryModel
      Parameters:
      property - The name of the property
      value - The value to restrict by
      Returns:
      This query instance

    • gte

      public DefaultQuery gte(String property, Object value)
      Used to restrict a value to be greater than or equal to the given value.
      Specified by:
      gte in interface Criteria
      Specified by:
      gte in interface QueryModel
      Parameters:
      property - The name of the property
      value - The value to restrict by
      Returns:
      This query instance

    • lte

      public DefaultQuery lte(String property, Object value)
      Used to restrict a value to be less than or equal to the given value.
      Specified by:
      lte in interface Criteria
      Specified by:
      lte in interface QueryModel
      Parameters:
      property - The name of the property
      value - The value to restrict by
      Returns:
      This query instance

    • ge

      public DefaultQuery ge(String property, Object value)
      Used to restrict a value to be greater than or equal to the given value.
      Specified by:
      ge in interface Criteria
      Specified by:
      ge in interface QueryModel
      Parameters:
      property - The name of the property
      value - The value to restrict by
      Returns:
      This query instance

    • le

      public DefaultQuery le(String property, Object value)
      Used to restrict a value to be less than or equal to the given value.
      Specified by:
      le in interface Criteria
      Specified by:
      le in interface QueryModel
      Parameters:
      property - The name of the property
      value - The value to restrict by
      Returns:
      This query instance

    • lt

      public DefaultQuery lt(String property, Object value)
      Used to restrict a value to be less than the given value.
      Specified by:
      lt in interface Criteria
      Specified by:
      lt in interface QueryModel
      Parameters:
      property - The name of the property
      value - The value to restrict by
      Returns:
      This query instance

    • like

      @NonNull public DefaultQuery like(@NonNull String propertyName, @NonNull Object parameter)
      Description copied from interface: Criteria
      Creates a like Criterion based on the specified property name and value.
      Specified by:
      like in interface Criteria
      Specified by:
      like in interface QueryModel
      Parameters:
      propertyName - The property name
      parameter - The parameter that provides the value
      Returns:
      The criteria

    • startsWith

      @NonNull public QueryModel startsWith(@NonNull String propertyName, @NonNull Object parameter)
      Description copied from interface: Criteria
      Restricts the property match to strings starting with the given value.
      Specified by:
      startsWith in interface Criteria
      Specified by:
      startsWith in interface QueryModel
      Parameters:
      propertyName - The property name
      parameter - The parameter that provides the value
      Returns:
      The criteria

    • endsWith

      @NonNull public QueryModel endsWith(@NonNull String propertyName, @NonNull Object parameter)
      Description copied from interface: Criteria
      Restricts the property match to strings ending with the given value.
      Specified by:
      endsWith in interface Criteria
      Specified by:
      endsWith in interface QueryModel
      Parameters:
      propertyName - The property name
      parameter - The parameter that provides the value
      Returns:
      The criteria

    • contains

      @NonNull public QueryModel contains(@NonNull String propertyName, @NonNull Object parameter)
      Description copied from interface: Criteria
      Restricts the property match to strings containing with the given value.
      Specified by:
      contains in interface Criteria
      Specified by:
      contains in interface QueryModel
      Parameters:
      propertyName - The property name
      parameter - The parameter that provides the value
      Returns:
      The criteria

    • ilike

      @NonNull public DefaultQuery ilike(@NonNull String propertyName, @NonNull Object parameter)
      Description copied from interface: Criteria
      Creates an ilike Criterion based on the specified property name and value. Unlike a like condition, ilike is case insensitive.
      Specified by:
      ilike in interface Criteria
      Specified by:
      ilike in interface QueryModel
      Parameters:
      propertyName - The property name
      parameter - The parameter that provides the value
      Returns:
      The criteria

    • rlike

      @NonNull public DefaultQuery rlike(@NonNull String propertyName, @NonNull Object parameter)
      Description copied from interface: Criteria
      Creates an rlike Criterion based on the specified property name and value.
      Specified by:
      rlike in interface Criteria
      Specified by:
      rlike in interface QueryModel
      Parameters:
      propertyName - The property name
      parameter - The parameter that provides the value
      Returns:
      The criteria

    • and

      @NonNull public QueryModel and(@NonNull Criteria other)
      Description copied from interface: Criteria
      Creates a logical conjunction.
      Specified by:
      and in interface Criteria
      Specified by:
      and in interface QueryModel
      Parameters:
      other - The other criteria
      Returns:
      This criteria

    • or

      @NonNull public QueryModel or(@NonNull Criteria other)
      Description copied from interface: Criteria
      Creates a logical disjunction.
      Specified by:
      or in interface Criteria
      Specified by:
      or in interface QueryModel
      Parameters:
      other - The other criteria
      Returns:
      This criteria

    • not

      @NonNull public QueryModel not(@NonNull Criteria other)
      Description copied from interface: Criteria
      Creates a logical negation.
      Specified by:
      not in interface Criteria
      Specified by:
      not in interface QueryModel
      Parameters:
      other - The other criteria
      Returns:
      This criteria

    • inList

      @NonNull public DefaultQuery inList(@NonNull String propertyName, @NonNull QueryModel subquery)
      Description copied from interface: Criteria
      Creates an "in" Criterion using a subquery.
      Specified by:
      inList in interface Criteria
      Specified by:
      inList in interface QueryModel
      Parameters:
      propertyName - The property name
      subquery - The subquery
      Returns:
      The criteria

    • inList

      public DefaultQuery inList(String property, Object values)
      Restricts the results by the given property values.
      Specified by:
      inList in interface Criteria
      Specified by:
      inList in interface QueryModel
      Parameters:
      property - The name of the property
      values - The values to restrict by
      Returns:
      This query instance

    • notIn

      @NonNull public DefaultQuery notIn(@NonNull String propertyName, @NonNull QueryModel subquery)
      Description copied from interface: Criteria
      Creates a negated "in" Criterion using a subquery.
      Specified by:
      notIn in interface Criteria
      Specified by:
      notIn in interface QueryModel
      Parameters:
      propertyName - The property name
      subquery - The subquery
      Returns:
      The criteria

    • sizeEq

      @NonNull public DefaultQuery sizeEq(@NonNull String propertyName, @NonNull Object size)
      Description copied from interface: Criteria
      Creates a Criterion that constrains a collection property by size.
      Specified by:
      sizeEq in interface Criteria
      Specified by:
      sizeEq in interface QueryModel
      Parameters:
      propertyName - The property name
      size - The size to constrain by
      Returns:
      This criteria

    • sizeGt

      @NonNull public DefaultQuery sizeGt(@NonNull String propertyName, @NonNull Object size)
      Description copied from interface: Criteria
      Creates a Criterion that constrains a collection property to be greater than the given size.
      Specified by:
      sizeGt in interface Criteria
      Specified by:
      sizeGt in interface QueryModel
      Parameters:
      propertyName - The property name
      size - The size to constrain by
      Returns:
      This criteria

    • sizeGe

      @NonNull public DefaultQuery sizeGe(@NonNull String propertyName, @NonNull Object size)
      Description copied from interface: Criteria
      Creates a Criterion that constrains a collection property to be greater than or equal to the given size.
      Specified by:
      sizeGe in interface Criteria
      Specified by:
      sizeGe in interface QueryModel
      Parameters:
      propertyName - The property name
      size - The size to constrain by
      Returns:
      This criteria

    • sizeLe

      @NonNull public DefaultQuery sizeLe(@NonNull String propertyName, @NonNull Object size)
      Description copied from interface: Criteria
      Creates a Criterion that constrains a collection property to be less than or equal to the given size.
      Specified by:
      sizeLe in interface Criteria
      Specified by:
      sizeLe in interface QueryModel
      Parameters:
      propertyName - The property name
      size - The size to constrain by
      Returns:
      This criteria

    • sizeLt

      @NonNull public DefaultQuery sizeLt(@NonNull String propertyName, @NonNull Object size)
      Description copied from interface: Criteria
      Creates a Criterion that constrains a collection property to be less than to the given size.
      Specified by:
      sizeLt in interface Criteria
      Specified by:
      sizeLt in interface QueryModel
      Parameters:
      propertyName - The property name
      size - The size to constrain by
      Returns:
      This criteria

    • sizeNe

      @NonNull public DefaultQuery sizeNe(@NonNull String propertyName, @NonNull Object size)
      Description copied from interface: Criteria
      Creates a Criterion that constrains a collection property to be not equal to the given size.
      Specified by:
      sizeNe in interface Criteria
      Specified by:
      sizeNe in interface QueryModel
      Parameters:
      propertyName - The property name
      size - The size to constrain by
      Returns:
      This criteria

    • eqProperty

      @NonNull public DefaultQuery eqProperty(@NonNull String propertyName, @NonNull String otherPropertyName)
      Description copied from interface: Criteria
      Constrains a property to be equal to a specified other property.
      Specified by:
      eqProperty in interface Criteria
      Specified by:
      eqProperty in interface QueryModel
      Parameters:
      propertyName - The property
      otherPropertyName - The other property
      Returns:
      This criteria

    • neProperty

      @NonNull public DefaultQuery neProperty(@NonNull String propertyName, @NonNull String otherPropertyName)
      Description copied from interface: Criteria
      Constrains a property to be not equal to a specified other property.
      Specified by:
      neProperty in interface Criteria
      Specified by:
      neProperty in interface QueryModel
      Parameters:
      propertyName - The property
      otherPropertyName - The other property
      Returns:
      This criteria

    • gtProperty

      @NonNull public DefaultQuery gtProperty(@NonNull String propertyName, @NonNull String otherPropertyName)
      Description copied from interface: Criteria
      Constrains a property to be greater than a specified other property.
      Specified by:
      gtProperty in interface Criteria
      Specified by:
      gtProperty in interface QueryModel
      Parameters:
      propertyName - The property
      otherPropertyName - The other property
      Returns:
      This criteria

    • geProperty

      @NonNull public DefaultQuery geProperty(@NonNull String propertyName, @NonNull String otherPropertyName)
      Description copied from interface: Criteria
      Constrains a property to be greater than or equal to a specified other property.
      Specified by:
      geProperty in interface Criteria
      Specified by:
      geProperty in interface QueryModel
      Parameters:
      propertyName - The property
      otherPropertyName - The other property
      Returns:
      This criteria

    • ltProperty

      @NonNull public DefaultQuery ltProperty(@NonNull String propertyName, @NonNull String otherPropertyName)
      Description copied from interface: Criteria
      Constrains a property to be less than a specified other property.
      Specified by:
      ltProperty in interface Criteria
      Specified by:
      ltProperty in interface QueryModel
      Parameters:
      propertyName - The property
      otherPropertyName - The other property
      Returns:
      This criteria

    • leProperty

      @NonNull public DefaultQuery leProperty(String propertyName, @NonNull String otherPropertyName)
      Description copied from interface: Criteria
      Constrains a property to be less than or equal to a specified other property.
      Specified by:
      leProperty in interface Criteria
      Specified by:
      leProperty in interface QueryModel
      Parameters:
      propertyName - The property
      otherPropertyName - The other property
      Returns:
      This criteria

    • between

      public DefaultQuery between(String property, Object start, Object end)
      Restricts the results by the given property value range.
      Specified by:
      between in interface Criteria
      Specified by:
      between in interface QueryModel
      Parameters:
      property - The name of the property
      start - The start of the range
      end - The end of the range
      Returns:
      This query instance

    • and

      public DefaultQuery and(QueryModel.Criterion a, QueryModel.Criterion b)
      Creates a conjunction using two specified criterion.
      Parameters:
      a - The left hand side
      b - The right hand side
      Returns:
      This query instance

    • or

      public DefaultQuery or(QueryModel.Criterion a, QueryModel.Criterion b)
      Creates a disjunction using two specified criterion.
      Parameters:
      a - The left hand side
      b - The right hand side
      Returns:
      This query instance