scriptella.driver.csv

Class CsvConnection

java.lang.Object

scriptella.spi.AbstractConnection

scriptella.driver.text.AbstractTextConnection

scriptella.driver.csv.CsvConnection

All Implemented Interfaces:

Connection

public class CsvConnection
extends AbstractTextConnection

Represents a connection to CSV file.

For configuration details and examples see overview page.

Version:

1.1

Author:

Fyodor Kupolov, Sean Summers

Nested Class Summary

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

AbstractConnection.StatementCounter

Field Summary

Fields

Modifier and Type	Field and Description
static String	ESCAPE Name of the escape connection property.
static String	HEADERS Name of the headers connection property.
protected static Logger	LOG
static String	QUOTE Name of the quote connection property.
static String	QUOTEALL Name of the quoteall connection property.
static String	SEPARATOR Name of the separator connection property.

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

Constructor and Description
CsvConnection(ConnectionParameters parameters)

Method Summary

Modifier and Type	Method and Description
void	close()
void	executeQuery(Resource queryContent, ParametersCallback parametersCallback, QueryCallback queryCallback)
void	executeScript(Resource scriptContent, ParametersCallback parametersCallback)
protected CsvConnectionParameters	getConnectionParameters()
protected CSVWriter	getOut()
protected CsvQuery	newCsvQuery(CSVReader csvReader, PropertiesSubstitutor ps) Template factory method to instantiate query handlers.

Methods inherited from class scriptella.driver.text.AbstractTextConnection

newInputReader, newOutputWriter

Methods inherited from class scriptella.spi.AbstractConnection

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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

SEPARATOR

public static final String SEPARATOR

Name of the separator connection property. The delimiter to use for separating entries when reading from or writing to files.

See Also:

Constant Field Values

QUOTE

public static final String QUOTE

Name of the quote connection property. The character to use for quoted elements when reading from or writing to files. Use empty string to suppress quoting.

See Also:

Constant Field Values

ESCAPE

public static final String ESCAPE

Name of the escape connection property. The character to use for escaped elements when writing to files. Use empty string to suppress escaping.

See Also:

Constant Field Values

HEADERS

public static final String HEADERS

Name of the headers connection property. true means the first line contains headers. Default value is true.

Only valid for <query> elements.

See Also:

Constant Field Values

QUOTEALL

public static final String QUOTEALL

Name of the quoteall connection property. false means only elements with the quote or escape character are quoted. Default value is true.

See Also:

Constant Field Values

Constructor Detail

CsvConnection

public CsvConnection(ConnectionParameters parameters)

Method Detail

executeScript

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

Throws:

ProviderException

executeQuery

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

Throws:

ProviderException

getOut

protected CSVWriter getOut()

Returns:

lazily intialized writer.

newCsvQuery

protected CsvQuery newCsvQuery(CSVReader csvReader,
                               PropertiesSubstitutor ps)

Template factory method to instantiate query handlers.

Parameters:

csvReader - CSV reader to use for parsing.

ps - properties substitutor.

Returns:

constructed query for a specified input and parameters.

close

public void close()
           throws ProviderException

Throws:

ProviderException

getConnectionParameters

protected CsvConnectionParameters getConnectionParameters()

Overrides:

getConnectionParameters in class AbstractTextConnection