org.apache.maven.doxia.book.services.renderer.docbook

Class DocBookBookSink

java.lang.Object

org.apache.maven.doxia.sink.AbstractSink

org.apache.maven.doxia.sink.SinkAdapter

org.apache.maven.doxia.sink.AbstractXmlSink

org.apache.maven.doxia.module.docbook.DocBookSink

org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink

All Implemented Interfaces:

LogEnabled, Markup, XmlMarkup, DocbookMarkup, SimplifiedDocbookMarkup, Sink

public class DocBookBookSink
extends DocBookSink

An Docbook Sink that doesn't write out head or body elements for every section of a book, and has some convenience methods relating to the construction of a Doxia Book.

Since:

1.1

Version:

$Id: DocBookBookSink.java 808201 2009-08-26 22:04:43Z vsiveton $

Author:

Dave Syer

Field Summary

Fields inherited from class org.apache.maven.doxia.module.docbook.DocBookSink

DEFAULT_SGML_PUBLIC_ID, DEFAULT_SGML_SYSTEM_ID, DEFAULT_XML_PUBLIC_ID, DEFAULT_XML_SYSTEM_ID

Fields inherited from interface org.apache.maven.doxia.module.docbook.DocbookMarkup

ANCHOR_TAG, ARABIC_STYLE, ARTICLE_TAG, ARTICLEINFO_TAG, BOOK_TAG, BOOKINFO_TAG, CHAPTER_TAG, COLS_ATTRIBUTE, COLSEP_ATTRIBUTE, COLSPEC_TAG, CORPAUTHOR_TAG, DATE_TAG, EMAIL_TAG, ENTRY_TAG, FIGURE_TAG, FILEREF_ATTRIBUTE, FORMALPARA_TAG, FORMAT_ATTRIBUTE, FRAME_ATTRIBUTE, IMAGEDATA_TAG, IMAGEOBJECT_TAG, INFO_TAG, INFORMALFIGURE_TAG, INFORMALTABLE_TAG, ITEMIZEDLIST_TAG, LINK_TAG, LINKEND_ATTRIBUTE, LISTITEM_TAG, LOWERALPHA_STYLE, LOWERROMAN_STYLE, MEDIAOBJECT_TAG, NUMERATION_ATTRIBUTE, ORDEREDLIST_TAG, PARA_TAG, PROGRAMLISTING_TAG, ROW_TAG, ROWSEP_ATTRIBUTE, SECTION_TAG, SIMPARA_TAG, TBODY_TAG, TERM_TAG, TGROUP_TAG, THEAD_TAG, ULINK_TAG, UPPERALPHA_STYLE, UPPERROMAN_STYLE, URL_ATTRIBUTE, URL_TAG, VARIABLELIST_TAG, VARLISTENTRY_TAG, XREF_TAG

Fields inherited from interface org.apache.maven.doxia.module.docbook.SimplifiedDocbookMarkup

