Package scriptella.driver.text

Class TextConnection

java.lang.Object

scriptella.spi.AbstractConnection

scriptella.driver.text.AbstractTextConnection

scriptella.driver.text.TextConnection

All Implemented Interfaces:

Connection

public class TextConnection
extends AbstractTextConnection

Represents a connection to a Text file.

For configuration details and examples see overview page.

Version:

1.0

Author:

Fyodor Kupolov

Nested Class Summary

Nested classes/interfaces inherited from class scriptella.spi.AbstractConnection

AbstractConnection.StatementCounter

Field Summary

Fields inherited from class scriptella.driver.text.AbstractTextConnection

ENCODING, EOL, FLUSH, FORMAT_PREFIX, NULL_STRING, SKIP_LINES, TRIM

Fields inherited from class scriptella.spi.AbstractConnection

counter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextConnection()	For testing purposes only.
	TextConnection(ConnectionParameters parameters)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the connection and releases all related resources.
void	executeQuery(Resource queryContent, ParametersCallback parametersCallback, QueryCallback queryCallback)	Executes a query specified by its content.
void	executeScript(Resource scriptContent, ParametersCallback parametersCallback)	Executes a script specified by its content.
AbstractConnection.StatementCounter	getProgressCounter()	Optional live progress counter.
protected void	initOut()	Lazily initializes script writer.

Methods inherited from class scriptella.driver.text.AbstractTextConnection

getConnectionParameters, newInputReader, newOutputWriter

Methods inherited from class scriptella.spi.AbstractConnection

commit, getDialectIdentifier, getExecutedStatementsCount, isExecutedStatementsCountSupported, isReadonly, rollback, setDialectIdentifier, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface scriptella.spi.Connection

getUpdateCount

Constructor Details

TextConnection

protected TextConnection()

For testing purposes only.

TextConnection

public TextConnection(ConnectionParameters parameters)

Method Details

getProgressCounter

public AbstractConnection.StatementCounter getProgressCounter()

Description copied from interface: Connection

Optional live progress counter. Called on the execution thread only. Return a stable in-memory counter updated with the same semantics as Connection.getExecutedStatementsCount(), or null if unavailable. The reporter reads only its volatile value, never this connection. The counter must remain valid after close. Existing providers need not implement this method.

executeScript

public void executeScript(Resource scriptContent,
 ParametersCallback parametersCallback)
                   throws ProviderException

Description copied from interface: Connection

Executes a script specified by its content.

scriptContent may be used as a key for caching purposes, i.e. provider may precompile scripts and use compiled versions for subsequent executions. Please note that only inline text resources can be safely cached.

Parameters:

scriptContent - script content. Cannot be null.

parametersCallback - callback to get parameter values. Cannot be null.

Throws:

ProviderException - if script execution failed.

initOut

protected void initOut()

Lazily initializes script writer.

executeQuery

public void executeQuery(Resource queryContent,
 ParametersCallback parametersCallback,
 QueryCallback queryCallback)
                  throws ProviderException

Description copied from interface: Connection

Executes a query specified by its content.

Parameters:

queryContent - query content. Cannot be null.

parametersCallback - callback to get parameter values. Cannot be null.

queryCallback - callback to call for each result set element produced by this query. Cannot be null.

Throws:

ProviderException - if query execution failed.

See Also:

• Connection.executeScript(scriptella.spi.Resource,scriptella.spi.ParametersCallback)

close

public void close()
           throws ProviderException

Description copied from interface: Connection

Closes the connection and releases all related resources.

Throws:

ProviderException - if a critical failure occured.