io.prestosql.spi.connector.Constraint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of presto-spi Show documentation
There is a newer version: 350
/*
 * 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.prestosql.spi.connector;

import io.prestosql.spi.predicate.NullableValue;
import io.prestosql.spi.predicate.TupleDomain;

import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Predicate;

import static java.util.Objects.requireNonNull;

public class Constraint
{
    private final TupleDomain summary;
    private final Optional>> predicate;
    private final Optional> predicateColumns;

    public static Constraint alwaysTrue()
    {
        return new Constraint(TupleDomain.all(), Optional.empty(), Optional.empty());
    }

    public static Constraint alwaysFalse()
    {
        return new Constraint(TupleDomain.none(), Optional.of(bindings -> false), Optional.empty());
    }

    public Constraint(TupleDomain summary)
    {
        this(summary, Optional.empty(), Optional.empty());
    }

    /**
     * @deprecated Use {@link #Constraint(TupleDomain, Predicate, Set)} instead.
     */
    @Deprecated
    public Constraint(TupleDomain summary, Predicate> predicate)
    {
        this(summary, Optional.of(predicate), Optional.empty());
    }

    public Constraint(TupleDomain summary, Predicate> predicate, Set predicateColumns)
    {
        this(summary, Optional.of(predicate), Optional.of(predicateColumns));
    }

    /**
     * @deprecated Use {@link #Constraint(TupleDomain, Optional, Optional)} instead.
     */
    @Deprecated
    public Constraint(TupleDomain summary, Optional>> predicate)
    {
        this(summary, predicate, Optional.empty());
    }

    public Constraint(TupleDomain summary, Optional>> predicate, Optional> predicateColumns)
    {
        this.summary = requireNonNull(summary, "summary is null");
        this.predicate = requireNonNull(predicate, "predicate is null");
        this.predicateColumns = requireNonNull(predicateColumns, "predicateColumns is null");

        // TODO remove deprecated constructors and validate that predicate is present *iff* predicateColumns is present
        if (predicateColumns.isPresent() && predicate.isEmpty()) {
            throw new IllegalArgumentException("predicateColumns cannot be present when predicate is not present");
        }
    }

    public TupleDomain getSummary()
    {
        return summary;
    }

    public Optional>> predicate()
    {
        return predicate;
    }

    /**
     * @deprecated Use {@link #getPredicateColumns()} instead.
     */
    @Deprecated
    public Optional> getColumns()
    {
        return getPredicateColumns();
    }

    /**
     * Set of columns the {@link #predicate()} result depends on.
     */
    public Optional> getPredicateColumns()
    {
        return predicateColumns;
    }
}