com.yahoo.bard.webservice.table.TableGroup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fili-core Show documentation
Fili web service library provides core capabilities for RESTful aggregation navigation, query planning and metadata
There is a newer version: 1.1.13
// Copyright 2016 Yahoo Inc.
// Licensed under the terms of the Apache license. Please see LICENSE.md file distributed with this work for terms.
package com.yahoo.bard.webservice.table;

import com.yahoo.bard.webservice.data.config.names.ApiMetricName;
import com.yahoo.bard.webservice.data.dimension.Dimension;
import com.yahoo.bard.webservice.web.filters.ApiFilters;

import java.util.LinkedHashSet;
import java.util.Objects;
import java.util.Set;

/**
 * A TableGroup has a list of Physical Tables and a set of columns representing the collective schema of these tables.
 * These tables are scanned by query planning to determine a best table.
 *
 * The dimensions and apiMetricNames on the TableGroup are only consumed at config time to aid in building
 * LogicalTable schemas.
 *
 */
public class TableGroup {

    private final LinkedHashSet tables;

    private final LinkedHashSet dimensions;
    private final Set apiMetricNames;

    private final ApiFilters apiFilters;

    /**
     * Builds a TableGroup.
     * A TableGroup contains the dimensions, metrics, and backing physical tables intended to be attached to a
     * LogicalTable.
     *
     * @param tables  The backing physical tables
     * @param apiMetricNames  The metric names for a LogicalTable
     * @param dimensions  The dimensions for a LogicalTable
     * @param apiFilters  A collection of ApiFilters to apply to the rows on this table group
     */
    public TableGroup(
            LinkedHashSet tables,
            Set apiMetricNames,
            Set dimensions,
            ApiFilters apiFilters
    ) {
        this.tables = new LinkedHashSet<>(tables);
        this.apiMetricNames = apiMetricNames;
        this.dimensions = new LinkedHashSet<>(dimensions);
        this.apiFilters = apiFilters;
    }

    /**
     * Builds a TableGroup.
     * A TableGroup contains the dimensions, metrics, and backing physical tables intended to be attached to a
     * LogicalTable.
     *
     * Default ApiFilters to no filters (null).
     *
     * @param tables  The backing physical tables
     * @param apiMetricNames  The metric names for a LogicalTable
     * @param dimensions  The dimensions for a LogicalTable
     */
    public TableGroup(
            LinkedHashSet tables,
            Set apiMetricNames,
            Set dimensions
    ) {
        this(tables, apiMetricNames, dimensions, null);
    }


    /**
     * Getter for set of physical tables.
     *
     * @return physicalTableSchema
     */
    public LinkedHashSet getPhysicalTables() {
        return this.tables;
    }

    /**
     * Getter for the set of maximal dimensions for tables in this table group.
     *
     * @return dimensions
     */
    public Set getDimensions() {
        return dimensions;
    }

    /**
     * Getter the row filtering ApiFilters for this table.
     *
     * @return apiFilters, null if no filters
     */
    public ApiFilters getApiFilters() {
        return apiFilters;
    }

    @Override
    public String toString() {
        return "TableGroup: " + tables ;
    }

    /**
     * Getter for the api metric names on this group.
     *
     * @return api metric names
     */
    public Set getApiMetricNames() {
        return apiMetricNames;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) { return true; }
        if (o == null || getClass() != o.getClass()) { return false; }
        TableGroup that = (TableGroup) o;
        return
                Objects.equals(dimensions, that.dimensions) &&
                Objects.equals(tables, that.tables) &&
                Objects.equals(apiMetricNames, that.apiMetricNames);
    }

    @Override
    public int hashCode() {
        return Objects.hash(dimensions, tables, apiMetricNames);
    }
}