de.dante.extex.backend.pageFilter.selector
Class PageSelector

java.lang.Object
  extended byde.dante.extex.backend.pageFilter.selector.PageSelector
All Implemented Interfaces:
PagePipe

public class PageSelector
extends java.lang.Object
implements PagePipe

This page filter selects some pages to be shipped out.

Version:
$Revision: 1.3 $
Author:
Gerd Neugebauer

Constructor Summary
PageSelector()
          Creates a new object.
PageSelector(java.lang.String spec)
          Creates a new object.
 
Method Summary
protected  void addRule(de.dante.extex.backend.pageFilter.selector.IntervalRule rule)
          Add a rule to the set of rules.
 void addSelector(java.lang.String spec)
          Add some specifications for pages to be selected.
 void close()
          This method is invoked upon the end of the processing.
 void setOutput(PagePipe pipe)
          Setter for the output node pipe.
 void setParameter(java.lang.String name, java.lang.String value)
          Setter for a named parameter.
 void shipout(Page page)
          This is the entry point for the document writer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageSelector

public PageSelector()
Creates a new object.


PageSelector

public PageSelector(java.lang.String spec)
Creates a new object.

Parameters:
spec - the specification of the pages to select
Method Detail

addSelector

public void addSelector(java.lang.String spec)
Add some specifications for pages to be selected.

Parameters:
spec - the specification of the pages to select

addRule

protected void addRule(de.dante.extex.backend.pageFilter.selector.IntervalRule rule)
Add a rule to the set of rules.

Parameters:
rule - the rule to add

close

public void close()
           throws BackendException
Description copied from interface: PagePipe
This method is invoked upon the end of the processing.

Specified by:
close in interface PagePipe
Throws:
BackendException - in case of a back-end error
See Also:
PagePipe.close()

setOutput

public void setOutput(PagePipe pipe)
Description copied from interface: PagePipe
Setter for the output node pipe.

Specified by:
setOutput in interface PagePipe
Parameters:
pipe - the output node pipe
See Also:
de.dante.extex.backend.nodeFilter.PagePipe#setOutput( de.dante.extex.backend.nodeFilter.PagePipe)

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
Description copied from interface: PagePipe
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.

Specified by:
setParameter in interface PagePipe
Parameters:
name - the name of the parameter
value - the value of the parameter
See Also:
de.dante.extex.backend.nodeFilter.PagePipe#setParameter( java.lang.String, java.lang.String)

shipout

public void shipout(Page page)
             throws BackendException
Description copied from interface: PagePipe
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.

Specified by:
shipout in interface PagePipe
Parameters:
page - the nodes to send
Throws:
BackendException - in case of an error
See Also:
de.dante.extex.backend.nodeFilter.PagePipe#shipout( de.dante.extex.typesetter.type.page.Page)