Class AnalyticFunction

java.lang.Object
org.springframework.data.relational.core.sql.AnalyticFunction
All Implemented Interfaces:
Expression, Segment, Visitable
public class AnalyticFunction extends Object implements Expression
Represents an analytic function, also known as windowing function
Since:
2.7
Author:
Jens Schauder

  • Method Details

    • create

      public static AnalyticFunction create(String function, Expression... arguments)

    • partitionBy

      public AnalyticFunction partitionBy(Expression... partitionBy)
      Specify the PARTITION BY clause of an analytic function
      Parameters:
      partitionBy - Typically, column but other expressions are fine to.
      Returns:
      a new AnalyticFunction is partitioned by the given expressions, overwriting any expression previously present.

    • partitionBy

      public AnalyticFunction partitionBy(Collection<? extends Expression> partitionBy)
      Specify the PARTITION BY clause of an analytic function
      Parameters:
      partitionBy - Typically, column but other expressions are fine to.
      Returns:
      a new AnalyticFunction is partitioned by the given expressions, overwriting any expression previously present.
      Since:
      4.0

    • orderBy

      public AnalyticFunction orderBy(OrderByField... orderBy)
      Specify the ORDER BY clause of an analytic function
      Parameters:
      orderBy - Typically, column but other expressions are fine to.
      Returns:
      a new AnalyticFunction is ordered by the given expressions, overwriting any expression previously present.

    • orderBy

      public AnalyticFunction orderBy(Collection<? extends Expression> orderBy)
      Specify the ORDER BY clause of an analytic function
      Parameters:
      orderBy - Typically, column but other expressions are fine to.
      Returns:
      a new AnalyticFunction is ordered by the given expressions, overwriting any expression previously present.
      Since:
      4.0

    • orderBy

      public AnalyticFunction orderBy(Expression... orderBy)
      Specify the ORDER BY clause of an analytic function
      Parameters:
      orderBy - array of Expression. Typically, column but other expressions are fine to.
      Returns:
      a new AnalyticFunction is ordered by the given expressions, overwriting any expression previously present.

    • as

      public AnalyticFunction as(String alias)

    • as

      public AnalyticFunction as(SqlIdentifier alias)

    • visit

      public void visit(Visitor visitor)
      Description copied from interface: Visitable
      Accept a Visitor visiting this Visitable and its nested Visitables if applicable.
      Specified by:
      visit in interface Visitable
      Parameters:
      visitor - the visitor to notify, must not be null.

    • hashCode

      public int hashCode()
      Description copied from interface: Segment
      Generate a hash code from thisSegment.

      Hashcode typically derives from the Segment.toString() representation so two Segments yield the same Segment.hashCode() if their Segment.toString() representation matches.

      Specified by:
      hashCode in interface Segment
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for this object.

    • equals

      public boolean equals(@Nullable Object obj)
      Description copied from interface: Segment
      Check whether this Segment is equal to another Segment.

      Equality is typically given if the Segment.toString() representation matches.

      Specified by:
      equals in interface Segment
      Overrides:
      equals in class Object
      Parameters:
      obj - the reference object with which to compare.
      Returns:
      true if this object is the same as the other argument; false otherwise.

    • toString

      public String toString()
      Description copied from interface: Segment
      Return a SQL string representation of this Segment.

      The representation is intended for debugging purposes and an approximation to the generated SQL. While it might work in the context of a specific dialect, you should not assume that the Segment.toString() representation works across multiple databases.

      Specified by:
      toString in interface Segment
      Overrides:
      toString in class Object
      Returns:
      a SQL string representation of this Segment.