de.dante.extex.backend.documentWriter.dump
Class MultiDumpDocumentWriter

java.lang.Object
  extended byde.dante.extex.backend.documentWriter.dump.MultiDumpDocumentWriter
All Implemented Interfaces:
Configurable, DocumentWriter, MultipleDocumentStream

public class MultiDumpDocumentWriter
extends java.lang.Object
implements DocumentWriter, MultipleDocumentStream, Configurable

This is an implementation of a document writer which puts of each page into a new output stream.

It can act both as sample and as tool for testing.

Version:
$Revision: 1.6 $
Author:
Gerd Neugebauer

Constructor Summary
MultiDumpDocumentWriter(DocumentWriterOptions opts)
          Creates a new object.
 
Method Summary
 void close()
          This method is invoked upon the end of the processing.
 void configure(Configuration config)
          Configure an object according to a given Configuration.
 java.lang.String getExtension()
          Getter for the extension associated with this kind of output.
 void setOutputStreamFactory(OutputStreamFactory writerFactory)
          Setter for the output stream.
 void setParameter(java.lang.String name, java.lang.String value)
          Setter for a named parameter.
 int 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

MultiDumpDocumentWriter

public MultiDumpDocumentWriter(DocumentWriterOptions opts)
Creates a new object.

Parameters:
opts - the dynamic access to the context
Method Detail

close

public void close()
           throws java.io.IOException
Description copied from interface: DocumentWriter
This method is invoked upon the end of the processing.

Specified by:
close in interface DocumentWriter
Throws:
java.io.IOException - in case of an IO exception
See Also:
DocumentWriter.close()

configure

public void configure(Configuration config)
               throws ConfigurationException
Description copied from interface: Configurable
Configure an object according to a given Configuration.

Specified by:
configure in interface Configurable
Parameters:
config - the configuration object to consider
Throws:
ConfigurationException - in case that something went wrong
See Also:
Configurable.configure( de.dante.util.framework.configuration.Configuration)

getExtension

public java.lang.String getExtension()
Description copied from interface: DocumentWriter
Getter for the extension associated with this kind of output. For instance pdf is the expected value for PDF files and dvi is the expected value for DVI files.

Specified by:
getExtension in interface DocumentWriter
Returns:
the appropriate extension for file names
See Also:
DocumentWriter.getExtension()

setOutputStreamFactory

public void setOutputStreamFactory(OutputStreamFactory writerFactory)
Description copied from interface: MultipleDocumentStream
Setter for the output stream.

Specified by:
setOutputStreamFactory in interface MultipleDocumentStream
Parameters:
writerFactory - the output stream
See Also:
MultipleDocumentStream.setOutputStreamFactory(de.dante.extex.backend.outputStream.OutputStreamFactory)

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
Description copied from interface: DocumentWriter
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 DocumentWriter
Parameters:
name - the name of the parameter
value - the value of the parameter
See Also:
DocumentWriter.setParameter( java.lang.String, java.lang.String)

shipout

public int shipout(Page page)
            throws DocumentWriterException
Description copied from interface: DocumentWriter
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 DocumentWriter
Parameters:
page - the page to send
Returns:
returns the number of pages shipped
Throws:
DocumentWriterException
See Also:
DocumentWriter.shipout( de.dante.extex.typesetter.type.page.Page)