ABBREV_TAG, ABSTRACT_TAG, ACRONYM_TAG, AFFILIATION_TAG, ANCHOR_TAG, APPENDIX_TAG, ARABIC_STYLE, ARTICLE_TAG, ARTICLEINFO_TAG, ATTRIBUTION_TAG, AUDIODATA_TAG, AUDIOOBJECT_TAG, AUTHOR_TAG, AUTHORBLURB_TAG, AUTHORGROUP_TAG, AUTHORINITIALS_TAG, BIBLIODIV_TAG, BIBLIOGRAPHY_TAG, BIBLIOMISC_TAG, BIBLIOMIXED_TAG, BIBLIOMSET_TAG, BLOCKQUOTE_TAG, CAPTION_TAG, CITETITLE_TAG, COL_TAG, COLGROUP_TAG, COLS_ATTRIBUTE, COLSEP_ATTRIBUTE, COLSPEC_TAG, COMMAND_TAG, COMPUTEROUTPUT_TAG, COPYRIGHT_TAG, CORPAUTHOR_TAG, DATE_TAG, EDITION_TAG, EDITOR_TAG, EMAIL_TAG, EMPHASIS_TAG, ENTRY_TAG, ENTRYTBL_TAG, EPIGRAPH_TAG, EXAMPLE_TAG, FIGURE_TAG, FILENAME_TAG, FILEREF_ATTRIBUTE, FIRSTNAME_TAG, FOOTNOTE_TAG, FOOTNOTEREF_TAG, FORMAT_ATTRIBUTE, FRAME_ATTRIBUTE, HOLDER_TAG, HONORIFIC_TAG, ID_ATTRIBUTE, IMAGEDATA_TAG, IMAGEOBJECT_TAG, INFORMALTABLE_TAG, INLINEMEDIAOBJECT_TAG, ISSUENUM_TAG, ITEMIZEDLIST_TAG, JOBTITLE_TAG, KEYWORD_TAG, KEYWORDSET_TAG, LANG_ATTRIBUTE, LEGALNOTICE_TAG, LINEAGE_TAG, LINEANNOTATION_TAG, LINK_TAG, LINKEND_ATTRIBUTE, LISTITEM_TAG, LITERAL_TAG, LITERALLAYOUT_TAG, LOWERALPHA_STYLE, LOWERROMAN_STYLE, MEDIAOBJECT_TAG, NOTE_TAG, NUMERATION_ATTRIBUTE, OBJECTINFO_TAG, OPTION_TAG, ORDEREDLIST_TAG, ORGNAME_TAG, OTHERCREDIT_TAG, OTHERNAME_TAG, PARA_TAG, PHRASE_TAG, PROGRAMLISTING_TAG, PUBDATE_TAG, PUBLISHERNAME_TAG, QUOTE_TAG, RELEASEINFO_TAG, REMAP_ATTRIBUTE, REPLACEABLE_TAG, REVDESCRIPTION_TAG, REVHISTORY_TAG, REVISION_TAG, REVISIONFLAG_ATTRIBUTE, REVNUMBER_TAG, REVREMARK_TAG, ROW_TAG, ROWSEP_ATTRIBUTE, SECTION_TAG, SECTIONINFO_TAG, SIDEBAR_TAG, SPANSPEC_TAG, SUBJECT_TAG, SUBJECTSET_TAG, SUBJECTTERM_TAG, SUBSCRIPT_TAG, SUBTITLE_TAG, SUPERSCRIPT_TAG, SURNAME_TAG, SYSTEMITEM_TAG, TABLE_TAG, TBODY_TAG, TD_TAG, TERM_TAG, TEXTDATA_TAG, TEXTOBJECT_TAG, TFOOT_TAG, TGROUP_TAG, TH_TAG, THEAD_TAG, TITLE_TAG, TITLEABBREV_TAG, TR_TAG, TRADEMARK_TAG, ULINK_TAG, UPPERALPHA_STYLE, UPPERROMAN_STYLE, URL_ATTRIBUTE, USERINPUT_TAG, VARIABLELIST_TAG, VARLISTENTRY_TAG, VIDEODATA_TAG, VIDEOOBJECT_TAG, VOLUMENUM_TAG, XREF_TAG, YEAR_TAG

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

BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

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

Constructors

Constructor and Description
DocBookBookSink(Writer out) Construct a new DocBookSink.

Method Summary

Methods

Modifier and Type	Method and Description
void	author_() Ends an author element.
void	author() Starts an author element.
void	body_() Ends the body element.
void	body() Starts the body of a document.
void	book_() Emit the end tag for the book.
void	book() Emit the start tag for the book.
void	bookAuthor_() Emit the author end tag for the whole book.
void	bookAuthor() Emit the author start tag for the whole book.
void	bookDate_() Emit the date end tag for the whole book.
void	bookDate() Emit the date start tag for the whole book.
void	bookHead_() If some header matter has been encountered emit the book info end tag.
void	bookTitle_() Emit the title end tag for the whole book.
void	bookTitle() Emit the title start tag for the whole book.
void	chapter_() Emit the chapter end tag.
void	chapter() Emit the chapter start tag.
void	chapterTitle_() Emit the chapter title end tag.
void	chapterTitle() Emit the chapter title start tag.
void	head_() Ends the head element.
void	head() Starts the head element.
void	title_() Ends the title element.
void	title() Starts the title element.

Methods inherited from class org.apache.maven.doxia.module.docbook.DocBookSink

anchor_, anchor, bold_, bold, close, comment, content, date_, date, definedTerm_, definedTerm, definition_, definition, definitionList_, definitionList, definitionListItem_, definitionListItem, escapeSGML, figure_, figure, figureCaption_, figureCaption, figureGraphics, flush, getBoldElement, getEncoding, getHorizontalRuleElement, getItalicElement, getLanguage, getLineBreakElement, getMonospacedElement, getPageBreakElement, getPublicId, getStyleSheet, getSystemId, graphicElement, horizontalRule, init, isXMLMode, italic_, italic, lineBreak, link_, link, list_, list, listItem_, listItem, markup, monospaced_, monospaced, nonBreakingSpace, numberedList_, numberedList, numberedListItem_, numberedListItem, pageBreak, paragraph_, paragraph, resetState, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, setBoldElement, setEncoding, setHorizontalRuleElement, setItalicElement, setLanguage, setLineBreakElement, setMonospacedElement, setPageBreakElement, setPublicId, setSkip, setStyleSheet, setSystemId, setXMLMode, table_, table, tableCaption_, tableCaption, tableCell_, tableCell, tableHeaderCell_, tableHeaderCell, tableRow_, tableRow, tableRows_, tableRows, text, unknown, verbatim_, verbatim, verbatimContent, write, writeXmlHeader

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

