io.trino.spi.connector.ConstraintApplicationResult Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of trino-spi Show documentation
Trino - Service Provider Interface (SPI)
There is a newer version: 458
/*
 * 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.spi.connector;

import io.trino.spi.expression.ConnectorExpression;
import io.trino.spi.predicate.TupleDomain;

import java.util.Optional;
import java.util.function.Function;

import static java.util.Objects.requireNonNull;

public class ConstraintApplicationResult
{
    private final T handle;
    private final TupleDomain remainingFilter;
    private final Optional remainingExpression;
    private final boolean precalculateStatistics;

    /**
     * @param precalculateStatistics Indicates whether engine should consider calculating statistics based on the plan before pushdown,
     * as the connector may be unable to provide good table statistics for {@code handle}.
     *
     * @deprecated Use {@link #ConstraintApplicationResult(Object, TupleDomain, ConnectorExpression, boolean)}.
     */
    @Deprecated
    public ConstraintApplicationResult(T handle, TupleDomain remainingFilter, boolean precalculateStatistics)
    {
        this(handle, remainingFilter, Optional.empty(), precalculateStatistics);
    }

    /**
     * @param remainingExpression the remaining expression, which will be AND-ed with {@code remainingFilter},
     * @param precalculateStatistics Indicates whether engine should consider calculating statistics based on the plan before pushdown,
     * as the connector may be unable to provide good table statistics for {@code handle}.
     */
    public ConstraintApplicationResult(T handle, TupleDomain remainingFilter, ConnectorExpression remainingExpression, boolean precalculateStatistics)
    {
        this(handle, remainingFilter, Optional.of(remainingExpression), precalculateStatistics);
    }

    /**
     * @param remainingExpression the remaining expression, which will be AND-ed with {@code remainingFilter},
     * or {@link Optional#empty()} if the remaining expression is equal to the original expression.
     * @param precalculateStatistics Indicates whether engine should consider calculating statistics based on the plan before pushdown,
     * as the connector may be unable to provide good table statistics for {@code handle}.
     */
    private ConstraintApplicationResult(T handle, TupleDomain remainingFilter, Optional remainingExpression, boolean precalculateStatistics)
    {
        this.handle = requireNonNull(handle, "handle is null");
        this.remainingFilter = requireNonNull(remainingFilter, "remainingFilter is null");
        this.remainingExpression = requireNonNull(remainingExpression, "remainingExpression is null");
        this.precalculateStatistics = precalculateStatistics;
    }

    public T getHandle()
    {
        return handle;
    }

    public TupleDomain getRemainingFilter()
    {
        return remainingFilter;
    }

    public Optional getRemainingExpression()
    {
        return remainingExpression;
    }

    public boolean isPrecalculateStatistics()
    {
        return precalculateStatistics;
    }

    public  ConstraintApplicationResult transform(Function transformHandle)
    {
        return new ConstraintApplicationResult<>(transformHandle.apply(handle), remainingFilter, remainingExpression, precalculateStatistics);
    }
}