org.apache.maven.doxia.module.latex
Class LatexSink

java.lang.Object
  org.apache.maven.doxia.sink.AbstractSink
      org.apache.maven.doxia.sink.SinkAdapter
          org.apache.maven.doxia.sink.AbstractTextSink
              org.apache.maven.doxia.module.latex.LatexSink

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, Markup, TextMarkup, Sink

public class LatexSink
extends AbstractTextSink

Latex Sink implementation.
Note: The encoding used is UTF-8.

Since:

1.0

Version:

$Id: LatexSink.java 807174 2009-08-24 12:15:08Z vsiveton $

Field Summary

Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup

PIPE

Fields inherited from interface org.apache.maven.doxia.markup.Markup

COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR

Fields inherited from interface org.apache.maven.doxia.sink.Sink

JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5

Constructor Summary

protected	LatexSink(Writer out) Constructor, initialize the Writer and the variables.
protected	LatexSink(Writer out, String sinkCommands, String preamble) Constructor, initialize the Writer and the variables.
protected	LatexSink(Writer out, String sinkCommands, String preamble, boolean fragmentDocument) Constructor, initialize the Writer and the variables.

Method Summary

void	anchor_()
void	anchor(String name)
void	anchor(String name, SinkEventAttributes attributes)
void	author_()
void	author()
void	author(SinkEventAttributes attributes)
void	body_()
void	body()
void	body(SinkEventAttributes attributes)
void	bold_()
void	bold()
void	close()
void	comment(String comment)
protected void	content(String text) Writes the text, without preserving whitespace.
void	date_()
void	date()
void	date(SinkEventAttributes attributes)
protected String	defaultPreamble() Returns the default preamble.
protected String	defaultSinkCommands() Returns the default sink commands.
void	definedTerm_()
void	definedTerm()
void	definedTerm(SinkEventAttributes attributes)
void	definition_()
void	definition()
void	definition(SinkEventAttributes attributes)
void	definitionList_()
void	definitionList()
void	definitionList(SinkEventAttributes attributes)
void	definitionListItem_()
void	definitionListItem()
void	definitionListItem(SinkEventAttributes attributes)
static String	escaped(String text) Escapes special characters.
void	figure_()
void	figure()
void	figure(SinkEventAttributes attributes)
void	figureCaption_()
void	figureCaption()
void	figureCaption(SinkEventAttributes attributes)
void	figureGraphics(String name)
void	figureGraphics(String src, SinkEventAttributes attributes)
void	flush()
protected String	getDocumentBegin() Returns a default \begin{document} declaration.
protected String	getDocumentEnd() Returns a default \end{document} declaration.
protected String	getDocumentStart() Returns a default \documentclass declaration.
void	head()
void	head(SinkEventAttributes attributes)
void	horizontalRule()
void	horizontalRule(SinkEventAttributes attributes)
protected void	init()
void	italic_()
void	italic()
void	lineBreak()
void	lineBreak(SinkEventAttributes attributes)
void	link_()
void	link(String name)
void	link(String name, SinkEventAttributes attributes)
void	list_()
void	list()
void	list(SinkEventAttributes attributes)
void	listItem()
void	listItem(SinkEventAttributes attributes)
protected void	markup(String text) Writes the text, preserving whitespace.
void	monospaced_()
void	monospaced()
void	nonBreakingSpace()
void	numberedList_()
void	numberedList(int numbering)
void	numberedList(int numbering, SinkEventAttributes attributes)
void	numberedListItem()
void	numberedListItem(SinkEventAttributes attributes)
void	pageBreak()
void	paragraph_()
void	paragraph()
void	paragraph(SinkEventAttributes attributes)
void	rawText(String text)
void	sectionTitle_(int level)
void	sectionTitle(int level, SinkEventAttributes attributes)
void	sectionTitle1_()
void	sectionTitle1()
void	sectionTitle2_()
void	sectionTitle2()
void	sectionTitle3_()
void	sectionTitle3()
void	sectionTitle4_()
void	sectionTitle4()
void	sectionTitle5_()
void	sectionTitle5()
void	table_()
void	table()
void	table(SinkEventAttributes attributes)
void	tableCaption_()
void	tableCaption()
void	tableCaption(SinkEventAttributes attributes)
void	tableCell_()
void	tableCell()
void	tableCell(SinkEventAttributes attributes)
void	tableCell(String width)
void	tableHeaderCell_()
void	tableHeaderCell()
void	tableHeaderCell(SinkEventAttributes attributes)
void	tableHeaderCell(String width)
void	tableRow_()
void	tableRow()
void	tableRow(SinkEventAttributes attributes)
void	tableRows_()
void	tableRows(int[] justification, boolean grid)
void	text(String text)
void	text(String text, SinkEventAttributes attributes)
void	title_()
void	title()
void	title(SinkEventAttributes attributes)
void	unknown(String name, Object[] requiredParams, SinkEventAttributes attributes) Unkown events just log a warning message but are ignored otherwise.
void	verbatim_()
void	verbatim(boolean boxed)
void	verbatim(SinkEventAttributes attributes)
protected void	verbatimContent(String text) Writes the text, preserving whitespace.

Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter

head_, listItem_, numberedListItem_, section_, section, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, sectionTitle_, sectionTitle

Methods inherited from class org.apache.maven.doxia.sink.AbstractSink

enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LatexSink

protected LatexSink(Writer out)

Constructor, initialize the Writer and the variables.

Parameters:

out - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from WriterFactory.

LatexSink

protected LatexSink(Writer out,
                    String sinkCommands,
                    String preamble)

Constructor, initialize the Writer and the variables.

Parameters:

out - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from WriterFactory.

sinkCommands - A String representation of commands that go before \documentclass.

preamble - A String representation of commands that go between \documentclass and \begin{document}.

LatexSink

protected LatexSink(Writer out,
                    String sinkCommands,
                    String preamble,
                    boolean fragmentDocument)

Constructor, initialize the Writer and the variables.

Parameters:

out - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from WriterFactory.

sinkCommands - A String representation of commands that go before \documentclass.

preamble - A String representation of commands that go between \documentclass and \begin{document}.

fragmentDocument - If this receives events that that are only part of a document. Typically, headers are omitted if this is true.

Method Detail

getDocumentStart

protected String getDocumentStart()

Returns a default \documentclass declaration.

Returns:

String.

getDocumentBegin

protected String getDocumentBegin()

Returns a default \begin{document} declaration.

Returns:

String.

getDocumentEnd

protected String getDocumentEnd()

Returns a default \end{document} declaration.

Returns:

String.

head

public void head()

Specified by:

head in interface Sink

Overrides:

head in class SinkAdapter

head

public void head(SinkEventAttributes attributes)

Specified by:

head in interface Sink

Overrides:

head in class SinkAdapter

body

public void body()

Specified by:

body in interface Sink

Overrides:

body in class SinkAdapter

body

public void body(SinkEventAttributes attributes)

Specified by:

body in interface Sink

Overrides:

body in class SinkAdapter

body_

public void body_()

Specified by:

body_ in interface Sink

Overrides:

body_ in class SinkAdapter

title

public void title()

Specified by:

title in interface Sink

Overrides:

title in class SinkAdapter

title

public void title(SinkEventAttributes attributes)

Specified by:

title in interface Sink

Overrides:

title in class SinkAdapter

title_

public void title_()

Specified by:

title_ in interface Sink

Overrides:

title_ in class SinkAdapter

author

public void author()

Specified by:

author in interface Sink

Overrides:

author in class SinkAdapter

author

public void author(SinkEventAttributes attributes)

Specified by:

author in interface Sink

Overrides:

author in class SinkAdapter

author_

public void author_()

Specified by:

author_ in interface Sink

Overrides:

author_ in class SinkAdapter

date

public void date()

Specified by:

date in interface Sink

Overrides:

date in class SinkAdapter

date

public void date(SinkEventAttributes attributes)

Specified by:

date in interface Sink

Overrides:

date in class SinkAdapter

date_

public void date_()

Specified by:

date_ in interface Sink

Overrides:

date_ in class SinkAdapter

sectionTitle

public void sectionTitle(int level,
                         SinkEventAttributes attributes)

Specified by:

sectionTitle in interface Sink

Overrides:

sectionTitle in class SinkAdapter

sectionTitle_

public void sectionTitle_(int level)

Specified by:

sectionTitle_ in interface Sink

Overrides:

sectionTitle_ in class SinkAdapter

sectionTitle1

