com.hazelcast.sql.impl.plan.Plan Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hazelcast-all Show documentation
There is a newer version: 5.0-BETA-1
/*
 * Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
 *
 * 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 com.hazelcast.sql.impl.plan;

import com.hazelcast.internal.util.collection.PartitionIdSet;
import com.hazelcast.sql.SqlRowMetadata;
import com.hazelcast.sql.impl.QueryParameterMetadata;
import com.hazelcast.sql.impl.plan.cache.CacheablePlan;
import com.hazelcast.sql.impl.plan.cache.PlanCacheKey;
import com.hazelcast.sql.impl.plan.cache.PlanCheckContext;
import com.hazelcast.sql.impl.plan.cache.PlanObjectKey;
import com.hazelcast.sql.impl.plan.node.PlanNode;
import com.hazelcast.sql.impl.security.SqlSecurityContext;

import java.security.Permission;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;

/**
 * Query plan implementation.
 */
public class Plan implements CacheablePlan {
    /** Time when the plan was used for the last time. */
    private volatile long planLastUsed;

    /** Key used for plan cache. */
    private final PlanCacheKey planKey;

    /** Partition mapping. */
    private final Map partMap;

    /** Fragment nodes. */
    private final List fragments;

    /** Fragment mapping. */
    private final List fragmentMappings;

    /** Outbound edge mapping (from edge ID to owning fragment position). */
    private final Map outboundEdgeMap;

    /** Inbound edge mapping (from edge ID to owning fragment position). */
    private final Map inboundEdgeMap;

    /** Map from inbound edge ID to number of members which will write into it. */
    private final Map inboundEdgeMemberCountMap;

    /** Result set metadata (columns name and types). */
    private final SqlRowMetadata rowMetadata;

    /** Parameter metadata (number of parameter and their types). */
    private final QueryParameterMetadata parameterMetadata;

    /** IDs of objects used in the plan. */
    private final Set objectIds;

    /** Permissions that are required to execute this plan. */
    private final List permissions;

    @SuppressWarnings("checkstyle:ParameterNumber")
    public Plan(
        Map partMap,
        List fragments,
        List fragmentMappings,
        Map outboundEdgeMap,
        Map inboundEdgeMap,
        Map inboundEdgeMemberCountMap,
        SqlRowMetadata rowMetadata,
        QueryParameterMetadata parameterMetadata,
        PlanCacheKey planKey,
        Set objectIds,
        List permissions
    ) {
        this.partMap = partMap;
        this.fragments = fragments;
        this.fragmentMappings = fragmentMappings;
        this.outboundEdgeMap = outboundEdgeMap;
        this.inboundEdgeMap = inboundEdgeMap;
        this.inboundEdgeMemberCountMap = inboundEdgeMemberCountMap;
        this.rowMetadata = rowMetadata;
        this.parameterMetadata = parameterMetadata;
        this.planKey = planKey;
        this.objectIds = objectIds;
        this.permissions = permissions;
    }

    @Override
    public PlanCacheKey getPlanKey() {
        return planKey;
    }

    @Override
    public long getPlanLastUsed() {
        return planLastUsed;
    }

    @Override
    public void onPlanUsed() {
        planLastUsed = System.currentTimeMillis();
    }

    @Override
    public boolean isPlanValid(PlanCheckContext context) {
        return context.isValid(objectIds, partMap);
    }

    @Override
    public void checkPermissions(SqlSecurityContext context) {
        for (Permission permission : permissions) {
            context.checkPermission(permission);
        }
    }

    @Override
    public boolean producesRows() {
        return true;
    }

    public Map getPartitionMap() {
        return partMap;
    }

    public Collection getMemberIds() {
        return partMap.keySet();
    }

    public int getFragmentCount() {
        return fragments.size();
    }

    public PlanNode getFragment(int index) {
        return fragments.get(index);
    }

    public List getFragments() {
        return fragments;
    }

    public PlanFragmentMapping getFragmentMapping(int index) {
        return fragmentMappings.get(index);
    }

    public List getFragmentMappings() {
        return fragmentMappings;
    }

    public Map getOutboundEdgeMap() {
        return outboundEdgeMap;
    }

    public Map getInboundEdgeMap() {
        return inboundEdgeMap;
    }

    public Map getInboundEdgeMemberCountMap() {
        return inboundEdgeMemberCountMap;
    }

    public SqlRowMetadata getRowMetadata() {
        return rowMetadata;
    }

    public QueryParameterMetadata getParameterMetadata() {
        return parameterMetadata;
    }

    public Set getObjectIds() {
        return objectIds;
    }

    public List getPermissions() {
        return permissions;
    }
}