connector/expressions/Transform.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.sql.connector.expressions;
0019
0020 import org.apache.spark.annotation.Evolving;
0021
0022 /**
0023  * Represents a transform function in the public logical expression API.
0024  * <p>
0025  * For example, the transform date(ts) is used to derive a date value from a timestamp column. The
0026  * transform name is "date" and its argument is a reference to the "ts" column.
0027  *
0028  * @since 3.0.0
0029  */
0030 @Evolving
0031 public interface Transform extends Expression {
0032   /**
0033    * Returns the transform function name.
0034    */
0035   String name();
0036
0037   /**
0038    * Returns all field references in the transform arguments.
0039    */
0040   NamedReference[] references();
0041
0042   /**
0043    * Returns the arguments passed to the transform function.
0044    */
0045   Expression[] arguments();
0046 }