ArrayIntersect.java

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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 org.apache.doris.nereids.trees.expressions.functions.scalar;

import org.apache.doris.catalog.FunctionSignature;
import org.apache.doris.nereids.exceptions.AnalysisException;
import org.apache.doris.nereids.trees.expressions.Expression;
import org.apache.doris.nereids.trees.expressions.functions.ExplicitlyCastableSignature;
import org.apache.doris.nereids.trees.expressions.functions.PropagateNullable;
import org.apache.doris.nereids.trees.expressions.visitor.ExpressionVisitor;
import org.apache.doris.nereids.types.ArrayType;
import org.apache.doris.nereids.types.DataType;
import org.apache.doris.nereids.types.NullType;
import org.apache.doris.nereids.types.coercion.AnyDataType;
import org.apache.doris.nereids.util.ExpressionUtils;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;

import java.util.List;

/**
 * ScalarFunction 'array_intersect'. This class is generated by GenerateFunction.
 */
public class ArrayIntersect extends ScalarFunction implements ExplicitlyCastableSignature, PropagateNullable {

    public static final List<FunctionSignature> SIGNATURES = ImmutableList.of(
            FunctionSignature.retArgType(0)
                    .varArgs(ArrayType.of(new AnyDataType(0)), ArrayType.of(new AnyDataType(0)))
    );

    /**
     * constructor with 2 or more arguments.
     */
    public ArrayIntersect(Expression arg0, Expression arg1, Expression... varArgs) {
        super("array_intersect", ExpressionUtils.mergeArguments(arg0, arg1, varArgs));
    }

    /** constructor for withChildren and reuse signature */
    private ArrayIntersect(ScalarFunctionParams functionParams) {
        super(functionParams);
    }

    /**
     * array_intersect needs to compare whether the sub-elements in the array are equal.
     * so the sub-elements must be comparable. but now map and struct type is not comparable.
     */
    @Override
    public void checkLegalityBeforeTypeCoercion() {
        DataType itemType = NullType.INSTANCE;
        for (Expression child : children()) {
            DataType argType = child.getDataType();
            // nullsafe
            if (argType == NullType.INSTANCE) {
                continue;
            }
            if (!argType.isArrayType() || ((ArrayType) argType).getItemType().isComplexType()) {
                throw new AnalysisException("array_intersect does not support complex types: " + toSql());
            }
            if (((ArrayType) argType).getItemType().isNullType()) {
                continue;
            }
            if (itemType == NullType.INSTANCE) {
                itemType = ((ArrayType) argType).getItemType();
            }
            if (itemType.equals(((ArrayType) argType).getItemType())) {
                continue;
            }
            if (!itemType.isSameTypeForComplexTypeParam(((ArrayType) argType).getItemType())) {
                throw new AnalysisException("array_intersect only supports arguments with the same item type, "
                        + "but got " + toSql());
            }
        }
    }

    /**
     * withChildren.
     */
    @Override
    public ArrayIntersect withChildren(List<Expression> children) {
        Preconditions.checkArgument(children.size() >= 2);
        return new ArrayIntersect(getFunctionParams(children));
    }

    @Override
    public <R, C> R accept(ExpressionVisitor<R, C> visitor, C context) {
        return visitor.visitArrayIntersect(this, context);
    }

    @Override
    public List<FunctionSignature> getSignatures() {
        return SIGNATURES;
    }
}