io.deephaven.engine.table.WouldMatchPair Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-engine-api Show documentation

Engine API: Engine API module, suitable as a compile-time dependency for most queries

The newest version!

//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.engine.table;

import io.deephaven.api.RawString;
import io.deephaven.api.filter.Filter;
import io.deephaven.api.util.NameValidator;

import java.util.Objects;

/**
 * A Pair of (Column name, Filter) for use with {@link Table#wouldMatch(String...)}.
 */
public class WouldMatchPair {

    public static final WouldMatchPair[] ZERO_LENGTH_WOULD_MATCH_PAIR_ARRAY = new WouldMatchPair[0];

    private final String columnName;
    private final Filter filter;

    /**
     * Create a SelectPair from a column name and expression.
     *
     * @param columnName the name of the resultant column
     * @param expression the expression to populate the column
     */
    public WouldMatchPair(String columnName, String expression) {
        this(columnName, RawString.of(expression));
    }

    /**
     * Create a WouldMatchPair from a column name and {@link Filter}.
     *
     * @see io.deephaven.engine.table.impl.select.WhereFilterFactory
     *
     * @param columnName the name of the resultant column
     * @param filter the filter to populate the column
     */
    public WouldMatchPair(String columnName, Filter filter) {
        this.columnName = NameValidator.validateColumnName(columnName);
        this.filter = filter;
    }

    public String getColumnName() {
        return columnName;
    }

    public Filter getFilter() {
        return filter;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (o == null || getClass() != o.getClass())
            return false;
        final WouldMatchPair other = (WouldMatchPair) o;
        return Objects.equals(columnName, other.columnName) &&
                Objects.equals(filter, other.filter);
    }

    @Override
    public int hashCode() {
        return Objects.hash(columnName, filter);
    }
}