001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.db;
029
030import java.sql.PreparedStatement;
031import java.sql.SQLException;
032import java.util.List;
033
034/**
035 * Generic database utility functions.<p>
036 *
037 * @since 8.0.0
038 */
039public final class CmsDbUtil {
040
041    /**
042     * Private constructor for static utility class.<p>
043     */
044    private CmsDbUtil() {
045
046        // do nothing
047
048    }
049
050    /**
051     * Creates an expression for comparing a column with a constant.<p>
052     *
053     * @param column the column name
054     * @param o the constant
055     *
056     * @return the query expression
057     */
058    public static CmsSimpleQueryFragment columnEquals(String column, Object o) {
059
060        return new CmsSimpleQueryFragment(column + " = ?", o);
061    }
062
063    /**
064     * Creates an expression for matching a column with a constant pattern.<p>
065     *
066     * @param column the column name
067     * @param str the pattern string
068     *
069     * @return the query expression
070     */
071    public static CmsSimpleQueryFragment columnLike(String column, String str) {
072
073        return new CmsSimpleQueryFragment(column + " LIKE ? ", str);
074    }
075
076    /**
077     * Fills a given prepared statement with parameters from a list of objects.<p>
078     *
079     * @param stmt the prepared statement
080     * @param params the parameter objects
081     *
082     * @throws SQLException if something goes wrong
083     */
084    public static void fillParameters(PreparedStatement stmt, List<Object> params) throws SQLException {
085
086        int i = 1;
087        for (Object param : params) {
088            if (param instanceof String) {
089                stmt.setString(i, (String)param);
090            } else if (param instanceof Integer) {
091                stmt.setInt(i, ((Integer)param).intValue());
092            } else if (param instanceof Long) {
093                stmt.setLong(i, ((Long)param).longValue());
094            } else {
095                throw new IllegalArgumentException();
096            }
097            i += 1;
098        }
099    }
100}