org.apache.maven.doxia.module.docbook

Class DocBookSink

public class DocBookSink extends AbstractXmlSink implements DocbookMarkup

A doxia Sink which produces a Docbook model.

Since: 1.0

Version: $Id: DocBookSink.java 568690 2007-08-22 16:30:06Z jdcasey $

Field Summary
static String	DEFAULT_SGML_PUBLIC_ID DocBook V4.1 SGML public id: "-//OASIS//DTD DocBook V4.1//EN"
static String	DEFAULT_XML_PUBLIC_ID DocBook XML V4.1.2 XML public id: "-//OASIS//DTD DocBook XML V4.1.2//EN"
static String	DEFAULT_XML_SYSTEM_ID DocBook XML V4.0 XML system id: "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"

Constructor Summary
	DocBookSink(Writer out, boolean isBook)
	DocBookSink(Writer writer)

Method Summary
void	anchor(String name)
void	anchor_()
void	author()
void	author_()
void	body_()
void	bold()
void	bold_()
void	book()
void	book_()
void	close()
protected void	content(String text) Write SGML escaped text to output, not preserving white space.
void	date()
void	date_()
void	definedTerm()
void	definedTerm_()
void	definition()
void	definitionList()
void	definitionListItem()
void	definitionListItem_()
void	definitionList_()
void	definition_()
static String	escapeSGML(String text, boolean xmlMode)
void	figureCaption()
void	figureCaption_()
void	figureGraphics(String name)
void	figure_()
void	flush()
String	getBoldElement() Returns the current boldBeginTag.
String	getEncoding() Returns the current encoding.
String	getHorizontalRuleElement() Returns the current horizontalRuleElement.
String	getItalicElement() Returns the current italicBeginTag.
String	getLanguage() Returns the current language.
String	getLineBreakElement() Returns the current lineBreakElement.
String	getMonospacedElement() Returns the current monospacedBeginTag.
String	getPageBreakElement() Returns the current pageBreakElement.
String	getPublicId() Returns the current publicId.
String	getStyleSheet() Returns the current styleSheet.
String	getSystemId() Returns the current systemId.
protected void	graphicElement()
void	head()
void	head_()
void	horizontalRule()
boolean	isXMLMode() Returns the current xmlMode.
void	italic()
void	italic_()
void	lineBreak()
void	link(String name)
void	link_()
void	list()
void	listItem()
void	listItem_()
void	list_()
protected void	markup(String text) Write text to output, preserving white space.
void	monospaced()
void	monospaced_()
void	nonBreakingSpace()
void	numberedList(int numbering)
void	numberedListItem()
void	numberedListItem_()
void	numberedList_()
void	pageBreak()
void	paragraph()
void	paragraph_()
void	section1()
void	section1_()
void	section2()
void	section2_()
void	section3()
void	section3_()
void	section4()
void	section4_()
void	section5()
void	section5_()
void	sectionTitle()
void	sectionTitle_()
void	setBoldElement(String tag) Sets the current boldBeginTag and constructs the corresponding end tag from it.
void	setEncoding(String enc) Sets the encoding.
void	setHorizontalRuleElement(String element) Sets the current horizontalRuleElement.
void	setItalicElement(String tag) Sets the current italicBeginTag and constructs the corresponding end tag from it.
void	setLanguage(String language) Sets the language.
void	setLineBreakElement(String element) Sets the current lineBreakElement.
void	setMonospacedElement(String tag) Sets the current monospacedBeginTag and constructs the corresponding end tag from it.
void	setPageBreakElement(String element) Sets the current pageBreakElement.
void	setPublicId(String id) Sets the publicId.
void	setStyleSheet(String sheet) Sets the styleSheet.
void	setSystemId(String id) Sets the systemId.
void	setXMLMode(boolean mode) Sets the xml mode.
void	table()
void	tableCaption()
void	tableCaption_()
void	tableCell()
void	tableCell_()
void	tableRow()
void	tableRows(int[] justification, boolean grid)
void	tableRows_()
void	tableRow_()
void	table_()
void	text(String text)
void	title()
void	title_()
void	verbatim(boolean boxed)
protected void	verbatimContent(String text) Write SGML escaped text to output, preserving white space.
void	verbatim_()
protected void	write(String text)

Field Detail

DEFAULT_SGML_PUBLIC_ID

public static final String DEFAULT_SGML_PUBLIC_ID

DocBook V4.1 SGML public id: "-//OASIS//DTD DocBook V4.1//EN"

DEFAULT_XML_PUBLIC_ID

public static final String DEFAULT_XML_PUBLIC_ID

DocBook XML V4.1.2 XML public id: "-//OASIS//DTD DocBook XML V4.1.2//EN"

