* AnyChildWithRestMatcher.java
 * This source file is part of the FoundationDB open source project
 * Copyright 2015-2019 Apple Inc. and the FoundationDB project 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,
 * See the License for the specific language governing permissions and
 * limitations under the License.

package com.apple.foundationdb.record.query.plan.temp.matchers;

import com.apple.foundationdb.annotation.API;
import com.apple.foundationdb.record.RecordCoreException;
import com.apple.foundationdb.record.query.plan.temp.Bindable;
import com.apple.foundationdb.record.query.predicates.QueryPredicate;

import javax.annotation.Nonnull;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Stream;

 * An expression matcher that tries to match any child to the given {@link ExpressionMatcher} while providing a
 * {@link ReferenceMatcher} binding to all other children. This can be quite useful when matching to a planner
 * expression that might have an unbounded number of children when a planner rule wants to inspect exactly one of those
 * children deeply. This matcher might produce several possible bindings because the {@code ExpressionMatcher} for the
 * distinguished child might match several children.
public class AnyChildWithRestMatcher implements ExpressionChildrenMatcher {
    private ExpressionMatcher<? extends QueryPredicate> selectedChildMatcher;
    private AllChildrenMatcher otherChildrenMatcher;

    private AnyChildWithRestMatcher(@Nonnull ExpressionMatcher<? extends QueryPredicate> selectedChildMatcher,
                                    @Nonnull ExpressionMatcher<QueryPredicate> otherChildrenMatcher) {
        this.selectedChildMatcher = selectedChildMatcher;
        this.otherChildrenMatcher = new AllChildrenMatcher(otherChildrenMatcher);

    public Stream<PlannerBindings> matches(@Nonnull List<? extends Bindable> children) {
        Stream.Builder<Stream<PlannerBindings>> streams = Stream.builder();
        for (int i = 0; i < children.size(); i++) {
            Bindable child = children.get(i);
            List<Bindable> otherChildren = new ArrayList<>(children.size() - 1);
            otherChildren.addAll(children.subList(0, i));
            otherChildren.addAll(children.subList(i + 1, children.size()));

            Stream<PlannerBindings> childBindings = child.bindTo(selectedChildMatcher);
            // The otherChildrenMatcher is an AllChildrenMatcher wrapping a ReferenceMatcher, so it is guaranteed to
            // produce a single set of PlannerBindings.
            Optional<PlannerBindings> otherBindings = otherChildrenMatcher.matches(otherChildren).findFirst();
            if (!otherBindings.isPresent()) {
                throw new RecordCoreException("invariant violated: couldn't match reference matcher to one of the other children");
            streams.add(childBindings.map(selectedBindings -> selectedBindings.mergedWith(otherBindings.get())));
        return streams.build().flatMap(Function.identity());

    public static <T extends Bindable> AnyChildWithRestMatcher anyMatchingWithRest(
            @Nonnull ExpressionMatcher<? extends QueryPredicate> selectedChildMatcher,
            @Nonnull ExpressionMatcher<QueryPredicate> otherChildrenMatcher) {
        return new AnyChildWithRestMatcher(selectedChildMatcher, otherChildrenMatcher);