org.droidparts.persist.sql.AbstractDBOpenHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of droidparts Show documentation
There is a newer version: 3.2.5
/**
 * Copyright 2013 Alex Yanchenko
 * 
 * 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 org.droidparts.persist.sql;

import static org.droidparts.inner.FieldSpecRegistry.getTableColumnSpecs;
import static org.droidparts.inner.FieldSpecRegistry.getTableName;

import java.util.ArrayList;

import org.droidparts.contract.SQL;
import org.droidparts.inner.PersistUtils;
import org.droidparts.model.Entity;

import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;

public abstract class AbstractDBOpenHelper extends SQLiteOpenHelper implements
		SQL.DDL {

	private final Context ctx;

	public AbstractDBOpenHelper(Context ctx, String name, int version) {
		super(ctx.getApplicationContext(), name, null, version);
		this.ctx = ctx.getApplicationContext();
	}

	public Context getContext() {
		return ctx;
	}

	protected abstract void onCreateTables(SQLiteDatabase db);

	protected void onOpenExtra(SQLiteDatabase db) {
	}

	// helpers

	protected final boolean createIndex(SQLiteDatabase db, String table,
			boolean unique, String firstColumn, String... otherColumns) {
		ArrayList statements = new ArrayList();
		statements.add(PersistUtils.getCreateIndex(table, unique, firstColumn,
				otherColumns));
		return executeStatements(db, statements);
	}

	protected final boolean createTables(SQLiteDatabase db,
			Class... entityClasses) {
		ArrayList statements = new ArrayList();
		for (Class cls : entityClasses) {
			String query = PersistUtils.getSQLCreate(getTableName(cls),
					getTableColumnSpecs(cls));
			statements.add(query);
		}
		return executeStatements(db, statements);
	}

	protected final boolean addMissingColumns(SQLiteDatabase db,
			Class... entityClasses) {
		ArrayList statements = new ArrayList();
		for (Class cls : entityClasses) {
			statements.addAll(PersistUtils.getAddMissingColumns(db, cls));
		}
		return executeStatements(db, statements);
	}

	protected final boolean dropTables(SQLiteDatabase db,
			String... optionalTableNames) {
		ArrayList statements = PersistUtils.getDropTables(db,
				optionalTableNames);
		return executeStatements(db, statements);
	}

	protected final boolean executeStatements(SQLiteDatabase db,
			ArrayList statements) {
		return PersistUtils.executeStatements(db, statements);
	}

	//

	@Override
	public final void onCreate(SQLiteDatabase db) {
		onOpen(db);
		onCreateTables(db);
	}

	@Override
	public final void onOpen(SQLiteDatabase db) {
		if (!db.isReadOnly()) {
			db.execSQL("PRAGMA foreign_keys = ON;");
		}
		onOpenExtra(db);
	}

}