com.adaptris.csv.jdbc

Class CsvResultSetTranslator

java.lang.Object

com.adaptris.core.services.jdbc.ResultSetTranslatorBase

com.adaptris.core.services.jdbc.StyledResultTranslatorImp

com.adaptris.core.services.jdbc.ResultSetTranslatorImp

com.adaptris.csv.jdbc.CsvResultSetTranslator

All Implemented Interfaces:

ComponentLifecycle, ComponentLifecycleExtension, ResultSetTranslator

@ComponentProfile(summary="Output each row in the result set as a line in a CSV",
                  since="3.8.0")
public class CsvResultSetTranslator
extends ResultSetTranslatorImp

Implementation of ResultSetTranslator that outputs each row as a part of a CSV.

In the adapter configuration file this class is aliased as jdbc-csv-output which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.services.jdbc.StyledResultTranslatorImp

StyledResultTranslatorImp.ColumnStyle

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ELEMENT_NAME_COLUMN

Fields inherited from class com.adaptris.core.services.jdbc.ResultSetTranslatorBase

log

Constructor Summary

Constructors

Constructor and Description
CsvResultSetTranslator()

Method Summary

Modifier and Type	Method and Description
ColumnFilter	getColumnFilter()
PreferenceBuilder	getPreferenceBuilder()
void	setColumnFilter(ColumnFilter columnFilter)
void	setPreferenceBuilder(PreferenceBuilder formatBuilder)
long	translateResult(JdbcResult source, AdaptrisMessage target)

Methods inherited from class com.adaptris.core.services.jdbc.ResultSetTranslatorImp

addColumnTranslator, getAttemptAutoConvert, getColumnTranslators, getDisplayColumnErrors, getResultCountMetadataItem, getUpdateCountMetadataItem, isDisplayColumnErrors, logColumnErrors, setAttemptAutoConvert, setColumnTranslators, setDisplayColumnErrors, setResultCountMetadataItem, setUpdateCountMetadataItem, toString, translate, updateMetadata, updateMetadataQueryCount, updateMetadataUpdateCount, withAttemptAutoConvert, withColumnTranslators, withColumnTranslators

Methods inherited from class com.adaptris.core.services.jdbc.StyledResultTranslatorImp

getColumnNameStyle, setColumnNameStyle, withColumnNameStyle

Methods inherited from class com.adaptris.core.services.jdbc.ResultSetTranslatorBase

prepare

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init, start, stop

Field Detail

ELEMENT_NAME_COLUMN

protected static final java.lang.String ELEMENT_NAME_COLUMN

See Also:

Constant Field Values

Constructor Detail

CsvResultSetTranslator

public CsvResultSetTranslator()

Method Detail

translateResult

public long translateResult(JdbcResult source,
                            AdaptrisMessage target)
                     throws java.sql.SQLException,
                            ServiceException

Specified by:

translateResult in class ResultSetTranslatorImp

Throws:

java.sql.SQLException

ServiceException

getPreferenceBuilder

public PreferenceBuilder getPreferenceBuilder()

Returns:

the formatBuilder

setPreferenceBuilder

public void setPreferenceBuilder(PreferenceBuilder formatBuilder)

Parameters:

formatBuilder - the formatBuilder to set

getColumnFilter

public ColumnFilter getColumnFilter()

setColumnFilter

public void setColumnFilter(ColumnFilter columnFilter)

Parameters:

columnFilter - Optional filter for columns that should not be output