FoAggregateSink

java.lang.Object
- org.apache.maven.doxia.sink.impl.AbstractSink
- - org.apache.maven.doxia.sink.impl.SinkAdapter
  - - org.apache.maven.doxia.sink.impl.AbstractXmlSink
    - - org.apache.maven.doxia.module.fo.FoSink
      - org.apache.maven.doxia.module.fo.FoAggregateSink

All Implemented Interfaces:

org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, FoMarkup
```
public class FoAggregateSink
extends FoSink
```
A Doxia Sink that produces an aggregated FO model. The usage is similar to the following:
```
 FoAggregateSink sink = new FoAggregateSink( writer );
 sink.setDocumentModel( documentModel );
 sink.beginDocument();
 sink.coverPage();
 sink.toc();
 ...
 sink.endDocument();
 
```
Note: the documentModel object contains several document metadata, but only a few of them are used in this sink (i.e. author, confidential, date and title), the others are ignored.
Since:

1.1

Version:

$Id: FoAggregateSink.java 1726411 2016-01-23 16:34:09Z hboutemy $

Author:

ltheussl

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`TOC_END`	Table Of Content at the end of the document.
`static int`	`TOC_NONE`	No Table Of Content.
`static int`	`TOC_START`	Table Of Content at the start of the document.

Fields inherited from interface org.apache.maven.doxia.module.fo.FoMarkup
BASIC_LINK_TAG, BLOCK_TAG, BOOKMARK_TAG, BOOKMARK_TITLE_TAG, BOOKMARK_TREE_TAG, FLOW_TAG, FO_NAMESPACE, INLINE_TAG, LAYOUT_MASTER_SET_TAG, LEADER_TAG, LIST_BLOCK_TAG, LIST_ITEM_BODY_TAG, LIST_ITEM_LABEL_TAG, LIST_ITEM_TAG, PAGE_NUMBER_CITATION_TAG, PAGE_NUMBER_TAG, PAGE_SEQUENCE_TAG, REGION_AFTER_TAG, REGION_BEFORE_TAG, REGION_BODY_TAG, ROOT_TAG, SIMPLE_PAGE_MASTER_TAG, STATIC_CONTENT_TAG, TABLE_AND_CAPTION_TAG, TABLE_BODY_TAG, TABLE_CAPTION_TAG, TABLE_CELL_TAG, TABLE_COLUMN_TAG, TABLE_ROW_TAG, TABLE_TAG

Fields inherited from class org.apache.maven.doxia.module.fo.FoSink
warnMessages

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, SECTION_LEVEL_6

Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

Constructor Summary

Constructors
Constructor Description

FoAggregateSink(java.io.Writer writer)
Constructor.