public void sectionTitle1()

Specified by:

sectionTitle1 in interface Sink

Overrides:

sectionTitle1 in class SinkAdapter

sectionTitle1_

public void sectionTitle1_()

Specified by:

sectionTitle1_ in interface Sink

Overrides:

sectionTitle1_ in class SinkAdapter

sectionTitle2

public void sectionTitle2()

Specified by:

sectionTitle2 in interface Sink

Overrides:

sectionTitle2 in class SinkAdapter

sectionTitle2_

public void sectionTitle2_()

Specified by:

sectionTitle2_ in interface Sink

Overrides:

sectionTitle2_ in class SinkAdapter

sectionTitle3

public void sectionTitle3()

Specified by:

sectionTitle3 in interface Sink

Overrides:

sectionTitle3 in class SinkAdapter

sectionTitle3_

public void sectionTitle3_()

Specified by:

sectionTitle3_ in interface Sink

Overrides:

sectionTitle3_ in class SinkAdapter

sectionTitle4

public void sectionTitle4()

Specified by:

sectionTitle4 in interface Sink

Overrides:

sectionTitle4 in class SinkAdapter

sectionTitle4_

public void sectionTitle4_()

Specified by:

sectionTitle4_ in interface Sink

Overrides:

sectionTitle4_ in class SinkAdapter

sectionTitle5

public void sectionTitle5()

Specified by:

sectionTitle5 in interface Sink

Overrides:

sectionTitle5 in class SinkAdapter

sectionTitle5_

public void sectionTitle5_()

Specified by:

sectionTitle5_ in interface Sink

Overrides:

sectionTitle5_ in class SinkAdapter

list

public void list()

Specified by:

list in interface Sink

Overrides:

list in class SinkAdapter

list

public void list(SinkEventAttributes attributes)

Specified by:

list in interface Sink

Overrides:

list in class SinkAdapter

list_

public void list_()

Specified by:

list_ in interface Sink

Overrides:

list_ in class SinkAdapter

listItem

public void listItem()

Specified by:

listItem in interface Sink

Overrides:

listItem in class SinkAdapter

listItem

public void listItem(SinkEventAttributes attributes)

Specified by:

listItem in interface Sink

Overrides:

listItem in class SinkAdapter

numberedList

public void numberedList(int numbering)

Specified by:

numberedList in interface Sink

Overrides:

numberedList in class SinkAdapter

numberedList

public void numberedList(int numbering,
                         SinkEventAttributes attributes)

Specified by:

numberedList in interface Sink

Overrides:

numberedList in class SinkAdapter

numberedList_

public void numberedList_()

Specified by:

numberedList_ in interface Sink

Overrides:

numberedList_ in class SinkAdapter

numberedListItem

public void numberedListItem()

Specified by:

numberedListItem in interface Sink

Overrides:

numberedListItem in class SinkAdapter

numberedListItem

public void numberedListItem(SinkEventAttributes attributes)

Specified by:

numberedListItem in interface Sink

Overrides:

numberedListItem in class SinkAdapter

definitionList

public void definitionList()

Specified by:

definitionList in interface Sink

Overrides:

definitionList in class SinkAdapter

definitionList

public void definitionList(SinkEventAttributes attributes)

Specified by:

definitionList in interface Sink

Overrides:

definitionList in class SinkAdapter

definitionList_

public void definitionList_()

Specified by:

definitionList_ in interface Sink

Overrides:

definitionList_ in class SinkAdapter

definedTerm

public void definedTerm()

Specified by:

definedTerm in interface Sink

Overrides:

definedTerm in class SinkAdapter

definedTerm

public void definedTerm(SinkEventAttributes attributes)

Specified by:

definedTerm in interface Sink

Overrides:

definedTerm in class SinkAdapter

definedTerm_

public void definedTerm_()

Specified by:

definedTerm_ in interface Sink

Overrides:

definedTerm_ in class SinkAdapter

definitionListItem

public void definitionListItem()

Specified by:

definitionListItem in interface Sink

Overrides:

definitionListItem in class SinkAdapter

definitionListItem

public void definitionListItem(SinkEventAttributes attributes)

Specified by:

definitionListItem in interface Sink

Overrides:

definitionListItem in class SinkAdapter

definitionListItem_

public void definitionListItem_()

