com.lf.commons.db.update

Class CSVTask

java.lang.Object

com.lf.commons.db.update.CSVTask

All Implemented Interfaces:

UpdateTask

public class CSVTask
extends java.lang.Object
implements UpdateTask

Updates a target database table based on the contents of a CSV file.

Supported parameters are as follows (see sample values):

<param name="LOCATOR">com.lf.lima.resource.ResourceLocator</param> (required) <param name="RESOURCE">LOV.csv</param> (required) <param name="ENCODING">ISO-8859-1</param> (required) <param name="SCHEMA">LIMASYS</param> (optional) <param name="TABLE">LOV</param> (required) <param name="GENERATED_KEY">LVID</param> (optional) <param name="MODE">ADD_ALL</param> (required)

Since:

1.6

Version:

$Revision: 1.11 $, $Date: 2012/12/28 11:44:24 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODE_ADD_ALL The existing tuples are kept and all tuples are added.
static java.lang.String	MODE_REPLACE The existing tuples are deleted and created newly from the file.
static java.lang.String	PARAM_ENCODING Charset definition of the CSV file (required).
static java.lang.String	PARAM_GENERATED_KEY Name of the generated column filled by a sequence (optional).
static java.lang.String	PARAM_LOCATOR Fully qualified class name to find resources on the classpath (required).
static java.lang.String	PARAM_MODE One of the allowed operation modes (required).
static java.lang.String	PARAM_RESOURCE Resource path to find the CSV file on the classpath (required).
static java.lang.String	PARAM_SCHEMA Database schema (optional).
static java.lang.String	PARAM_TABLE Database table to store the tuples (required).

Constructor Summary

Constructors

Constructor and Description
CSVTask() Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(DatabaseConnector connector, java.sql.Connection conn, java.util.Properties params) Starts executing the update task.
static void	main(java.lang.String[] args) Some debugging functionality.
static java.lang.String[]	parseLine(java.lang.String line) Parses a line of data.

Methods inherited from class java.lang.Object

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

Field Detail

MODE_REPLACE

public static final java.lang.String MODE_REPLACE

The existing tuples are deleted and created newly from the file.

See Also:

Constant Field Values

MODE_ADD_ALL

public static final java.lang.String MODE_ADD_ALL

The existing tuples are kept and all tuples are added.

See Also:

Constant Field Values

PARAM_LOCATOR

public static final java.lang.String PARAM_LOCATOR

Fully qualified class name to find resources on the classpath (required).

See Also:

Constant Field Values

PARAM_RESOURCE

public static final java.lang.String PARAM_RESOURCE

Resource path to find the CSV file on the classpath (required).

See Also:

Constant Field Values

PARAM_ENCODING

public static final java.lang.String PARAM_ENCODING

Charset definition of the CSV file (required).

See Also:

Constant Field Values

PARAM_SCHEMA

public static final java.lang.String PARAM_SCHEMA

Database schema (optional).

See Also:

Constant Field Values

PARAM_TABLE

public static final java.lang.String PARAM_TABLE

Database table to store the tuples (required).

See Also:

Constant Field Values

PARAM_GENERATED_KEY

public static final java.lang.String PARAM_GENERATED_KEY

Name of the generated column filled by a sequence (optional).

See Also:

Constant Field Values

PARAM_MODE

public static final java.lang.String PARAM_MODE

One of the allowed operation modes (required).

See Also:

Constant Field Values

Constructor Detail

CSVTask

public CSVTask()

Constructor method.

Since:

1.6

Method Detail

execute

public boolean execute(DatabaseConnector connector,
              java.sql.Connection conn,
              java.util.Properties params)

Starts executing the update task.

Specified by:

execute in interface UpdateTask

Parameters:

connector - The database specific connector (getting sequence values etc.)

conn - The update connection

params - The task parameters from the XML definition

Returns:

Successful?

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

parseLine

public static java.lang.String[] parseLine(java.lang.String line)

Parses a line of data.

Parameters:

line - The data to parse

Returns:

Array with field contents

Since:

1.6

main

public static void main(java.lang.String[] args)

Some debugging functionality.

Parameters:

args - The arguments

Since:

1.6