com.denodo.scheduler.api.filter

Interface Filter

public interface Filter

A filter receives as input the internal representation of a document with a series of set fields and can modify same by adding new fields or modifying the existing ones.

Method Summary

Modifier and Type	Method and Description
boolean	execute(Document document) Executes the filter.
void	init(ParameterStructure parameters) Initialize the filter.

Method Detail

init

void init(ParameterStructure parameters)
   throws ConfigurationException

Initialize the filter.

Parameters:

parameters - configuration to initialize the filter.

Throws:

ConfigurationException - if the configuration information required by the filter is malformed or missing.

execute

boolean execute(Document document)
         throws FilterException

Executes the filter.

Parameters:

document - the Document to be processed by this Filter.

Returns:

false if the processing of the given Document should be delegated to a subsequent Filter in an enclosing Filter Sequence, otherwise return true.

Throws:

FilterException