Record Class PaginationRenderingPlan.Window

java.lang.Object
java.lang.Record
org.hibernate.dialect.sql.ast.spi.PaginationRenderingPlan.Window
Record Components:
emulateFetchClause - whether the fetch clause itself requires window emulation, including semantics such as with ties or percentages, instead of emulating only its offset
All Implemented Interfaces:
PaginationRenderingPlan
Enclosing interface:
PaginationRenderingPlan
public static record PaginationRenderingPlan.Window(boolean emulateFetchClause) extends Record implements PaginationRenderingPlan

Emulate pagination by wrapping the query part and filtering a derived row number.

The precise projection and window function vary with the query, but the general shape for offset 5 and fetch 10 is:

select ...
from (
    select ..., row_number() over (order by ...) as rn
    from ...
) page
where page.rn > 5 and page.rn <= 15
Since:
8.0

  • Constructor Details

    • Window

      public Window(boolean emulateFetchClause)
      Creates an instance of a Window record class.
      Parameters:
      emulateFetchClause - the value for the emulateFetchClause record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • emulateFetchClause

      public boolean emulateFetchClause()
      Returns the value of the emulateFetchClause record component.
      Returns:
      the value of the emulateFetchClause record component