org.apache.flink.table.client.config.UserDefinedFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-sql-client Show documentation

There is a newer version: 2.0-preview1

/*
 * 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.flink.table.client.config;

import org.apache.flink.table.client.SqlClientException;
import org.apache.flink.table.descriptors.DescriptorProperties;
import org.apache.flink.table.descriptors.FunctionDescriptor;

import java.util.HashMap;
import java.util.Map;

/**
 * Descriptor for user-defined functions.
 */
public class UserDefinedFunction extends FunctionDescriptor {

	private String name;
	private Map properties;

	private static final String NAME = "name";

	private UserDefinedFunction(String name, Map properties) {
		this.name = name;
		this.properties = properties;
	}

	public String getName() {
		return name;
	}

	public Map getProperties() {
		return properties;
	}

	/**
	 * Creates a user-defined function descriptor with the given config.
	 */
	public static UserDefinedFunction create(Map config) {
		if (!config.containsKey(NAME)) {
			throw new SqlClientException("The 'name' attribute of a function is missing.");
		}
		final Object name = config.get(NAME);
		if (name == null || !(name instanceof String) || ((String) name).trim().length() <= 0) {
			throw new SqlClientException("Invalid function name '" + name + "'.");
		}
		final Map properties = new HashMap<>(config);
		properties.remove(NAME);
		return new UserDefinedFunction((String) name, ConfigUtil.normalizeYaml(properties));
	}

	// --------------------------------------------------------------------------------------------

	@Override
	public void addProperties(DescriptorProperties properties) {
		this.properties.forEach(properties::putString);
	}
}