Specified by:

definitionListItem_ in interface Sink

Overrides:

definitionListItem_ in class SinkAdapter

definition

public void definition()

Specified by:

definition in interface Sink

Overrides:

definition in class SinkAdapter

definition

public void definition(SinkEventAttributes attributes)

Specified by:

definition in interface Sink

Overrides:

definition in class SinkAdapter

definition_

public void definition_()

Specified by:

definition_ in interface Sink

Overrides:

definition_ in class SinkAdapter

figure

public void figure()

Specified by:

figure in interface Sink

Overrides:

figure in class SinkAdapter

figure

public void figure(SinkEventAttributes attributes)

Specified by:

figure in interface Sink

Overrides:

figure in class SinkAdapter

figure_

public void figure_()

Specified by:

figure_ in interface Sink

Overrides:

figure_ in class SinkAdapter

figureGraphics

public void figureGraphics(String name)

Specified by:

figureGraphics in interface Sink

Overrides:

figureGraphics in class SinkAdapter

figureGraphics

public void figureGraphics(String src,
                           SinkEventAttributes attributes)

Specified by:

figureGraphics in interface Sink

Overrides:

figureGraphics in class SinkAdapter

figureCaption

public void figureCaption()

Specified by:

figureCaption in interface Sink

Overrides:

figureCaption in class SinkAdapter

figureCaption

public void figureCaption(SinkEventAttributes attributes)

Specified by:

figureCaption in interface Sink

Overrides:

figureCaption in class SinkAdapter

figureCaption_

public void figureCaption_()

Specified by:

figureCaption_ in interface Sink

Overrides:

figureCaption_ in class SinkAdapter

table

public void table()

Specified by:

table in interface Sink

Overrides:

table in class SinkAdapter

table

public void table(SinkEventAttributes attributes)

Specified by:

table in interface Sink

Overrides:

table in class SinkAdapter

table_

public void table_()

Specified by:

table_ in interface Sink

Overrides:

table_ in class SinkAdapter

tableRows

public void tableRows(int[] justification,
                      boolean grid)

Specified by:

tableRows in interface Sink

Overrides:

tableRows in class SinkAdapter

tableRows_

public void tableRows_()

Specified by:

tableRows_ in interface Sink

Overrides:

tableRows_ in class SinkAdapter

tableRow

public void tableRow()

Specified by:

tableRow in interface Sink

Overrides:

tableRow in class SinkAdapter

tableRow

public void tableRow(SinkEventAttributes attributes)

Specified by:

tableRow in interface Sink

Overrides:

tableRow in class SinkAdapter

tableRow_

public void tableRow_()

Specified by:

tableRow_ in interface Sink

Overrides:

tableRow_ in class SinkAdapter

tableCell

public void tableCell()

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

tableCell

public void tableCell(String width)

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

tableCell

public void tableCell(SinkEventAttributes attributes)

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

tableCell_

public void tableCell_()

Specified by:

tableCell_ in interface Sink

Overrides:

tableCell_ in class SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

tableHeaderCell

public void tableHeaderCell(String width)

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

tableHeaderCell

public void tableHeaderCell(SinkEventAttributes attributes)

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Specified by:

tableHeaderCell_ in interface Sink

Overrides:

tableHeaderCell_ in class SinkAdapter

tableCaption

public void tableCaption()

Specified by:

tableCaption in interface Sink

Overrides:

tableCaption in class SinkAdapter

tableCaption

public void tableCaption(SinkEventAttributes attributes)

Specified by:

tableCaption in interface Sink

Overrides:

tableCaption in class SinkAdapter

tableCaption_

public void tableCaption_()

Specified by:

tableCaption_ in interface Sink

Overrides:

tableCaption_ in class SinkAdapter

paragraph

public void paragraph()

Specified by:

paragraph in interface Sink

Overrides:

paragraph in class SinkAdapter

paragraph

public void paragraph(SinkEventAttributes attributes)

Specified by:

paragraph in interface Sink

Overrides:

paragraph in class SinkAdapter

paragraph_

public void paragraph_()

Specified by:

paragraph_ in interface Sink

Overrides:

paragraph_ in class SinkAdapter

verbatim

public void verbatim(boolean boxed)

Specified by:

verbatim in interface Sink

Overrides:

verbatim in class SinkAdapter

