com.jpattern.orm.script.ScriptExecutor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jporm Show documentation

There is a newer version: 6.3.0

package com.jpattern.orm.script;

import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;

import com.jpattern.orm.exception.OrmException;

/**
 * 
 * @author Francesco Cina
 *
 * 02/lug/2011
 * 
 * Executes statements from a standard sql script;
 * The script can contain comments using the double hyphen symbol -- only if the comment is the 
 * only thing in a row, e.g.:
 * this is valid:
 *     insert into TABLE_NAME 
 *     -- valid comment
 *     values (1,2,3);
 * this isn't valid:
 *     insert into TABLE_NAME -- NOT valid comment, this can break the parser!!
 *     values (1,2,3);
 * 
 */
public interface ScriptExecutor {

	/**
	 * Executes the script.
	 * @param script
	 */
	void execute(String script) throws OrmException;
	
	
	/**
	 * Executes the script.
	 * @param script
	 */
	void execute(InputStream scriptStream) throws IOException, OrmException;
	
	/**
	 * Executes the script.
	 * The passed Charset will be used to read the stream.
	 * @param script
	 * @param charset
	 */
	void execute(InputStream scriptStream, Charset charset) throws IOException, OrmException;
	
}