/*
 * Copyright (c) 2017-2021 Nitrite author or authors.
 *
 * 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 org.dizitart.no2.collection;

import lombok.Data;
import org.dizitart.no2.common.SortOrder;
import org.dizitart.no2.common.tuples.Pair;
import org.dizitart.no2.filters.FieldBasedFilter;
import org.dizitart.no2.filters.Filter;
import org.dizitart.no2.filters.IndexScanFilter;
import org.dizitart.no2.index.IndexDescriptor;

import java.text.Collator;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

/**
 * Represents an execution plan of a find operation after optimization.
 *
 * @author Anindya Chatterjee
 * @since 4.0.0
 */
@Data
public class FindPlan {
    private FieldBasedFilter byIdFilter;
    private IndexScanFilter indexScanFilter;
    private Filter collectionScanFilter;

    private IndexDescriptor indexDescriptor;
    private Map<String, Boolean> indexScanOrder;
    private List<Pair<String, SortOrder>> blockingSortOrder;

    private Long skip;
    private Long limit;
    private boolean distinct;

    private Collator collator;

    private List<FindPlan> subPlans;

    /**
     * Instantiates a new {@link FindPlan}.
     */
    public FindPlan() {
        this.subPlans = new ArrayList<>();
        this.blockingSortOrder = new ArrayList<>();
    }
}
