org.yamj.core.api.model.builder.SqlScalars.java Source code

Introduction

Here is the source code for org.yamj.core.api.model.builder.SqlScalars.java

Source

/*
 *      Copyright (c) 2004-2015 YAMJ Members
 *      https://github.com/organizations/YAMJ/teams
 *
 *      This file is part of the Yet Another Media Jukebox (YAMJ).
 *
 *      YAMJ is free software: you can redistribute it and/or modify
 *      it under the terms of the GNU General Public License as published by
 *      the Free Software Foundation, either version 3 of the License, or
 *      any later version.
 *
 *      YAMJ 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 General Public License for more details.
 *
 *      You should have received a copy of the GNU General Public License
 *      along with YAMJ.  If not, see <http://www.gnu.org/licenses/>.
 *
 *      Web: https://github.com/YAMJ/yamj-v3
 *
 */
package org.yamj.core.api.model.builder;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import org.apache.commons.lang3.StringUtils;
import org.hibernate.SQLQuery;
import org.hibernate.Session;
import org.hibernate.type.BasicType;

/**
 * Builds a SQL statement and holds the scalars for the statement
 *
 * @author Stuart
 */
public final class SqlScalars {

    private StringBuilder sql;
    private Map<String, BasicType> scalars;
    private final Map<String, Object> parameters;
    private SQLQuery query = null;

    public SqlScalars() {
        this.sql = new StringBuilder();
        this.scalars = new HashMap<>();
        this.parameters = new HashMap<>();
    }

    public SqlScalars(StringBuilder sql) {
        this.sql = sql;
        this.scalars = new HashMap<>();
        this.parameters = new HashMap<>();
    }

    public SqlScalars(String sql) {
        setSql(sql);
        this.scalars = new HashMap<>();
        this.parameters = new HashMap<>();
    }

    public SqlScalars(StringBuilder sql, Map<String, BasicType> scalars) {
        this.sql = sql;
        this.scalars = scalars;
        this.parameters = new HashMap<>();
    }

    /**
     * Set the SQL
     *
     * @param sql
     */
    public void setSql(StringBuilder sql) {
        this.sql = sql;
    }

    /**
     * Set the SQL using a string
     *
     * @param sql
     */
    public void setSql(String sql) {
        this.sql = new StringBuilder(sql);
    }

    /**
     * Append a line to the SQL.
     *
     * Will add a space at the end of the line
     *
     * @param line
     */
    public void addToSql(String line) {
        sql.append(line);
        if (!line.endsWith(" ")) {
            sql.append(" ");
        }
    }

    /**
     * Get the SQL as a string
     *
     * @return
     */
    public String getSql() {
        return StringUtils.normalizeSpace(sql.toString());
    }

    /**
     * Get the SQL as a query using the session
     *
     * @param session
     * @return
     */
    @SuppressWarnings("rawtypes")
    public SQLQuery createSqlQuery(Session session) {
        if (this.query == null) {
            this.query = session.createSQLQuery(getSql());
            // Add parameters
            if (parameters != null) {
                for (Map.Entry<String, Object> entry : parameters.entrySet()) {
                    if (entry.getValue() instanceof Collection) {
                        query.setParameterList(entry.getKey(), (Collection) entry.getValue());
                    } else if (entry.getValue() instanceof Object[]) {
                        query.setParameterList(entry.getKey(), (Object[]) entry.getValue());
                    } else {
                        query.setParameter(entry.getKey(), entry.getValue());
                    }
                }
            }
        }
        return this.query;
    }

    /**
     * Add a parameter to the query
     *
     * @param param
     * @param value
     */
    public void addParameter(String param, Object value) {
        this.parameters.put(param, value);
    }

    /**
     * Clear the SQL
     */
    public void clear() {
        sql = new StringBuilder();
        parameters.clear();
        scalars.clear();
    }

    /**
     * Get the scalars for the query
     *
     * @return
     */
    public Map<String, BasicType> getScalars() {
        return scalars;
    }

    /**
     * Set the scalars for the query
     *
     * @param scalars
     */
    public void setScalars(Map<String, BasicType> scalars) {
        this.scalars = scalars;
    }

    /**
     * Add a scalar with a default type
     *
     * @param scalar
     */
    public void addScalar(String scalar) {
        this.scalars.put(scalar, null);
    }

    /**
     * Add a scalar with type
     *
     * @param scalar
     * @param type
     */
    public void addScalar(String scalar, BasicType type) {
        this.scalars.put(scalar, type);
    }

    /**
     * Add the scalars to the query
     *
     * @param query
     */
    public void populateScalars(SQLQuery query) {
        if (scalars != null && !scalars.isEmpty()) {
            for (Map.Entry<String, BasicType> entry : scalars.entrySet()) {
                if (entry.getValue() == null) {
                    // Use the default scalar for that entry
                    query.addScalar(entry.getKey());
                } else {
                    // Use the passed scalar type
                    query.addScalar(entry.getKey(), entry.getValue());
                }
            }
        }
    }
}