content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to you 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.apache.calcite.rel.mutable;
  
  import org.apache.calcite.rel.core.CorrelationId;
  import org.apache.calcite.rel.core.JoinRelType;
  import org.apache.calcite.rel.type.RelDataType;
  import org.apache.calcite.rex.RexNode;
  
  import org.checkerframework.checker.nullness.qual.Nullable;
  
  import java.util.Objects;
  import java.util.Set;
  
  /** Mutable equivalent of {@link org.apache.calcite.rel.core.Join}. */
  public class MutableJoin extends MutableBiRel {
    public final RexNode condition;
    public final Set<CorrelationId> variablesSet;
    public final JoinRelType joinType;
  
    private MutableJoin(
        RelDataType rowType,
        MutableRel left,
        MutableRel right,
        RexNode condition,
        JoinRelType joinType,
        Set<CorrelationId> variablesSet) {
      super(MutableRelType.JOIN, left.cluster, rowType, left, right);
      this.condition = condition;
      this.variablesSet = variablesSet;
      this.joinType = joinType;
    }
  
    /**
     * Creates a MutableJoin.
     *
     * @param rowType           Row type
     * @param left              Left input relational expression
     * @param right             Right input relational expression
     * @param condition         Join condition
     * @param joinType          Join type
     * @param variablesStopped  Set of variables that are set by the LHS and
     *                          used by the RHS and are not available to
     *                          nodes above this join in the tree
     */
    public static MutableJoin of(RelDataType rowType, MutableRel left,
        MutableRel right, RexNode condition, JoinRelType joinType,
        Set<CorrelationId> variablesStopped) {
      return new MutableJoin(rowType, left, right, condition, joinType,
          variablesStopped);
    }
  
    @Override public boolean equals(@Nullable Object obj) {
      return obj == this
          || obj instanceof MutableJoin
          && joinType == ((MutableJoin) obj).joinType
          && condition.equals(((MutableJoin) obj).condition)
          && Objects.equals(variablesSet,
              ((MutableJoin) obj).variablesSet)
          && left.equals(((MutableJoin) obj).left)
          && right.equals(((MutableJoin) obj).right);
    }
  
    @Override public int hashCode() {
      return Objects.hash(left, right, condition, joinType, variablesSet);
    }
  
    @Override public StringBuilder digest(StringBuilder buf) {
      return buf.append("Join(joinType: ").append(joinType)
          .append(", condition: ").append(condition)
          .append(")");
    }
  
    @Override public MutableRel clone() {
      return MutableJoin.of(rowType, left.clone(),
          right.clone(), condition, joinType, variablesSet);
    }
  }
  