com.adaptris.csv.jdbc

Class MetadataColumnFilter

java.lang.Object

com.adaptris.csv.jdbc.MetadataColumnFilter

All Implemented Interfaces:

ColumnFilter

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

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

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

Constructor Summary

Constructors

Constructor and Description
MetadataColumnFilter()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getExcludeColumnNames(AdaptrisMessage msg) The list of columns that will be filtered.
java.util.List<java.lang.String>	getExclusionKeys()
java.util.Set<java.lang.String>	getIncludeColumnNames(AdaptrisMessage msg) The list of columsn that will be explicitly included.
java.util.List<java.lang.String>	getInclusionKeys()
void	setExclusionKeys(java.util.List<java.lang.String> keys) Set the keys that will be used to exclude columns from output.
void	setInclusionKeys(java.util.List<java.lang.String> keys) Set the keys that will be used to include columns in output.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataColumnFilter

public MetadataColumnFilter()

Method Detail

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

getInclusionKeys

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

Returns:

the inclusionKeys

setInclusionKeys

public void setInclusionKeys(java.util.List<java.lang.String> keys)

Set the keys that will be used to include columns in output.

Parameters:

keys - the metadata keys to use for the include columns list. Each key may contain a comma separated list of column names.

getExclusionKeys

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

setExclusionKeys

public void setExclusionKeys(java.util.List<java.lang.String> keys)

Set the keys that will be used to exclude columns from output.

Parameters:

keys - the metadata keys to use for the filtered columns list. Each key may contain a comma separated list of column names to filter.