verbatim

public void verbatim(SinkEventAttributes attributes)

Specified by:

verbatim in interface Sink

Overrides:

verbatim in class SinkAdapter

verbatim_

public void verbatim_()

Specified by:

verbatim_ in interface Sink

Overrides:

verbatim_ in class SinkAdapter

horizontalRule

public void horizontalRule()

Specified by:

horizontalRule in interface Sink

Overrides:

horizontalRule in class SinkAdapter

horizontalRule

public void horizontalRule(SinkEventAttributes attributes)

Specified by:

horizontalRule in interface Sink

Overrides:

horizontalRule in class SinkAdapter

pageBreak

public void pageBreak()

Specified by:

pageBreak in interface Sink

Overrides:

pageBreak in class SinkAdapter

anchor

public void anchor(String name)

Specified by:

anchor in interface Sink

Overrides:

anchor in class SinkAdapter

anchor

public void anchor(String name,
                   SinkEventAttributes attributes)

Specified by:

anchor in interface Sink

Overrides:

anchor in class SinkAdapter

anchor_

public void anchor_()

Specified by:

anchor_ in interface Sink

Overrides:

anchor_ in class SinkAdapter

link

public void link(String name)

Specified by:

link in interface Sink

Overrides:

link in class SinkAdapter

link

public void link(String name,
                 SinkEventAttributes attributes)

Specified by:

link in interface Sink

Overrides:

link in class SinkAdapter

link_

public void link_()

Specified by:

link_ in interface Sink

Overrides:

link_ in class SinkAdapter

italic

public void italic()

Specified by:

italic in interface Sink

Overrides:

italic in class SinkAdapter

italic_

public void italic_()

Specified by:

italic_ in interface Sink

Overrides:

italic_ in class SinkAdapter

bold

public void bold()

Specified by:

bold in interface Sink

Overrides:

bold in class SinkAdapter

bold_

public void bold_()

Specified by:

bold_ in interface Sink

Overrides:

bold_ in class SinkAdapter

monospaced

public void monospaced()

Specified by:

monospaced in interface Sink

Overrides:

monospaced in class SinkAdapter

monospaced_

public void monospaced_()

Specified by:

monospaced_ in interface Sink

Overrides:

monospaced_ in class SinkAdapter

lineBreak

public void lineBreak()

Specified by:

lineBreak in interface Sink

Overrides:

lineBreak in class SinkAdapter

lineBreak

public void lineBreak(SinkEventAttributes attributes)

Specified by:

lineBreak in interface Sink

Overrides:

lineBreak in class SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Specified by:

nonBreakingSpace in interface Sink

Overrides:

nonBreakingSpace in class SinkAdapter

text

public void text(String text)

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

text

public void text(String text,
                 SinkEventAttributes attributes)

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

rawText

public void rawText(String text)

Specified by:

rawText in interface Sink

Overrides:

rawText in class SinkAdapter

comment

public void comment(String comment)

Specified by:

comment in interface Sink

Overrides:

comment in class SinkAdapter

unknown

public void unknown(String name,
                    Object[] requiredParams,
                    SinkEventAttributes attributes)

Unkown events just log a warning message but are ignored otherwise.

Specified by:

unknown in interface Sink

Overrides:

unknown in class SinkAdapter

See Also:

Sink.unknown(String,Object[],SinkEventAttributes)

markup

protected void markup(String text)

Writes the text, preserving whitespace.

Parameters:

text - the text to write.

content

protected void content(String text)

Writes the text, without preserving whitespace.

Parameters:

text - the text to write.

verbatimContent

protected void verbatimContent(String text)

Writes the text, preserving whitespace.

Parameters:

text - the text to write.

escaped

public static String escaped(String text)

Escapes special characters.

Parameters:

text - The text to escape.

Returns:

The text with special characters replaced.

flush

public void flush()

Specified by:

flush in interface Sink

Overrides:

flush in class SinkAdapter

close

public void close()

Specified by:

close in interface Sink

Overrides:

close in class SinkAdapter

defaultSinkCommands

protected String defaultSinkCommands()

Returns the default sink commands.

Returns:

String.

defaultPreamble

protected String defaultPreamble()

Returns the default preamble.

Returns:

String.

init

protected void init()

Overrides:

init in class AbstractSink