DEFAULT_XML_SYSTEM_ID

public static final String DEFAULT_XML_SYSTEM_ID

DocBook XML V4.0 XML system id: "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"

Constructor Detail

DocBookSink

public DocBookSink(Writer out, boolean isBook)

DocBookSink

public DocBookSink(Writer writer)

Parameters: writer the default writer.

Method Detail

anchor

public void anchor(String name)

{@inheritDoc }

anchor_

public void anchor_()

{@inheritDoc }

author

public void author()

{@inheritDoc }

author_

public void author_()

{@inheritDoc }

body_

public void body_()

{@inheritDoc }

bold

public void bold()

{@inheritDoc }

bold_

public void bold_()

{@inheritDoc }

book

public void book()

{@inheritDoc }

book_

public void book_()

{@inheritDoc }

close

public void close()

{@inheritDoc }

content

protected void content(String text)

Write SGML escaped text to output, not preserving white space.

Parameters: text The text to write.

date

public void date()

{@inheritDoc }

date_

public void date_()

{@inheritDoc }

definedTerm

public void definedTerm()

{@inheritDoc }

definedTerm_

public void definedTerm_()

{@inheritDoc }

definition

public void definition()

{@inheritDoc }

See Also: LISTITEM_TAG

definitionList

public void definitionList()

{@inheritDoc }

definitionListItem

public void definitionListItem()

{@inheritDoc }

definitionListItem_

public void definitionListItem_()

{@inheritDoc }

definitionList_

public void definitionList_()

{@inheritDoc }

definition_

public void definition_()

{@inheritDoc }

See Also: LISTITEM_TAG

escapeSGML

public static final String escapeSGML(String text, boolean xmlMode)

Parameters: text The text to escape. xmlMode xmlMode.

Returns: The escaped text.

figureCaption

public void figureCaption()

{@inheritDoc }

See Also: FIGURE_TAG javax.swing.text.html.HTML.Tag#TITLE

figureCaption_

public void figureCaption_()

{@inheritDoc }

See Also: FIGURE_TAG javax.swing.text.html.HTML.Tag#TITLE

figureGraphics

public void figureGraphics(String name)

{@inheritDoc }

figure_

public void figure_()

{@inheritDoc }

flush

public void flush()

{@inheritDoc }

getBoldElement

public String getBoldElement()

Returns the current boldBeginTag.

Returns: the current boldBeginTag. Defaults to "".

getEncoding

public String getEncoding()

Returns the current encoding.

Returns: the current encoding.

getHorizontalRuleElement

public String getHorizontalRuleElement()

Returns the current horizontalRuleElement.

Returns: the current horizontalRuleElement. Defaults to "".

getItalicElement

public String getItalicElement()

Returns the current italicBeginTag.

Returns: the current italicBeginTag. Defaults to "".

getLanguage

public String getLanguage()

Returns the current language.

Returns: the current language.

getLineBreakElement

public String getLineBreakElement()

Returns the current lineBreakElement.

Returns: the current lineBreakElement. Defaults to "".

getMonospacedElement

public String getMonospacedElement()

Returns the current monospacedBeginTag.

Returns: the current monospacedBeginTag. Defaults to ">".

getPageBreakElement

public String getPageBreakElement()

Returns the current pageBreakElement.

Returns: the current pageBreakElement. Defaults to "".

getPublicId

public String getPublicId()

Returns the current publicId.

Returns: the current publicId.

getStyleSheet

public String getStyleSheet()

Returns the current styleSheet.

Returns: the current styleSheet.

getSystemId

public String getSystemId()

Returns the current systemId.

Returns: the current systemId.

graphicElement

protected void graphicElement()

head

public void head()

{@inheritDoc }

head_

public void head_()

{@inheritDoc }

horizontalRule

public void horizontalRule()

{@inheritDoc }

isXMLMode

public boolean isXMLMode()

Returns the current xmlMode.

Returns: the current xmlMode.

italic

public void italic()

{@inheritDoc }

italic_

public void italic_()

{@inheritDoc }

lineBreak

public void lineBreak()

{@inheritDoc }

link

public void link(String name)

{@inheritDoc }

link_

public void link_()

{@inheritDoc }

list

public void list()

{@inheritDoc }

listItem

public void listItem()

{@inheritDoc }

See Also: LISTITEM_TAG

listItem_

public void listItem_()

{@inheritDoc }

See Also: LISTITEM_TAG

list_

public void list_()

{@inheritDoc }

markup

protected void markup(String text)

Write text to output, preserving white space.

Parameters: text The text to write.

monospaced

public void monospaced()

{@inheritDoc }

monospaced_

public void monospaced_()

{@inheritDoc }

nonBreakingSpace

