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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-cypher-logical-plans Show documentation

Cypher logical plans

There is a newer version: 5.25.1

Show newest version

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://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.expressions.CachedProperty
import org.neo4j.cypher.internal.expressions.EntityType
import org.neo4j.cypher.internal.expressions.LogicalVariable
import org.neo4j.cypher.internal.expressions.PropertyKeyName
import org.neo4j.cypher.internal.expressions.PropertyKeyToken
import org.neo4j.cypher.internal.expressions.Variable
import org.neo4j.cypher.internal.util.InputPosition

case class IndexedProperty(
  propertyKeyToken: PropertyKeyToken,
  getValueFromIndex: GetValueFromIndexBehavior,
  entityType: EntityType
) {
  def shouldGetValue: Boolean = getValueFromIndex == GetValue

  def asCachedProperty(node: String): CachedProperty = asCachedProperty(Variable(node)(InputPosition.NONE))

  def asCachedProperty(node: LogicalVariable): CachedProperty =
    CachedProperty(
      node,
      node,
      PropertyKeyName(propertyKeyToken.name)(InputPosition.NONE),
      entityType
    )(InputPosition.NONE)

  def maybeCachedProperty(entity: LogicalVariable): Option[CachedProperty] =
    if (shouldGetValue)
      Some(asCachedProperty(entity))
    else None

  def propertyKeyId: Int = propertyKeyToken.nameId.id
}

// This can be extended later on with: GetValuesPartially
sealed trait GetValueFromIndexBehavior
case object DoNotGetValue extends GetValueFromIndexBehavior
case object CanGetValue extends GetValueFromIndexBehavior
case object GetValue extends GetValueFromIndexBehavior