Package com.denodo.scheduler.api.exporter.filter

Class ExporterFilter

java.lang.Object

com.denodo.scheduler.api.exporter.filter.ExporterFilter

public abstract class ExporterFilter
extends Object

This abstract class defines Exporter filters, such as encryption or compression filters, which can be chained to combine their behaviors (i.e. encrypt and then zip an exporter's output file).

Field Summary

Fields

Modifier and Type	Field	Description
protected ExporterFilter	nextFilter

Constructor Summary

Constructors

Constructor	Description
ExporterFilter()

Method Summary

Modifier and Type	Method	Description
protected abstract InputStream	doGetInputStream(InputStream in)	Initializes an input stream based on the exporter's parameters and encapsulates the passed input stream.
protected abstract OutputStream	doGetOutputStream(OutputStream out)	Initializes an output stream based on the exporter's parameters and encapsulates the passed output stream.
InputStream	getInputStream(InputStream in)	Obtains an input stream which combines all the associated filter's input streams.
protected abstract String	getName()	Returns the exporter's name.
ExporterFilter	getNextFilter()	Getter for the next filter to be applied.
OutputStream	getOutputStream(OutputStream out)	Obtains an output stream which combines all the associated filter's output streams.
void	setNextFilter(ExporterFilter nextFilter)	Setter for the next filter to be applied.

Methods inherited from class java.lang.Object

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

Field Details

nextFilter

protected ExporterFilter nextFilter

Constructor Details

ExporterFilter

public ExporterFilter()

Method Details

getInputStream

public InputStream getInputStream(InputStream in)
                           throws InternalErrorException

Obtains an input stream which combines all the associated filter's input streams.

Parameters:

in - the base input stream.

Returns:

the combined input stream.

Throws:

InternalErrorException

doGetInputStream

protected abstract InputStream doGetInputStream(InputStream in)
                                         throws InternalErrorException

Initializes an input stream based on the exporter's parameters and encapsulates the passed input stream.

Parameters:

in - a starting input stream.

Returns:

the initialized input stream.

Throws:

InternalErrorException

getOutputStream

public OutputStream getOutputStream(OutputStream out)
                             throws InternalErrorException

Obtains an output stream which combines all the associated filter's output streams.

Parameters:

out - the base output stream.

Returns:

the combined output stream.

Throws:

InternalErrorException

doGetOutputStream

protected abstract OutputStream doGetOutputStream(OutputStream out)
                                           throws InternalErrorException

Initializes an output stream based on the exporter's parameters and encapsulates the passed output stream.

Parameters:

in - a starting output stream.

Returns:

the initialized output stream.

Throws:

InternalErrorException

getNextFilter

public ExporterFilter getNextFilter()

Getter for the next filter to be applied.

Returns:

the filter.

setNextFilter

public void setNextFilter(ExporterFilter nextFilter)

Setter for the next filter to be applied.

Parameters:

nextFilter - the filter.

getName

protected abstract String getName()

Returns the exporter's name.

Returns:

the name.