Limit.java

/*-
 * #%L
 * JSQLParser library
 * %%
 * Copyright (C) 2004 - 2019 JSQLParser
 * %%
 * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
 * #L%
 */
package net.sf.jsqlparser.statement.select;

import net.sf.jsqlparser.expression.AllValue;
import net.sf.jsqlparser.expression.Expression;
import net.sf.jsqlparser.expression.NullValue;
import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
import net.sf.jsqlparser.parser.ASTNodeAccessImpl;

import java.util.Arrays;

public class Limit extends ASTNodeAccessImpl {

    private Expression rowCount;
    private Expression offset;

    /**
     * A query with the LIMIT n BY expressions clause selects the first n rows for each distinct
     * value of expressions. The key for LIMIT BY can contain any number of expressions.
     *
     * @see <a href=
     *      'https://clickhouse.com/docs/en/sql-reference/statements/select/limit-by'>ClickHouse
     *      LIMIT BY Clause</a>
     */
    private ExpressionList<Expression> byExpressions;

    public Expression getOffset() {
        return offset;
    }

    public void setOffset(Expression l) {
        offset = l;
    }

    public Expression getRowCount() {
        return rowCount;
    }

    public void setRowCount(Expression l) {
        rowCount = l;
    }

    @Deprecated
    public boolean isLimitAll() {
        return rowCount instanceof AllValue;
    }

    @Deprecated
    public void setLimitAll(boolean b) {
        if (b) {
            rowCount = new AllValue();
        }
    }

    @Deprecated
    public boolean isLimitNull() {
        return rowCount instanceof NullValue;
    }

    @Deprecated
    public void setLimitNull(boolean b) {
        if (b) {
            rowCount = new NullValue();
        }
    }

    @Override
    public String toString() {
        String retVal = " LIMIT ";

        if (rowCount instanceof AllValue || rowCount instanceof NullValue) {
            // no offset allowed
            retVal += rowCount;
        } else {
            if (null != offset) {
                retVal += offset + ", ";
            }
            if (null != rowCount) {
                retVal += rowCount;
            }
        }

        if (byExpressions != null) {
            retVal += " BY " + byExpressions;
        }

        return retVal;
    }

    public Limit withRowCount(Expression rowCount) {
        this.setRowCount(rowCount);
        return this;
    }

    public Limit withOffset(Expression offset) {
        this.setOffset(offset);
        return this;
    }

    @Deprecated
    public Limit withLimitAll(boolean limitAll) {
        this.setLimitAll(limitAll);
        return this;
    }

    @Deprecated
    public Limit withLimitNull(boolean limitNull) {
        this.setLimitNull(limitNull);
        return this;
    }

    public <E extends Expression> E getOffset(Class<E> type) {
        return type.cast(getOffset());
    }

    public <E extends Expression> E getRowCount(Class<E> type) {
        return type.cast(getRowCount());
    }

    public ExpressionList<?> getByExpressions() {
        return byExpressions;
    }

    public void setByExpressions(ExpressionList<Expression> byExpressions) {
        this.byExpressions = byExpressions;
    }

    public void setByExpressions(Expression... byExpressions) {
        this.setByExpressions(new ExpressionList<>(byExpressions));
    }

    public void addByExpression(Expression byExpression) {
        if (byExpression == null) {
            byExpressions = new ExpressionList<>();
        }
        byExpressions.add(byExpression);
    }

    public Limit withByExpressions(ExpressionList<Expression> byExpressions) {
        this.setByExpressions(byExpressions);
        return this;
    }

    public Limit withByExpressions(Expression... byExpressions) {
        return withByExpressions(new ExpressionList<>(Arrays.asList(byExpressions)));
    }
}