com.megatome.j2d.support.DBSupport Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javadoc2dash-api Show documentation
API for creating Dash docsets from Javadoc
The newest version!
/**
 * Copyright 2015 Megatome Technologies, LLC
 *
 * Licensed 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 com.megatome.j2d.support;

import com.megatome.j2d.exception.BuilderException;
import com.megatome.j2d.util.SearchIndexValue;

import java.sql.*;
import java.util.List;

import static com.megatome.j2d.util.LogUtility.logVerbose;
import static org.apache.commons.io.FilenameUtils.concat;

/**
 * Utility class for SQLite DB manipulation of the docset.
 */
public final class DBSupport {
    private static final String DB_FILE = "docSet.dsidx";

    private DBSupport() {}

    private static final String CREATE_INDEX_SQL = "CREATE TABLE searchIndex(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT)";
    private static final String INSERT_INDEX_SQL = "INSERT INTO searchIndex(name, type, path) VALUES (?, ?, ?)";

    /**
     * Create a new DB file, and insert all of the specified index values.
     * @param indexValues Index values to insert into the DB
     * @param dbFileDir Directory to create the DB file in.
     * @throws BuilderException
     */
    public static void createIndex(List indexValues, String dbFileDir) throws BuilderException {

        final String dbFile = concat(dbFileDir, DB_FILE);
        // Create DB file
        try (final Connection connection = DriverManager.getConnection("jdbc:sqlite:" + dbFile);
             final Statement stmt = connection.createStatement()){
            stmt.execute(CREATE_INDEX_SQL);
            // Update DB
            try (final PreparedStatement pst = connection.prepareStatement(INSERT_INDEX_SQL)) {
                for (final SearchIndexValue value : indexValues) {
                    pst.setString(1, value.getName());
                    pst.setString(2, value.getType().getTypeName());
                    pst.setString(3, value.getPath());
                    pst.execute();
                }
            }
        } catch (SQLException e) {
            throw new BuilderException("Error writing to SQLite DB", e);
        }
        logVerbose("Created the SQLite search index");
    }
}