org.jumpmind.symmetric.load
Interface IColumnFilter

All Superinterfaces:

IExtensionPoint

All Known Subinterfaces:

ITableColumnFilter

public interface IColumnFilter
extends IExtensionPoint

This is an extension point that can be implemented to filter out columns from use by the dataloader. One column filter may be added per target table.

Please implement ITableColumnFilter instead of this class directly if you want the extension to be auto discovered.

Method Summary

java.lang.String[]	filterColumnsNames(IDataLoaderContext ctx, StatementBuilder.DmlType dml, org.apache.ddlutils.model.Table table, java.lang.String[] columnNames) This method is always called first.
java.lang.Object[]	filterColumnsValues(IDataLoaderContext ctx, StatementBuilder.DmlType dml, org.apache.ddlutils.model.Table table, java.lang.Object[] columnValues) This method is always called after IColumnFilter#filterColumnsNames(DmlType, String[]).

Methods inherited from interface org.jumpmind.symmetric.ext.IExtensionPoint

isAutoRegister

Method Detail

filterColumnsNames

java.lang.String[] filterColumnsNames(IDataLoaderContext ctx,
                                      StatementBuilder.DmlType dml,
                                      org.apache.ddlutils.model.Table table,
                                      java.lang.String[] columnNames)

This method is always called first. Typically, you must cache the column index you are interested in order to be able to filter the column value as well.

Returns:

The columnName that the data loader will use to build its dml.

filterColumnsValues

java.lang.Object[] filterColumnsValues(IDataLoaderContext ctx,
                                       StatementBuilder.DmlType dml,
                                       org.apache.ddlutils.model.Table table,
                                       java.lang.Object[] columnValues)

This method is always called after IColumnFilter#filterColumnsNames(DmlType, String[]). It should perform the same filtering under the same conditions for the values as was done for the column names.

Returns:

the column values