Package com.adaptris.csv.jdbc

Class ConfiguredColumnFilter

java.lang.Object

com.adaptris.csv.jdbc.ConfiguredColumnFilter

All Implemented Interfaces:

ColumnFilter

@ComponentProfile(summary="Filter CSV column output based on configuration",
                  since="3.8.0")
public class ConfiguredColumnFilter
extends java.lang.Object
implements ColumnFilter

ColumnFilter implementation that allows you to filter columns based on configuration.

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

Constructor Summary

Constructors

Constructor	Description
ConfiguredColumnFilter()

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	getExcludeColumnNames(AdaptrisMessage msg)	The list of columns that will be filtered.
java.util.List<java.lang.String>	getExcludeColumns()
java.util.Set<java.lang.String>	getIncludeColumnNames(AdaptrisMessage msg)	The list of columsn that will be explicitly included.
java.util.List<java.lang.String>	getIncludeColumns()
void	setExcludeColumns(java.util.List<java.lang.String> c)	Specify the list of columns to explicitly exclude
void	setIncludeColumns(java.util.List<java.lang.String> c)	Specify the list of columns to explicitly include

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfiguredColumnFilter

public ConfiguredColumnFilter()

Method Detail

getExcludeColumns

public java.util.List<java.lang.String> getExcludeColumns()

setExcludeColumns

public void setExcludeColumns(java.util.List<java.lang.String> c)

Specify the list of columns to explicitly exclude

Parameters:

c - list of column names to filter; if not configured, then all columns are included.

getExcludeColumnNames

public java.util.Set<java.lang.String> getExcludeColumnNames(AdaptrisMessage msg)

Description copied from interface: ColumnFilter

The list of columns that will be filtered.

Specified by:

getExcludeColumnNames in interface ColumnFilter

getIncludeColumnNames

public java.util.Set<java.lang.String> getIncludeColumnNames(AdaptrisMessage msg)

Description copied from interface: ColumnFilter

The list of columsn that will be explicitly included.

Specified by:

getIncludeColumnNames in interface ColumnFilter

getIncludeColumns

public java.util.List<java.lang.String> getIncludeColumns()

Returns:

the includeColumns

setIncludeColumns

public void setIncludeColumns(java.util.List<java.lang.String> c)

Specify the list of columns to explicitly include

Parameters:

c - the list of columsn to explicitly include; if not configured, then all columns are included.