TimetablesDbAdapter.java

/**
 * Copyright (c) 2011 Christine Gerpheide <christine.ger@pheide.com>
 * 
 * This code is distributed under the MIT License. Please see LICENSE.txt
 * for more details.
 */

package com.pheide.trainose;

import android.content.ContentValues;
import android.content.Context;
import android.database.Cursor;
import android.database.SQLException;

/**
 * DbAdapter to handle the timetables table.
 * 
 * @author Christine Gerpheide
 */
public class TimetablesDbAdapter extends AbstractDbAdapter {

	public static final String KEY_ROWID = "_id";
	public static final String KEY_ROUTE = "route_id";
	public static final String KEY_DEPART = "depart";
	public static final String KEY_ARRIVE = "arrive";
	public static final String KEY_DURATION = "duration";
	public static final String KEY_TRAIN = "train";
	public static final String KEY_TRAIN_NUM = "train_num";
	public static final String KEY_DELAY = "delay";
	public static final String KEY_NUM_LEGS = "num_legs";

    private static final String DATABASE_TABLE = "timetables";

    /**
     * Constructor - takes the context to allow the database to be
     * opened/created
     * 
     * @param ctx the Context within which to work
     */
    public TimetablesDbAdapter(Context ctx) {
    	super(ctx);
    }
    
    /**
     * Create a new timetable.
     * 
     * @param routeId
     * @param depart
     * @param arrive
     * @param train
     * @param trainNum
     * @param numLegs
     * @param delay
     * @return rowId or -1 if failed
     */
    public long create(long routeId, String depart, String arrive, 
    		String duration, String train, String trainNum, int numLegs,
    		String delay) {
    	ContentValues args = new ContentValues();
    	args.put(KEY_ROUTE,routeId);
    	args.put(KEY_DEPART,depart);
    	args.put(KEY_ARRIVE,arrive);
    	args.put(KEY_DURATION,duration);
    	args.put(KEY_TRAIN,train);
    	args.put(KEY_TRAIN_NUM,trainNum);
    	args.put(KEY_NUM_LEGS,numLegs);
    	args.put(KEY_DELAY, delay);
    	
    	return mDb.insert(DATABASE_TABLE, null,args);
    }
    

    /**
     * Delete the timetable with the given rowId
     * 
     * @param rowId
     * @return true if deleted, false otherwise
     */
    public boolean delete(long rowId) {
    	return mDb.delete(DATABASE_TABLE, KEY_ROWID + "=" + rowId, null) > 0;
    }
    
    /**
     * Delete the timetables with the given routeId
     * 
     * @param routeId the route to delete timetables for
     * @return true if deleted, false otherwise
     */
    public boolean deleteByRoute(long routeId) {
    	return mDb.delete(DATABASE_TABLE, KEY_ROUTE + "=" + routeId, null) > 0;
    }

    /**
     * Return a Cursor over the list of all routes in the database
     * 
     * @return Cursor over all notes
     */
    public Cursor fetchAll() {
    	return mDb.query(DATABASE_TABLE, new String[] {"*"}, 
    			null, null, null, null, null);
    }

    /**
     * Return a Cursor positioned at the timetable that matches the given rowId
     * 
     * @param rowId id of route to retrieve
     * @return Cursor positioned to matching route, if found
     * @throws SQLException if route could not be found/retrieved
     */
    public Cursor fetch(long rowId) throws SQLException {
        Cursor mCursor =
            mDb.query(true, DATABASE_TABLE, new String[] {"*"}, 
        			KEY_ROWID + "=" + rowId, null, null, null, null, null);
        if (mCursor != null) {
            mCursor.moveToFirst();
        }
        return mCursor;
    }
    
    /**
     * Return a Cursor positioned at the timetables that match a given route ID
     * 
     * @param rowId id of route to retrieve
     * @return Cursor positioned to matching route, if found
     * @throws SQLException if route could not be found/retrieved
     */
    public Cursor fetchByRoute(long routeId) throws SQLException {
        return this.fetchByRouteSorted(routeId, KEY_DEPART);
    }
    
    /**
     * Return a Cursor positioned at the timetables that match a given route ID
     * 
     * @param rowId id of route to retrieve
     * @param sorting
     * @return Cursor positioned to matching route, if found
     * @throws SQLException if route could not be found/retrieved
     */
    public Cursor fetchByRouteSorted(long routeId, String sorting) throws SQLException {
        Cursor mCursor =
            mDb.query(true, DATABASE_TABLE, new String[] {"*"}, 
        			KEY_ROUTE + "=" + routeId, null, null, null, sorting, null);
        if (mCursor != null) {
            mCursor.moveToFirst();
        }
        return mCursor;
    }
}