de.chandre.admintool.db.AdminToolDBBrowserService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of admin-tools-dbbrowser Show documentation

admin-tools database browser

There is a newer version: 1.1.7.3

Show newest version

package de.chandre.admintool.db;

import java.sql.Connection;
import java.sql.SQLException;
import java.util.List;
import java.util.Map;

import javax.sql.DataSource;

/**
 * data source service interface
 * @author Andre
 *
 */
public interface AdminToolDBBrowserService 
{
	/**
	 * 
	 * @param datasources
	 */
	void setDatasources(Map datasources);
	
	/**
	 * @return all data sources associated with spring context
	 */
	List getDatasourceNames();
	
	/**
	 * gets a connection from datasource and sets autoCommit to false and readonly to true if DML is not allowed
	 * 
	 * @param datasourceName
	 * @param vars
	 * @return
	 * @throws SQLException
	 */
	Connection getConnection(String datasourceName, ConnectionVars vars) throws SQLException;

	/**
	 * close the connection and does a rollback if DML is not allowed. furthermore original values for autoCommit and readonly will be set.
	 * 
	 * @param c
	 * @param vars
	 */
	void closeConnection(Connection c, ConnectionVars vars);
	
	/**
	 * 
	 * @param datasourceName
	 * @return some datasource metdata
	 */
	QueryResultTO getMetadata(String datasourceName);

	/**
	 * queries database with specified statementTO and returns the QueryResultTO
	 * 
	 * @param statementTO
	 * @return
	 */
	QueryResultTO queryDatabase(StatementTO statementTO);

	/**
	 * 
	 * @param statementTO
	 * @param id html id value for element
	 * @return id_statementTO.tab or id_1 as default
	 */
	String getTab(StatementTO statementTO, String id);

	/**
	 * returns the clusters of examples for vendor. if statementTO is null first data source will be used.
	 * @param statementTO
	 * @return
	 */
	Map> getExamplesForDatasource(StatementTO statementTO);
}