SQLDatabaseMapping.java

/*
 * Copyright (c) 2009, SQL Power Group Inc.
 *
 * This file is part of SQL Power Library.
 *
 * SQL Power Library 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
 * (at your option) any later version.
 *
 * SQL Power Library 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 this program.  If not, see <http://www.gnu.org/licenses/>. 
 */

package ca.sqlpower.sqlobject;

import ca.sqlpower.sql.JDBCDataSource;
import ca.sqlpower.sql.SPDataSource;

/**
 * Classes that implement this interface have a specific {@link SQLDatabase}
 * defined for each {@link SPDataSource} object, or need to create a {@link SQLDatabase}
 * for new {@link SPDataSource} objects.
 */
public interface SQLDatabaseMapping {

	/**
	 * Returns the {@link SQLDatabase} associated with this {@link JDBCDataSource}.
	 * If the data source does not exist it will be added to the {@link SQLDatabase}
	 * list.
	 */
	public SQLDatabase getDatabase(JDBCDataSource ds);
}