getNameSpace, setNameSpace, writeEndTag, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag, writeStartTag

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

anchor, author, body, date, definedTerm, definition, definitionList, definitionListItem, figure, figureCaption, figureGraphics, head, horizontalRule, lineBreak, link, list, listItem, numberedList, numberedListItem, paragraph, rawText, section_, section, sectionTitle_, sectionTitle, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, verbatim

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

DocBookBookSink

public DocBookBookSink(Writer out)

Construct a new DocBookSink.

Parameters:

out - the writer for the sink.

Method Detail

head

public void head()

Starts the head element. Does nothing because we don't want the header from each document to crop up in the middle of a book.

Specified by:

head in interface Sink

Overrides:

head in class DocBookSink

See Also:

SimplifiedDocbookMarkup.DEFAULT_XML_PUBLIC_ID, SimplifiedDocbookMarkup.DEFAULT_XML_SYSTEM_ID, SimplifiedDocbookMarkup.ARTICLE_TAG

head_

public void head_()

Ends the head element. Does nothing because we don't want the header from each document to crop up in the middle of a book.

Specified by:

head_ in interface Sink

Overrides:

head_ in class DocBookSink

See Also:

SimplifiedDocbookMarkup.ARTICLEINFO_TAG

title

public void title()

Starts the title element. Marks the skip flag to true so that this element's text is not emitted by the base class.

Specified by:

title in interface Sink

Overrides:

title in class DocBookSink

See Also:

SimplifiedDocbookMarkup.ARTICLEINFO_TAG, SimplifiedDocbookMarkup.TITLE_TAG

title_

public void title_()

Ends the title element. Marks the skip flag to false so that rendering can resume.

Specified by:

title_ in interface Sink

Overrides:

title_ in class DocBookSink

See Also:

SimplifiedDocbookMarkup.TITLE_TAG

author

public void author()

Starts an author element. Marks the skip flag to true so that this element's text is not emitted by the base class.

Specified by:

author in interface Sink

Overrides:

author in class DocBookSink

See Also:

SimplifiedDocbookMarkup.CORPAUTHOR_TAG

author_

public void author_()

Ends an author element. Marks the skip flag to false so that rendering can resume.

Specified by:

author_ in interface Sink

Overrides:

author_ in class DocBookSink

See Also:

SimplifiedDocbookMarkup.CORPAUTHOR_TAG

body

public void body()

Starts the body of a document. Does nothing because we don't want the header from each document to crop up in the middle of a book.

Specified by:

body in interface Sink

Overrides:

body in class SinkAdapter

See Also:

Sink.body(SinkEventAttributes)

body_

public void body_()

Ends the body element. Does nothing because we don't want the header from each document to crop up in the middle of a book.

Specified by:

body_ in interface Sink

Overrides:

body_ in class DocBookSink

See Also:

SimplifiedDocbookMarkup.ARTICLE_TAG

book

public void book()

Emit the start tag for the book.

See Also:

DocbookMarkup.BOOK_TAG

book_

public void book_()

Emit the end tag for the book.

See Also:

DocbookMarkup.BOOK_TAG

bookHead_

public void bookHead_()

If some header matter has been encountered emit the book info end tag.

bookTitle

public void bookTitle()

Emit the title start tag for the whole book.

bookTitle_

public void bookTitle_()

Emit the title end tag for the whole book.

bookAuthor

public void bookAuthor()

Emit the author start tag for the whole book.

bookAuthor_

public void bookAuthor_()

Emit the author end tag for the whole book.

bookDate

public void bookDate()

Emit the date start tag for the whole book.

bookDate_

public void bookDate_()

Emit the date end tag for the whole book.

chapter

public void chapter()

Emit the chapter start tag.

chapter_

public void chapter_()

Emit the chapter end tag.

chapterTitle

public void chapterTitle()

Emit the chapter title start tag.

chapterTitle_

public void chapterTitle_()

Emit the chapter title end tag.