org.hibernate.dialect.function.NoArgSQLFunction.java Source code

Introduction

Here is the source code for org.hibernate.dialect.function.NoArgSQLFunction.java

Source

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.dialect.function;

import java.util.List;

import org.hibernate.QueryException;
import org.hibernate.engine.spi.Mapping;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.type.Type;

/**
 * A function which takes no arguments
 *
 * @author Michi
 */
public class NoArgSQLFunction implements SQLFunction {
    private Type returnType;
    private boolean hasParenthesesIfNoArguments;
    private String name;

    /**
     * Constructs a NoArgSQLFunction
     *
     * @param name The function name
     * @param returnType The function return type
     */
    public NoArgSQLFunction(String name, Type returnType) {
        this(name, returnType, true);
    }

    /**
     * Constructs a NoArgSQLFunction
     *
     * @param name The function name
     * @param returnType The function return type
     * @param hasParenthesesIfNoArguments Does the function call need parenthesis if there are no arguments?
     */
    public NoArgSQLFunction(String name, Type returnType, boolean hasParenthesesIfNoArguments) {
        this.returnType = returnType;
        this.hasParenthesesIfNoArguments = hasParenthesesIfNoArguments;
        this.name = name;
    }

    @Override
    public boolean hasArguments() {
        return false;
    }

    @Override
    public boolean hasParenthesesIfNoArguments() {
        return hasParenthesesIfNoArguments;
    }

    @Override
    public Type getReturnType(Type argumentType, Mapping mapping) throws QueryException {
        return returnType;
    }

    @Override
    public String render(Type argumentType, List args, SessionFactoryImplementor factory) throws QueryException {
        if (args.size() > 0) {
            throw new QueryException("function takes no arguments: " + name);
        }
        return hasParenthesesIfNoArguments ? name + "()" : name;
    }

    protected String getName() {
        return name;
    }
}