org.neo4j.cypher.internal.logical.plans.Input.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.cypher.internal.logical.plans

import org.neo4j.cypher.internal.util.attribution.IdGen

/**
 * Produce rows from a query state input stream. Only one input operator can
 * exist per logical plan tree, and it has to be the left-most leaf.
 *
 * @param nullable if there can be null values among the nodes, relationships or variables
 */
case class Input(nodes: Seq[String], relationships: Seq[String], variables: Seq[String], nullable: Boolean)(implicit idGen: IdGen) extends LogicalLeafPlan(idGen) {
  val availableSymbols: Set[String] = nodes.toSet ++ relationships.toSet ++ variables.toSet
  override def argumentIds: Set[String] = Set.empty
  override def usedVariables: Set[String] = Set.empty
  override def withoutArgumentIds(argsToExclude: Set[String]): Input = this
  override def addArgumentIds(argsToAdd: Set[String]): LogicalLeafPlan = this
}

object Input {

  def apply(variables: Seq[String])(implicit idGen: IdGen): Input = new Input(Seq.empty, Seq.empty, variables, true)(idGen)
}