Package org.h2.expression.aggregate

Class ListaggArguments

java.lang.Object
org.h2.expression.aggregate.ListaggArguments
public final class ListaggArguments extends Object
Additional arguments of LISTAGG aggregate function.

  • Constructor Details

    • ListaggArguments

      public ListaggArguments()
      Creates a new instance of additional arguments of LISTAGG aggregate function.

  • Method Details

    • setSeparator

      public void setSeparator(Expression separator)
      Sets the custom LISTAGG separator.
      Parameters:
      separator - the LISTAGG separator, null or empty string means no separator

    • getSeparator

      public Expression getSeparator()
      Returns the LISTAGG separator.
      Returns:
      the LISTAGG separator, null means the default

    • getEffectiveSeparator

      public String getEffectiveSeparator()
      Returns the effective LISTAGG separator.
      Returns:
      the effective LISTAGG separator

    • setOnOverflowTruncate

      public void setOnOverflowTruncate(boolean onOverflowTruncate)
      Sets the LISTAGG overflow behavior.
      Parameters:
      onOverflowTruncate - true for ON OVERFLOW TRUNCATE, false for ON OVERFLOW ERROR

    • getOnOverflowTruncate

      public boolean getOnOverflowTruncate()
      Returns the LISTAGG overflow behavior.
      Returns:
      true for ON OVERFLOW TRUNCATE, false for ON OVERFLOW ERROR

    • setFilter

      public void setFilter(Expression filter)
      Sets the custom LISTAGG truncation filter.
      Parameters:
      filter - the LISTAGG truncation filter, null or empty string means no truncation filter

    • getFilter

      public Expression getFilter()
      Returns the LISTAGG truncation filter.
      Returns:
      the LISTAGG truncation filter, null means the default

    • getEffectiveFilter

      public String getEffectiveFilter()
      Returns the effective LISTAGG truncation filter.
      Returns:
      the effective LISTAGG truncation filter

    • setWithoutCount

      public void setWithoutCount(boolean withoutCount)
      Sets the LISTAGG count indication.
      Parameters:
      withoutCount - true for WITHOUT COUNT, false for WITH COUNT

    • isWithoutCount

      public boolean isWithoutCount()
      Returns the LISTAGG count indication.
      Returns:
      true for WITHOUT COUNT, false for WITH COUNT