de.dante.extex.backend.pageFilter
Interface PagePipe

All Known Implementing Classes:
PageReverser, PageSelector

public interface PagePipe

A page pipe describes the ability to process a node list – resulting in a new node list.

Version:
$Revision: 1.2 $
Author:
Gerd Neugebauer

Method Summary
 void close()
          This method is invoked upon the end of the processing.
 void setOutput(PagePipe out)
          Setter for the output node pipe.
 void setParameter(java.lang.String name, java.lang.String value)
          Setter for a named parameter.
 void shipout(Page nodes)
          This is the entry point for the document writer.
 

Method Detail

close

public void close()
           throws BackendException
This method is invoked upon the end of the processing.

Throws:
BackendException - in case of a back-end error

shipout

public void shipout(Page nodes)
             throws BackendException
This is the entry point for the document writer. Here it receives a complete node list to be sent to the output writer. It can be assumed that all values for width, height, and depth of the node lists are properly filled. Thus all information should be present to place the ink on the paper.

Parameters:
nodes - the nodes to send
Throws:
BackendException - in case of an error

setOutput

public void setOutput(PagePipe out)
Setter for the output node pipe.

Parameters:
out - the output node pipe

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
Setter for a named parameter. Parameters are a general mechanism to influence the behavior of the document writer. Any parameter not known by the document writer has to be ignored.

Parameters:
name - the name of the parameter
value - the value of the parameter