• Home
• se.kuseman.payloadbuilder
• payloadbuilder-api
• 1.0.5.2
• source code
• DatasourceData.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

se.kuseman.payloadbuilder.api.catalog.DatasourceData Maven / Gradle / Ivy

package se.kuseman.payloadbuilder.api.catalog;

import static java.util.Objects.requireNonNull;

import java.util.Iterator;
import java.util.List;
import java.util.Optional;

import se.kuseman.payloadbuilder.api.QualifiedName;
import se.kuseman.payloadbuilder.api.execution.IStatementContext;
import se.kuseman.payloadbuilder.api.execution.TupleVector;
import se.kuseman.payloadbuilder.api.expression.IComparisonExpression;
import se.kuseman.payloadbuilder.api.expression.IExpression;

/** Data used when a catalog is asked for creation of a data source */
public class DatasourceData
{
    private final int nodeId;
    private final Optional schema;
    private final List predicates;
    private final List sortItems;
    private final List projection;
    private final List options;

    public DatasourceData(int nodeId, Optional schema, List predicates, List sortItems, List projection, List options)
    {
        this.nodeId = nodeId;
        this.schema = requireNonNull(schema, "schema");
        this.predicates = requireNonNull(predicates, "predicates");
        this.sortItems = requireNonNull(sortItems, "sortItems");
        this.projection = requireNonNull(projection, "projection");
        this.options = requireNonNull(options, "options");
    }

    /**
     * Return the node id for this datasource. The operator ID that this data source belongs to. Can be used in {@link IStatementContext#getNodeData(Integer)} to store custom data.
     */
    public int getNodeId()
    {
        return nodeId;
    }

    /**
     * Return the planned schema for this data source. If the table was planned with a non asterisk schema then this schema should be used in the returned {@link TupleVector}'s. Otherwise this value
     * is {@link Optional#empty()} and the actual runtime schema should be provided in tuples.
     */
    public Optional getSchema()
    {
        return schema;
    }

    /** Return predicates if any to push down to data source if supported by catalog */
    public List getPredicates()
    {
        return predicates;
    }

    /** Return sort items if any to push down to data soource if supported by catalog. NOTE! All or no sort items must be consumed */
    public List getSortItems()
    {
        return sortItems;
    }

    /**
     * Return the projected columns needed for this data source. This is a optimization hint that can be used for catalogs that supports fetching of specific columns only like RDMBS:es. If empty then
     * all column should be returned
     */
    public List getProjection()
    {
        return projection;
    }

    /** Return defined options for this data source */
    public List getOptions()
    {
        return options;
    }

    /**
     * Convenience method for extracting a equals predicate for specific column.
     *
     * 
     *   Ie.
     *
     *   select *
     *   from table t
     *   where 'val' = t.col
     *
     * Calling this method with value 'col' would return in
     * the literal string expression 'val'
     * 
     * NOTE! Mutates the {@link #predicates} list if column was found.
     * 
     */
    public IExpression extractEqualsPredicate(QualifiedName column)
    {
        if (predicates.isEmpty())
        {
            return null;
        }

        Iterator it = predicates.iterator();
        while (it.hasNext())
        {
            IPredicate pair = it.next();
            QualifiedName qname = pair.getQualifiedColumn();
            if (qname == null
                    || pair.getType() != IPredicate.Type.COMPARISION
                    || pair.getComparisonType() != IComparisonExpression.Type.EQUAL)
            {
                continue;
            }
            if (qname.equals(column))
            {
                it.remove();
                return pair.getComparisonExpression();
            }
        }
        return null;
    }
}