Package io.micronaut.data.model.query.factory

Class Projections

java.lang.Object
io.micronaut.data.model.query.factory.Projections
public class Projections extends Object
Projections used to customize the results of a query.
Since:
1.0
Author:
Graeme Rocher

  • Field Details

  • Constructor Details

    • Projections

      public Projections()

  • Method Details

    • id

      public static QueryModel.IdProjection id()
      Projection used to obtain the id of an object.
      Returns:
      The IdProjection instance

    • count

      public static QueryModel.CountProjection count()
      Projection that returns the number of records from the query. instead of the results themselves
      Returns:
      The CountProjection instance

    • literal

      public static QueryModel.LiteralProjection literal(Object value)
      A projection that projects a simple literal.
      Parameters:
      value - The literal value
      Returns:
      The LiteralProjection instance

    • property

      public static QueryModel.PropertyProjection property(String name)
      A projection that obtains the value of a property of an entity.
      Parameters:
      name - The name of the property
      Returns:
      The PropertyProjection instance

    • property

      public static QueryModel.PropertyProjection property(String name, boolean compound)
      A projection that obtains the value of a property of an entity.
      Parameters:
      name - The name of the property
      compound - Is compound
      Returns:
      The PropertyProjection instance
      Since:
      4.2.0

    • sum

      public static QueryModel.SumProjection sum(String name)
      Computes the sum of a property.
      Parameters:
      name - The name of the property
      Returns:
      The PropertyProjection instance

    • min

      public static QueryModel.MinProjection min(String name)
      Computes the min value of a property.
      Parameters:
      name - The name of the property
      Returns:
      The PropertyProjection instance

    • max

      public static QueryModel.MaxProjection max(String name)
      Computes the pageSize value of a property.
      Parameters:
      name - The name of the property
      Returns:
      The PropertyProjection instance

    • avg

      public static QueryModel.AvgProjection avg(String name)
      Computes the average value of a property.
      Parameters:
      name - The name of the property
      Returns:
      The PropertyProjection instance

    • distinct

      public static QueryModel.DistinctProjection distinct()
      Projection that signifies to return only distinct results.
      Returns:
      Distinct projection

    • countDistinct

      public static QueryModel.CountDistinctProjection countDistinct(String property)
      Projection that signifies to return only distinct results.
      Parameters:
      property - The name of the property
      Returns:
      Distinct projection

    • countDistinctRoot

      public static QueryModel.CountDistinctRootProjection countDistinctRoot()
      Projection that signifies to return only distinct results against an entity, meaning its identity property/properties.
      Returns:
      count distinct projection for the entity

    • groupProperty

      public static QueryModel.GroupPropertyProjection groupProperty(String property)
      Defines a group by projection for datastores that support it.
      Parameters:
      property - The property name
      Returns:
      The projection list

    • rootEntity

      public static QueryModel.RootEntityProjection rootEntity()
      Defines a projection of the root entity.
      Returns:
      The projection