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.asterix.algebra.operators.physical;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import org.apache.asterix.metadata.declared.DataSourceId;
  import org.apache.asterix.metadata.declared.MetadataProvider;
  import org.apache.asterix.metadata.entities.Dataset;
  import org.apache.asterix.om.functions.BuiltinFunctions;
  import org.apache.asterix.optimizer.rules.am.RTreeJobGenParams;
  import org.apache.hyracks.algebricks.common.constraints.AlgebricksPartitionConstraint;
  import org.apache.hyracks.algebricks.common.exceptions.AlgebricksException;
  import org.apache.hyracks.algebricks.common.utils.Pair;
  import org.apache.hyracks.algebricks.core.algebra.base.IHyracksJobBuilder;
  import org.apache.hyracks.algebricks.core.algebra.base.ILogicalExpression;
  import org.apache.hyracks.algebricks.core.algebra.base.ILogicalOperator;
  import org.apache.hyracks.algebricks.core.algebra.base.LogicalExpressionTag;
  import org.apache.hyracks.algebricks.core.algebra.base.LogicalOperatorTag;
  import org.apache.hyracks.algebricks.core.algebra.base.LogicalVariable;
  import org.apache.hyracks.algebricks.core.algebra.base.PhysicalOperatorTag;
  import org.apache.hyracks.algebricks.core.algebra.expressions.AbstractFunctionCallExpression;
  import org.apache.hyracks.algebricks.core.algebra.expressions.IVariableTypeEnvironment;
  import org.apache.hyracks.algebricks.core.algebra.functions.FunctionIdentifier;
  import org.apache.hyracks.algebricks.core.algebra.metadata.IDataSourceIndex;
  import org.apache.hyracks.algebricks.core.algebra.operators.logical.AbstractUnnestMapOperator;
  import org.apache.hyracks.algebricks.core.algebra.operators.logical.IOperatorSchema;
  import org.apache.hyracks.algebricks.core.algebra.operators.logical.LeftOuterUnnestMapOperator;
  import org.apache.hyracks.algebricks.core.algebra.operators.logical.visitors.VariableUtilities;
  import org.apache.hyracks.algebricks.core.algebra.properties.INodeDomain;
  import org.apache.hyracks.algebricks.core.jobgen.impl.JobGenContext;
  import org.apache.hyracks.api.dataflow.IOperatorDescriptor;
  import org.apache.hyracks.api.dataflow.value.IMissingWriterFactory;
  
  /**
   * Contributes the runtime operator for an unnest-map representing a RTree
   * search.
   */
  public class RTreeSearchPOperator extends IndexSearchPOperator {
  
      public RTreeSearchPOperator(IDataSourceIndex<String, DataSourceId> idx, INodeDomain domain,
              boolean requiresBroadcast) {
          super(idx, domain, requiresBroadcast);
      }
  
      @Override
      public PhysicalOperatorTag getOperatorTag() {
          return PhysicalOperatorTag.RTREE_SEARCH;
      }
  
      @Override
      public void contributeRuntimeOperator(IHyracksJobBuilder builder, JobGenContext context, ILogicalOperator op,
              IOperatorSchema opSchema, IOperatorSchema[] inputSchemas, IOperatorSchema outerPlanSchema)
              throws AlgebricksException {
          AbstractUnnestMapOperator unnestMap = (AbstractUnnestMapOperator) op;
          ILogicalExpression unnestExpr = unnestMap.getExpressionRef().getValue();
          if (unnestExpr.getExpressionTag() != LogicalExpressionTag.FUNCTION_CALL) {
              throw new IllegalStateException();
          }
          AbstractFunctionCallExpression unnestFuncExpr = (AbstractFunctionCallExpression) unnestExpr;
          FunctionIdentifier funcIdent = unnestFuncExpr.getFunctionIdentifier();
          if (!funcIdent.equals(BuiltinFunctions.INDEX_SEARCH)) {
              return;
          }
          RTreeJobGenParams jobGenParams = new RTreeJobGenParams();
          jobGenParams.readFromFuncArgs(unnestFuncExpr.getArguments());
          int[] keyIndexes = getKeyIndexes(jobGenParams.getKeyVarList(), inputSchemas);
  
          boolean propagateIndexFilter = unnestMap.propagateIndexFilter();
          IMissingWriterFactory nonFilterWriterFactory = getNonFilterWriterFactory(propagateIndexFilter, context);
          int[] minFilterFieldIndexes = getKeyIndexes(unnestMap.getMinFilterVars(), inputSchemas);
          int[] maxFilterFieldIndexes = getKeyIndexes(unnestMap.getMaxFilterVars(), inputSchemas);
  
          MetadataProvider mp = (MetadataProvider) context.getMetadataProvider();
          Dataset dataset = mp.findDataset(jobGenParams.getDatabaseName(), jobGenParams.getDataverseName(),
                  jobGenParams.getDatasetName());
          IVariableTypeEnvironment typeEnv = context.getTypeEnvironment(unnestMap);
          List<LogicalVariable> outputVars = unnestMap.getVariables();
          if (jobGenParams.getRetainInput()) {
              outputVars = new ArrayList<>();
              VariableUtilities.getLiveVariables(unnestMap, outputVars);
          }
          boolean retainMissing = false;
          IMissingWriterFactory nonMatchWriterFactory = null;
          if (op.getOperatorTag() == LogicalOperatorTag.LEFT_OUTER_UNNEST_MAP) {
              // By nature, LEFT_OUTER_UNNEST_MAP should generate null values for non-matching tuples.
              retainMissing = true;
              nonMatchWriterFactory = getNonMatchWriterFactory(((LeftOuterUnnestMapOperator) unnestMap).getMissingValue(),
                      context, unnestMap.getSourceLocation());
          }
  
          Pair<IOperatorDescriptor, AlgebricksPartitionConstraint> rtreeSearch =
                  mp.getRtreeSearchRuntime(builder.getJobSpec(), outputVars, opSchema, typeEnv, context,
                          jobGenParams.getRetainInput(), retainMissing, nonMatchWriterFactory, dataset,
                          jobGenParams.getIndexName(), keyIndexes, propagateIndexFilter, nonFilterWriterFactory,
                          minFilterFieldIndexes, maxFilterFieldIndexes, unnestMap.getGenerateCallBackProceedResultVar());
          IOperatorDescriptor opDesc = rtreeSearch.first;
          opDesc.setSourceLocation(unnestMap.getSourceLocation());
  
          builder.contributeHyracksOperator(unnestMap, opDesc);
          builder.contributeAlgebricksPartitionConstraint(opDesc, rtreeSearch.second);
          ILogicalOperator srcExchange = unnestMap.getInputs().get(0).getValue();
          builder.contributeGraphEdge(srcExchange, 0, unnestMap, 0);
      }
  }
  