XMLDocumentWriter

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.extex.backend.documentWriter.xml
Class XMLDocumentWriter

java.lang.Object
  org.extex.backend.documentWriter.xml.XMLDocumentWriter

All Implemented Interfaces:: DocumentWriter, SingleDocumentStream, FontAware, Configurable, NodeVisitor<java.lang.Object,java.lang.Object>

public class XMLDocumentWriter
extends java.lang.Object
implements DocumentWriter, SingleDocumentStream, NodeVisitor<java.lang.Object,java.lang.Object>, Configurable, FontAware
extends java.lang.Object
implements DocumentWriter, SingleDocumentStream, NodeVisitor<java.lang.Object,java.lang.Object>, Configurable, FontAware

This is a xml implementation of a document writer.

Version:: $Revision: 6447 $
Author:: Michael Niedermair

Constructor Summary
`XMLDocumentWriter(Configuration cfg, DocumentWriterOptions options)` Creates a new object.

Method Summary
`void`	`close()` This method is invoked upon the end of the processing.
`void`	`configure(Configuration cfg)` Configure an object according to a given Configuration.
`java.lang.String`	`getExtension()` Getter for the extension associated with this kind of output.
`void`	`setFontFactory(CoreFontFactory factory)` Setter for the font factory.
`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.
`int`	`shipout(Page page)` This is the entry point for the document writer.
`java.lang.Object`	`visitAdjust(AdjustNode node, java.lang.Object value2)` This method is called when an `AdjustNode` has been encountered.
`java.lang.Object`	`visitAfterMath(AfterMathNode node, java.lang.Object value2)` This method is called when an `AfterMathNode` has been encountered.
`java.lang.Object`	`visitAlignedLeaders(AlignedLeadersNode node, java.lang.Object value2)` This method is called when an `AlignedLeadersNode` has been encountered.
`java.lang.Object`	`visitBeforeMath(BeforeMathNode node, java.lang.Object value2)` This method is called when a `BeforeMathNode` has been encountered.
`java.lang.Object`	`visitCenteredLeaders(CenteredLeadersNode node, java.lang.Object value)` This method is called when a `CenteredLeadersNode` has been encountered.
`java.lang.Object`	`visitChar(CharNode node, java.lang.Object value)` This method is called when a `CharNode` has been encountered.
`java.lang.Object`	`visitDiscretionary(DiscretionaryNode node, java.lang.Object value)` This method is called when a `DiscretionaryNode` has been encountered.
`java.lang.Object`	`visitExpandedLeaders(ExpandedLeadersNode node, java.lang.Object value)` This method is called when an `ExpandedLeadersNode` has been encountered.
`java.lang.Object`	`visitGlue(GlueNode node, java.lang.Object value)` This method is called when a `GlueNode` has been encountered.
`java.lang.Object`	`visitHorizontalList(HorizontalListNode node, java.lang.Object value)` This method is called when a `HorizontalListNode` has been encountered.
`java.lang.Object`	`visitInsertion(InsertionNode node, java.lang.Object value)` This method is called when an `InsertionNode` has been encountered.
`java.lang.Object`	`visitKern(KernNode node, java.lang.Object value)` This method is called when a `KernNode` has been encountered.
`java.lang.Object`	`visitLigature(LigatureNode node, java.lang.Object value)` This method is called when a `LigatureNode` has been encountered.
`java.lang.Object`	`visitMark(MarkNode node, java.lang.Object value)` This method is called when a `MarkNode` has been encountered.
`java.lang.Object`	`visitPenalty(PenaltyNode node, java.lang.Object value)` This method is called when a `PenaltyNode` has been encountered.
`java.lang.Object`	`visitRule(RuleNode node, java.lang.Object value)` This method is called when a `RuleNode` has been encountered.
`java.lang.Object`	`visitSpace(SpaceNode node, java.lang.Object value)` This method is called when a `SpaceNode` has been encountered.
`java.lang.Object`	`visitVerticalList(VerticalListNode node, java.lang.Object value)` This method is called when a `VerticalListNode` has been encountered.
`java.lang.Object`	`visitVirtualChar(VirtualCharNode node, java.lang.Object value)` This method is called when a `VirtualCharNode` has been encountered.
`java.lang.Object`	`visitWhatsIt(WhatsItNode node, java.lang.Object value)` This method is called when a `WhatsItNode` has been encountered.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

XMLDocumentWriter

public XMLDocumentWriter(Configuration cfg,
                         DocumentWriterOptions options)

Creates a new object.

Parameters:: cfg - the configuration; options - the options

Method Detail

close

public void close()
           throws DocumentWriterException

Description copied from interface: DocumentWriter

This method is invoked upon the end of the processing.

Specified by:: close in interface DocumentWriter

Throws:: DocumentWriterException
See Also:: DocumentWriter.close()

configure

public void configure(Configuration cfg)
               throws ConfigurationException

Description copied from interface: Configurable

Configure an object according to a given Configuration.

Specified by:: configure in interface Configurable

Parameters:: cfg - 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()

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

setFontFactory

public void setFontFactory(CoreFontFactory factory)

Setter for the font factory.

Specified by:: setFontFactory in interface FontAware

Parameters:: factory - the font factory
See Also:: FontAware.setFontFactory(org.extex.font.CoreFontFactory)

setOutputStream

public void setOutputStream(java.io.OutputStream outStream)

Description copied from interface: SingleDocumentStream

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)

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 GeneralException

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.

If the page is null then no page has to be shipped and 0 has to be returned.

Specified by:: shipout in interface DocumentWriter

Parameters:: page - the page to send
Returns:: returns the number of pages shipped
Throws:: GeneralException - in case of a general exception
especially
DocumentWriterException in case of an error
See Also:: DocumentWriter.shipout( org.extex.typesetter.type.page.Page)