io.trino.sql.tree.FunctionCall Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of trino-parser Show documentation
There is a newer version: 465
/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.trino.sql.tree;

import com.google.common.collect.ImmutableList;

import java.util.List;
import java.util.Objects;
import java.util.Optional;

import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Objects.requireNonNull;

public class FunctionCall
        extends Expression
{
    private final QualifiedName name;
    private final Optional window;
    private final Optional filter;
    private final Optional orderBy;
    private final boolean distinct;
    private final Optional nullTreatment;
    private final Optional processingMode;
    private final List arguments;

    @Deprecated
    public FunctionCall(QualifiedName name, List arguments)
    {
        this(Optional.empty(), name, Optional.empty(), Optional.empty(), Optional.empty(), false, Optional.empty(), Optional.empty(), arguments);
    }

    public FunctionCall(NodeLocation location, QualifiedName name, List arguments)
    {
        this(Optional.of(location), name, Optional.empty(), Optional.empty(), Optional.empty(), false, Optional.empty(), Optional.empty(), arguments);
    }

    public FunctionCall(
            Optional location,
            QualifiedName name,
            Optional window,
            Optional filter,
            Optional orderBy,
            boolean distinct,
            Optional nullTreatment,
            Optional processingMode,
            List arguments)
    {
        super(location);
        requireNonNull(name, "name is null");
        requireNonNull(window, "window is null");
        window.ifPresent(node -> checkArgument(node instanceof WindowReference || node instanceof WindowSpecification, "unexpected window: %s", node.getClass().getSimpleName()));
        requireNonNull(filter, "filter is null");
        requireNonNull(orderBy, "orderBy is null");
        requireNonNull(nullTreatment, "nullTreatment is null");
        requireNonNull(processingMode, "processingMode is null");
        requireNonNull(arguments, "arguments is null");

        this.name = name;
        this.window = window;
        this.filter = filter;
        this.orderBy = orderBy;
        this.distinct = distinct;
        this.nullTreatment = nullTreatment;
        this.processingMode = processingMode;
        this.arguments = arguments;
    }

    public QualifiedName getName()
    {
        return name;
    }

    public Optional getWindow()
    {
        return window;
    }

    public Optional getOrderBy()
    {
        return orderBy;
    }

    public boolean isDistinct()
    {
        return distinct;
    }

    public Optional getNullTreatment()
    {
        return nullTreatment;
    }

    public Optional getProcessingMode()
    {
        return processingMode;
    }

    public List getArguments()
    {
        return arguments;
    }

    public Optional getFilter()
    {
        return filter;
    }

    @Override
    public  R accept(AstVisitor visitor, C context)
    {
        return visitor.visitFunctionCall(this, context);
    }

    @Override
    public List getChildren()
    {
        ImmutableList.Builder nodes = ImmutableList.builder();
        window.ifPresent(window -> nodes.add((Node) window));
        filter.ifPresent(nodes::add);
        orderBy.map(OrderBy::getSortItems).ifPresent(nodes::addAll);
        nodes.addAll(arguments);
        return nodes.build();
    }

    @Override
    public boolean equals(Object obj)
    {
        if (this == obj) {
            return true;
        }
        if ((obj == null) || (getClass() != obj.getClass())) {
            return false;
        }
        FunctionCall o = (FunctionCall) obj;
        return Objects.equals(name, o.name) &&
                Objects.equals(window, o.window) &&
                Objects.equals(filter, o.filter) &&
                Objects.equals(orderBy, o.orderBy) &&
                distinct == o.distinct &&
                Objects.equals(nullTreatment, o.nullTreatment) &&
                Objects.equals(processingMode, o.processingMode) &&
                Objects.equals(arguments, o.arguments);
    }

    @Override
    public int hashCode()
    {
        return Objects.hash(name, distinct, nullTreatment, processingMode, window, filter, orderBy, arguments);
    }

    // TODO: make this a proper Tree node so that we can report error
    // locations more accurately
    public enum NullTreatment
    {
        IGNORE, RESPECT
    }

    @Override
    public boolean shallowEquals(Node other)
    {
        if (!sameClass(this, other)) {
            return false;
        }

        FunctionCall otherFunction = (FunctionCall) other;

        return name.equals(otherFunction.name) &&
                distinct == otherFunction.distinct &&
                nullTreatment.equals(otherFunction.nullTreatment) &&
                processingMode.equals(otherFunction.processingMode);
    }
}