public void nonBreakingSpace()

{@inheritDoc }

numberedList

public void numberedList(int numbering)

{@inheritDoc }

numberedListItem

public void numberedListItem()

{@inheritDoc }

See Also: LISTITEM_TAG

numberedListItem_

public void numberedListItem_()

{@inheritDoc }

See Also: LISTITEM_TAG

numberedList_

public void numberedList_()

{@inheritDoc }

pageBreak

public void pageBreak()

{@inheritDoc }

paragraph

public void paragraph()

{@inheritDoc }

paragraph_

public void paragraph_()

{@inheritDoc }

section1

public void section1()

{@inheritDoc }

See Also: SECTION_TAG

section1_

public void section1_()

{@inheritDoc }

See Also: SECTION_TAG

section2

public void section2()

{@inheritDoc }

See Also: SECTION_TAG

section2_

public void section2_()

{@inheritDoc }

See Also: SECTION_TAG

section3

public void section3()

{@inheritDoc }

See Also: SECTION_TAG

section3_

public void section3_()

{@inheritDoc }

See Also: SECTION_TAG

section4

public void section4()

{@inheritDoc }

See Also: SECTION_TAG

section4_

public void section4_()

{@inheritDoc }

See Also: SECTION_TAG

section5

public void section5()

{@inheritDoc }

See Also: SECTION_TAG

section5_

public void section5_()

{@inheritDoc }

See Also: SECTION_TAG

sectionTitle

public void sectionTitle()

{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TITLE

sectionTitle_

public void sectionTitle_()

{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TITLE

setBoldElement

public void setBoldElement(String tag)

Sets the current boldBeginTag and constructs the corresponding end tag from it.

Parameters: tag the tag to set. If tag is null, the empty string is used.

setEncoding

public void setEncoding(String enc)

Sets the encoding.

Parameters: enc the encoding to set.

setHorizontalRuleElement

public void setHorizontalRuleElement(String element)

Sets the current horizontalRuleElement.

Parameters: element the element to set.

setItalicElement

public void setItalicElement(String tag)

Sets the current italicBeginTag and constructs the corresponding end tag from it.

Parameters: tag the tag to set. If tag is null, the empty string is used.

setLanguage

public void setLanguage(String language)

Sets the language.

Parameters: language the language to set.

setLineBreakElement

public void setLineBreakElement(String element)

Sets the current lineBreakElement.

Parameters: element the element to set.

setMonospacedElement

public void setMonospacedElement(String tag)

Sets the current monospacedBeginTag and constructs the corresponding end tag from it.

Parameters: tag the tag to set. If tag is null, the empty string is used.

setPageBreakElement

public void setPageBreakElement(String element)

Sets the current pageBreakElement.

Parameters: element the element to set.

setPublicId

public void setPublicId(String id)

Sets the publicId.

Parameters: id the publicId to set.

setStyleSheet

public void setStyleSheet(String sheet)

Sets the styleSheet.

Parameters: sheet the styleSheet to set.

setSystemId

public void setSystemId(String id)

Sets the systemId.

Parameters: id the systemId to set.

setXMLMode

public void setXMLMode(boolean mode)

Sets the xml mode.

Parameters: mode the mode to set.

table

public void table()

{@inheritDoc }

tableCaption

public void tableCaption()

{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TABLE FRAME_ATTRIBUTE ROWSEP_ATTRIBUTE COLSEP_ATTRIBUTE javax.swing.text.html.HTML.Tag#TITLE

tableCaption_

public void tableCaption_()

{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TITLE

tableCell

public void tableCell()

{@inheritDoc }

tableCell_

public void tableCell_()

{@inheritDoc }

tableRow

public void tableRow()

{@inheritDoc }

tableRows

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

{@inheritDoc }

tableRows_

public void tableRows_()

{@inheritDoc }

tableRow_

public void tableRow_()

{@inheritDoc }

table_

public void table_()

{@inheritDoc }

See Also: INFORMALTABLE_TAG FRAME_ATTRIBUTE ROWSEP_ATTRIBUTE COLSEP_ATTRIBUTE javax.swing.text.html.HTML.Tag#TABLE

text

public void text(String text)

{@inheritDoc }

title

public void title()

{@inheritDoc }

See Also: ARTICLEINFO_TAG javax.swing.text.html.HTML.Tag#TITLE

title_

public void title_()

{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TITLE

verbatim

public void verbatim(boolean boxed)

{@inheritDoc }

verbatimContent

protected void verbatimContent(String text)

Write SGML escaped text to output, preserving white space.

Parameters: text The text to write.

verbatim_

public void verbatim_()

{@inheritDoc }

write

protected void write(String text)

{@inheritDoc }