org.extex.backend.documentWriter.dump
Class DumpDocumentWriter

java.lang.Object
  org.extex.backend.documentWriter.dump.DumpDocumentWriter

All Implemented Interfaces:

DocumentWriter, SingleDocumentStream, Configurable

public class DumpDocumentWriter
extends java.lang.Object
implements DocumentWriter, SingleDocumentStream, Configurable

This is an implementation of a document writer which can act both as sample and as tool for testing.

Version:

$Revision: 5906 $

Author:

Gerd Neugebauer

Constructor Summary

DumpDocumentWriter(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	setOutputStream(java.io.OutputStream outStream) Setter for the output stream.
void	setParameter(java.lang.String name, java.lang.String value) Setter for a named parameter.
void	setTree(boolean tree) Setter for tree.
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

DumpDocumentWriter

public DumpDocumentWriter(DocumentWriterOptions opts)

Creates a new object.

Parameters:

opts - the dynamic access to the context

Method Detail

close

public void close()
           throws java.io.IOException

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

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( org.extex.framework.configuration.Configuration)

getExtension

public java.lang.String getExtension()

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()

setOutputStream

public void setOutputStream(java.io.OutputStream outStream)

Setter for the output stream.

Specified by:

setOutputStream in interface SingleDocumentStream

Parameters:

outStream - the output stream

See Also:

SingleDocumentStream.setOutputStream( java.io.OutputStream)

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.

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)

setTree

public void setTree(boolean tree)

Setter for tree.

Parameters:

tree - the tree to set

shipout

public int shipout(Page page)
            throws DocumentWriterException

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 - in case of an error

See Also:

DocumentWriter.shipout( org.extex.typesetter.type.page.Page)