/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2010, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.dialect.function;

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

import org.hibernate.dialect.Dialect;

Defines a registry for SQLFunction instances
Author:
Steve Ebersole/**
 * Defines a registry for SQLFunction instances
 *
 * @author Steve Ebersole
 */
public class SQLFunctionRegistry {
	private final Dialect dialect;
	private final Map<String, SQLFunction> userFunctions;

	
Constructs a SQLFunctionRegistry
Params:
dialect – The dialect
userFunctions – Any application-supplied function definitions/**
	 * Constructs a SQLFunctionRegistry
	 *
	 * @param dialect The dialect
	 * @param userFunctions Any application-supplied function definitions
	 */
	public SQLFunctionRegistry(Dialect dialect, Map<String, SQLFunction> userFunctions) {
		this.dialect = dialect;
		this.userFunctions = new HashMap<String, SQLFunction>( userFunctions );
	}

	
Find a SQLFunction by name
Params:
functionName – The name of the function to locate
Returns:
The located function, maye return null/**
	 * Find a SQLFunction by name
	 *
	 * @param functionName The name of the function to locate
	 *
	 * @return The located function, maye return {@code null}
	 */
	public SQLFunction findSQLFunction(String functionName) {
		final String name = functionName.toLowerCase(Locale.ROOT);
		final SQLFunction userFunction = userFunctions.get( name );
		return userFunction != null
				? userFunction
				: dialect.getFunctions().get( name );
	}

	
Does this registry contain the named function
Params:
functionName – The name of the function to attempt to locate
Returns:
true if the registry contained that function/**
	 * Does this registry contain the named function
	 *
	 * @param functionName The name of the function to attempt to locate
	 *
	 * @return {@code true} if the registry contained that function
	 */
	@SuppressWarnings("UnusedDeclaration")
	public boolean hasFunction(String functionName) {
		final String name = functionName.toLowerCase(Locale.ROOT);
		return userFunctions.containsKey( name ) || dialect.getFunctions().containsKey( name );
	}

}