org.opencypher.v9_0.expressions.functions.Substring.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of expressions-9.0 Show documentation

Cypher expressions

The newest version!

/*
 * Copyright (c) Neo4j Sweden AB (http://neo4j.com)
 *
 * 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,
 * 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.opencypher.v9_0.expressions.functions

import org.opencypher.v9_0.expressions.FunctionTypeSignature
import org.opencypher.v9_0.util.symbols.CTInteger
import org.opencypher.v9_0.util.symbols.CTString

case object Substring extends Function {
  def name = "substring"

  override val signatures = Vector(
     FunctionTypeSignature(function = this, names = Vector("original","start"), argumentTypes = Vector(CTString, CTInteger),
      outputType = CTString, description =  "Returns a substring of the original string, beginning with a 0-based index start.", category = Category.STRING),
     FunctionTypeSignature(function = this, names = Vector("original","start", "length"), argumentTypes = Vector(CTString, CTInteger, CTInteger),
      outputType = CTString, description = "Returns a substring of length 'length' of the original string, beginning with a 0-based index start.", category = Category.STRING)
  )
}