Class ResultSetColumnNameHelperService

java.lang.Object

com.opencsv.ResultSetHelperService

com.opencsv.ResultSetColumnNameHelperService

All Implemented Interfaces:

ResultSetHelper

public class ResultSetColumnNameHelperService
extends ResultSetHelperService
implements ResultSetHelper

Helper class for processing JDBC ResultSet objects allowing the user to process a subset of columns and set custom header names.

Field Summary

Fields inherited from class ResultSetHelperService

CLOBBUFFERSIZE, dateFormat, dateTimeFormat, floatingPointFormat, integerFormat

Constructor Summary

Constructors

Constructor	Description
ResultSetColumnNameHelperService()	Nullary constructor.

Method Summary

Modifier and Type	Method	Description
String[]	getColumnNames(ResultSet rs)	Returns the column names from the result set.
String[]	getColumnValues(ResultSet rs)	Get all the column values from the result set.
String[]	getColumnValues(ResultSet rs, boolean trim)	Get all the column values from the result set.
String[]	getColumnValues(ResultSet rs, boolean trim, String dateFormatString, String timeFormatString)	Get all the column values from the result set.
void	setColumnNames(String[] columnNames, String[] columnHeaders)	Set the JDBC column names to use, and the header text for the CSV file
void	setErrorLocale(Locale errorLocale)	Sets the locale for error messages.

Methods inherited from class ResultSetHelperService

handleClob, handleDate, handleNClob, handleNVarChar, handleTimestamp, handleVarChar, setDateFormat, setDateTimeFormat, setFloatingPointFormat, setIntegerFormat

Methods inherited from class Object

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

Constructor Details

ResultSetColumnNameHelperService

public ResultSetColumnNameHelperService()

Nullary constructor.

Method Details

setErrorLocale

public void setErrorLocale(Locale errorLocale)

Sets the locale for error messages.

Parameters:

errorLocale - Locale for error messages. If null, the default locale is used.

Since:

4.0

setColumnNames

public void setColumnNames(String[] columnNames,
 String[] columnHeaders)

Set the JDBC column names to use, and the header text for the CSV file

Parameters:

columnNames - The JDBC column names to export, in the desired order

columnHeaders - The column headers of the CSV file, in the desired order

Throws:

UnsupportedOperationException - If the number of headers is different than the number of columns, or if any of the columns or headers is blank or null.

getColumnNames

public String[] getColumnNames(ResultSet rs)
                        throws SQLException

Returns the column names from the result set.

Specified by:

getColumnNames in interface ResultSetHelper

Overrides:

getColumnNames in class ResultSetHelperService

Parameters:

rs - ResultSet

Returns:

A string array containing the column names.

Throws:

SQLException - Thrown by the result set.

getColumnValues

public String[] getColumnValues(ResultSet rs)
                         throws SQLException,
IOException

Get all the column values from the result set.

Specified by:

getColumnValues in interface ResultSetHelper

Overrides:

getColumnValues in class ResultSetHelperService

Parameters:

rs - The ResultSet containing the values.

Returns:

String array containing all the column values.

Throws:

SQLException - Thrown by the result set.

IOException - Thrown by the result set.

getColumnValues

public String[] getColumnValues(ResultSet rs,
 boolean trim)
                         throws SQLException,
IOException

Get all the column values from the result set.

Specified by:

getColumnValues in interface ResultSetHelper

Overrides:

getColumnValues in class ResultSetHelperService

Parameters:

rs - The ResultSet containing the values.

trim - Values should have white spaces trimmed.

Returns:

String array containing all the column values.

Throws:

SQLException - Thrown by the result set.

IOException - Thrown by the result set.

getColumnValues

public String[] getColumnValues(ResultSet rs,
 boolean trim,
 String dateFormatString,
 String timeFormatString)
                         throws SQLException,
IOException

Get all the column values from the result set.

Specified by:

getColumnValues in interface ResultSetHelper

Overrides:

getColumnValues in class ResultSetHelperService

Parameters:

rs - The ResultSet containing the values.

trim - Values should have white spaces trimmed.

dateFormatString - Format string for dates.

timeFormatString - Format string for timestamps.

Returns:

String array containing all the column values.

Throws:

SQLException - Thrown by the result set.

IOException - Thrown by the result set.