Constructors
Constructor	Description
`FoAggregateSink(java.io.Writer writer)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`anchor(java.lang.String name)`
`void`	`anchor(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`author()`
`void`	`author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`author_()`
`void`	`body()`
`void`	`body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`body_()`
`protected void`	`chapterHeading(java.lang.String headerText, boolean chapterNumber)`	Writes a chapter heading.
`protected void`	`content(java.lang.String text)`	Writes content, escaping special characters.
`void`	`coverPage()`	Writes a cover page.
`void`	`date()`
`void`	`date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`date_()`
`void`	`figureGraphics(java.lang.String name)`
`void`	`figureGraphics(java.lang.String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`protected java.lang.String`	`getChapterString()`	Returns the current chapter number as a string.
`protected java.lang.String`	`getFooterText()`	Returns the text to write in the footer of each page.
`protected java.lang.String`	`getHeaderText()`	Returns the text to write in the header of each page.
`void`	`head()`
`void`	`head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`head_()`
`void`	`link(java.lang.String name)`
`void`	`link(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`protected void`	`newline()`	Writes EOL.
`protected void`	`pdfBookmarks()`	Writes a fo:bookmark-tree.
`protected void`	`regionAfter(java.lang.String footerText)`	Writes a 'xsl-region-after' block.
`protected void`	`regionBefore(java.lang.String headerText)`	Writes a 'xsl-region-before' block.
`void`	`setDocumentModel(org.apache.maven.doxia.document.DocumentModel model)`	Sets the DocumentModel to be used by this sink.
`void`	`setDocumentModel(org.apache.maven.doxia.document.DocumentModel model, int tocPos)`	Sets the DocumentModel to be used by this sink.
`void`	`setDocumentName(java.lang.String name)`	Sets the name of the current source document, relative to the source root.
`void`	`setDocumentTitle(java.lang.String title)`	Sets the title of the current document.
`protected void`	`startPageSequence(java.lang.String headerText, java.lang.String footerText)`	Starts a page sequence, depending on the current chapter.
`void`	`title()`
`void`	`title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`title_()`
`void`	`toc()`	Writes a table of contents.
`protected void`	`write(java.lang.String text)`	Writes a text, swallowing any exceptions.
`protected void`	`writeEmptyTag(javax.swing.text.html.HTML.Tag tag, java.lang.String attributeId)`	Writes a simple tag, appending EOL.
`protected void`	`writeEndTag(javax.swing.text.html.HTML.Tag t)`
`protected void`	`writeln(java.lang.String text)`	Writes a text, appending EOL.
`protected void`	`writeStartTag(javax.swing.text.html.HTML.Tag tag, java.lang.String attributeId)`	Writes a start tag, prepending EOL.
`protected void`	`writeStartTag(javax.swing.text.html.HTML.Tag tag, java.lang.String id, java.lang.String name)`	Writes a start tag, prepending EOL.

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag

Methods inherited from class org.apache.maven.doxia.module.fo.FoSink
anchor_, beginDocument, bold, bold_, close, comment, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, definitionListItem, definitionListItem, definitionListItem_, endDocument, escaped, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, flush, getFoConfiguration, horizontalRule, horizontalRule, init, isFigure, italic, italic_, lineBreak, lineBreak, link_, list, list, list_, listItem, listItem, listItem_, load, logMessage, monospaced, monospaced_, nonBreakingSpace, numberedList, numberedList, numberedList_, numberedListItem, numberedListItem, numberedListItem_, pageBreak, paragraph, paragraph, paragraph_, rawText, resetSectionCounter, section, section_, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, sectionTitle, sectionTitle, sectionTitle_, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, startPageSequence, table, table, table_, tableCaption, tableCaption, tableCaption_, tableCell, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow, tableRow_, tableRows, tableRows_, text, text, unknown, verbatim, verbatim, verbatim_, writeEmptyTag, writeStartTag, writeStartTag

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

Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
section6, section6_, sectionTitle6, sectionTitle6_

- Field Detail
  - TOC_NONE
```
public static final int TOC_NONE
```
    No Table Of Content.
    
    See Also:
    
    setDocumentModel(DocumentModel, int), Constant Field Values
  - TOC_START
```
public static final int TOC_START
```
    Table Of Content at the start of the document.
    
    See Also:
    
    setDocumentModel(DocumentModel, int), Constant Field Values
  - TOC_END
```
public static final int TOC_END
```
    Table Of Content at the end of the document.
    
    See Also:
    
    setDocumentModel(DocumentModel, int), Constant Field Values
- Constructor Detail
  - FoAggregateSink
```
public FoAggregateSink(java.io.Writer writer)
```
    Constructor.
    
    Parameters:
    
    writer - The writer for writing the result.
- Method Detail
  - head
```
public void head()
```
    Overrides:
    
    head in class FoSink
  - head
```
public void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    head in class FoSink
  - head_
```
public void head_()
```
    Overrides:
    
    head_ in class FoSink
  - title
```
public void title()
```
    Overrides:
    
    title in class FoSink
  - title
```
public void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    title in class FoSink
  - title_
```
public void title_()
```
    Overrides:
    
    title_ in class FoSink
  - author
```
public void author()
```
    Overrides:
    
    author in class FoSink
  - author
```
public void author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    author in class FoSink
  - author_
```
public void author_()
```
    Overrides:
    
    author_ in class FoSink
  - date
```
public void date()
```
    Overrides:
    
    date in class FoSink
  - date
```
public void date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    date in class FoSink
  - date_
```
public void date_()
```
    Overrides:
    
    date_ in class FoSink
  - body
```
public void body()
```
    Overrides:
    
    body in class FoSink
  - body
```
public void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    body in class FoSink
  - body_
```
public void body_()
```
    Overrides:
    
    body_ in class FoSink
  - setDocumentTitle
```
public void setDocumentTitle(java.lang.String title)
```
    Sets the title of the current document. This is used as a chapter title in the page header.
    
    Parameters:
    
    title - the title of the current document.
  - setDocumentName
```
public void setDocumentName(java.lang.String name)
```
    Sets the name of the current source document, relative to the source root. Used to resolve links to other source documents.
    
    Parameters:
    
    name - the name for the current document.
  - setDocumentModel
```
public void setDocumentModel(org.apache.maven.doxia.document.DocumentModel model)
```
    Sets the DocumentModel to be used by this sink. The DocumentModel provides all the meta-information required to render a document, eg settings for the cover page, table of contents, etc.
    By default, a TOC will be added at the beginning of the document.
    
    Parameters:
    
    model - the DocumentModel.
    
    See Also:
    
    #setDocumentModel(DocumentModel, String), TOC_START
  - setDocumentModel
```
public void setDocumentModel(org.apache.maven.doxia.document.DocumentModel model,
                             int tocPos)
```
    Sets the DocumentModel to be used by this sink. The DocumentModel provides all the meta-information required to render a document, eg settings for the cover page, table of contents, etc.
    
    Parameters:
    
    model - the DocumentModel, could be null.
    
    tocPos - should be one of these values: TOC_NONE, TOC_START and TOC_END.
    
    Since:
    
    1.1.2
  - figureGraphics
```
public void figureGraphics(java.lang.String name)
```
    Overrides:
    
    figureGraphics in class FoSink
  - figureGraphics
```
public void figureGraphics(java.lang.String src,
                           org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    figureGraphics in class FoSink
  - anchor
```
public void anchor(java.lang.String name)
```
    Overrides:
    
    anchor in class FoSink
  - anchor
```
public void anchor(java.lang.String name,
                   org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    anchor in class FoSink
  - link
```
public void link(java.lang.String name)
```
    Overrides:
    
    link in class FoSink
  - link
```
public void link(java.lang.String name,
                 org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Overrides:
    
    link in class FoSink
  - writeStartTag
```
protected void writeStartTag(javax.swing.text.html.HTML.Tag tag,
                             java.lang.String attributeId)
```
    Writes a start tag, prepending EOL.
    Writes a start tag, prepending EOL.
    
    Overrides:
    
    writeStartTag in class FoSink
    
    Parameters:
    
    tag - The tag.
    
    attributeId - An id identifying the attribute set.
  - writeStartTag
```
protected void writeStartTag(javax.swing.text.html.HTML.Tag tag,
                             java.lang.String id,
                             java.lang.String name)
```
    Writes a start tag, prepending EOL.
    Writes a start tag, prepending EOL.
    
    Overrides:
    
    writeStartTag in class FoSink
    
    Parameters:
    
    tag - The tag.
    
    id - An id to add.
    
    name - The name (value) of the id.
  - writeEndTag
```
protected void writeEndTag(javax.swing.text.html.HTML.Tag t)
```
    Writes an end tag, appending EOL.
    
    Overrides:
    
    writeEndTag in class FoSink
  - writeEmptyTag
```
protected void writeEmptyTag(javax.swing.text.html.HTML.Tag tag,
                             java.lang.String attributeId)
```
    Writes a simple tag, appending EOL.
    Writes a simple tag, appending EOL.
    
    Overrides:
    
    writeEmptyTag in class FoSink
    
    Parameters:
    
    tag - The tag name.
    
    attributeId - An id identifying the attribute set.
  - write
```
protected void write(java.lang.String text)
```
    Writes a text, swallowing any exceptions.
    Writes a text, swallowing any exceptions.
    
    Overrides:
    
    write in class FoSink
  - writeln
```
protected void writeln(java.lang.String text)
```
    Writes a text, appending EOL.
    Writes a text, appending EOL.
    
    Overrides:
    
    writeln in class FoSink
    
    Parameters:
    
    text - The text to write.
  - content
```
protected void content(java.lang.String text)
```
    Writes content, escaping special characters.
    Writes content, escaping special characters.
    
    Overrides:
    
    content in class FoSink
    
    Parameters:
    
    text - The text to write.
  - newline
```
protected void newline()
```
    Writes EOL.
  - startPageSequence
```
protected void startPageSequence(java.lang.String headerText,
                                 java.lang.String footerText)
```
    Starts a page sequence, depending on the current chapter.
    
    Parameters:
    
    headerText - The text to write in the header, if null, nothing is written.
    
    footerText - The text to write in the footer, if null, nothing is written.
  - getHeaderText
```
protected java.lang.String getHeaderText()
```
    Returns the text to write in the header of each page.
    
    Returns:
    
    String
  - getFooterText
```
protected java.lang.String getFooterText()
```
    Returns the text to write in the footer of each page.
    
    Returns:
    
    String
  - getChapterString
```
protected java.lang.String getChapterString()
```
    Returns the current chapter number as a string. By default does nothing, gets overridden by AggregateSink.
    Returns the current chapter number as a string.
    
    Overrides:
    
    getChapterString in class FoSink
    
    Returns:
    
    an empty String.
  - regionBefore
```
protected void regionBefore(java.lang.String headerText)
```
    Writes a 'xsl-region-before' block.
    Writes a 'xsl-region-before' block.
    
    Overrides:
    
    regionBefore in class FoSink
    
    Parameters:
    
    headerText - The text to write in the header, if null, nothing is written.
  - regionAfter
```
protected void regionAfter(java.lang.String footerText)
```
    Writes a 'xsl-region-after' block. By default does nothing, gets overridden by AggregateSink.
    Writes a 'xsl-region-after' block.
    
    Overrides:
    
    regionAfter in class FoSink
    
    Parameters:
    
    footerText - The text to write in the footer, if null, nothing is written.
  - chapterHeading
```
protected void chapterHeading(java.lang.String headerText,
                              boolean chapterNumber)
```
    Writes a chapter heading. By default does nothing, gets overridden by AggregateSink.
    Writes a chapter heading.
    
    Overrides:
    
    chapterHeading in class FoSink
    
    Parameters:
    
    headerText - The text to write in the header, if null, the current document title is written.
    
    chapterNumber - True if the chapter number should be written in front of the text.
  - toc
```
public void toc()
```
    Writes a table of contents. The DocumentModel has to contain a DocumentTOC for this to work.
  - pdfBookmarks
```
protected void pdfBookmarks()
```
    Writes a fo:bookmark-tree. By default does nothing, gets overridden by AggregateSink.
    Writes a fo:bookmark-tree. The DocumentModel has to contain a DocumentTOC for this to work.
    
    Overrides:
    
    pdfBookmarks in class FoSink
  - coverPage
```
public void coverPage()
```
    Writes a cover page. The DocumentModel has to contain a DocumentMeta for this to work.

Class FoAggregateSink

Field Summary

Fields inherited from interface org.apache.maven.doxia.module.fo.FoMarkup

Fields inherited from class org.apache.maven.doxia.module.fo.FoSink

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class org.apache.maven.doxia.module.fo.FoSink

Methods inherited from class java.lang.Object

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

Field Detail

TOC_NONE

TOC_START

TOC_END

Constructor Detail

FoAggregateSink

Method Detail

head

head

head_

title

title

title_

author

author

author_

date

date

date_

body

body

body_

setDocumentTitle

setDocumentName

setDocumentModel

setDocumentModel

figureGraphics

figureGraphics

anchor

anchor

link

link

writeStartTag

writeStartTag

writeEndTag

writeEmptyTag

write

writeln

content

newline

startPageSequence

getHeaderText

getFooterText

getChapterString

regionBefore

regionAfter

chapterHeading

toc

pdfBookmarks

coverPage