org.apache.maven.doxia.module.fo

Class DocumentStructureExtractionSink

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

org.apache.maven.doxia.module.fo.DocumentStructureExtractionSink

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, FoMarkup, org.apache.maven.doxia.sink.Sink

public class DocumentStructureExtractionSink
extends FoAggregateSink

A Doxia Sink that is dedicated to extract the chapter structure from the files, in order to enrich the table of contents with sub-chapters. In order to reach this aim, this sink is used by the PdfRenderer during the render process. The documents are parsed into this sink one after another and after each document the substructure can be copied to a DocumentTOCItem by using the function "enrichTOCItemWithSubstructure()"

Since:

1.5.0.4-SNAPSHOT

Field Summary

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

TOC_END, TOC_NONE, TOC_START

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

inlineStack, warnMessages

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

Constructor Summary

Constructors

Constructor and Description
DocumentStructureExtractionSink(Writer writer)

Method Summary

Modifier and Type	Method and Description
void	author_()
void	author()
void	author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	body_()
void	body()
void	body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	date_()
void	date()
void	date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	enrichTOCItemWithSubstructure(org.apache.maven.doxia.document.DocumentTOCItem docTOCItem)
void	head_()
void	head()
void	head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	reset() Resets the parameters to start-values.
void	section_(int level)
void	section(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	section1_()
void	section1()
void	section2_()
void	section2()
void	section3_()
void	section3()
void	section4_()
void	section4()
void	section5_()
void	section5()
void	sectionTitle_()
void	sectionTitle_(int level)
void	sectionTitle()
void	sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	sectionTitle1_()
void	sectionTitle1()
void	sectionTitle2_()
void	sectionTitle2()
void	sectionTitle3_()
void	sectionTitle3()
void	sectionTitle4_()
void	sectionTitle4()
void	sectionTitle5_()
void	sectionTitle5()
void	title_()
void	title()
void	title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	write(String str) Writes a text, swallowing any exceptions.

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

activatePriorPageWriting, anchor, anchor, beginDocument, chapterHeading, closeExecSum, content, coverPage, execSum, figureGraphics, figureGraphics, getChapterName, getChapterString, getFooterText, getHeaderText, getPomProperty, getRendererContext, link, link, newline, pdfBookmarks, regionAfter, regionBefore, resetPageCounter, setChapter, setDocumentModel, setDocumentModel, setDocumentName, setDocumentTitle, startPageSequence, toc, writeEmptyTag, writeEndTag, writeln, writeStartTag, writeStartTag

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

anchor_, 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, getDocTOC, getFoConfiguration, horizontalRule, horizontalRule, init, inline_, inline, inline, 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, section6_, section6, sectionTitle6_, sectionTitle6, setDocTOC, 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 org.apache.maven.doxia.sink.impl.AbstractXmlSink

getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag

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

address_, address, address, article_, article, article, blockquote_, blockquote, blockquote, content_, content, content, data_, data, data, division_, division, division, footer_, footer, footer, header_, header, header, lineBreakOpportunity, lineBreakOpportunity, navigation_, navigation, navigation, sidebar_, sidebar, sidebar, time_, time, time

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

enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentStructureExtractionSink

public DocumentStructureExtractionSink(Writer writer)

Method Detail

head

public void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Specified by:

head in interface org.apache.maven.doxia.sink.Sink

Overrides:

head in class FoAggregateSink

head

public void head()

Specified by:

head in interface org.apache.maven.doxia.sink.Sink

Overrides:

head in class FoAggregateSink

head_

public void head_()

Specified by:

head_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

head_ in class FoAggregateSink

title

public void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Specified by:

title in interface org.apache.maven.doxia.sink.Sink

Overrides:

title in class FoAggregateSink

title

public void title()

Specified by:

title in interface org.apache.maven.doxia.sink.Sink

Overrides:

title in class FoAggregateSink

title_

public void title_()

Specified by:

title_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

title_ in class FoAggregateSink

author

public void author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Specified by:

author in interface org.apache.maven.doxia.sink.Sink

Overrides:

author in class FoAggregateSink

author

public void author()

Specified by:

author in interface org.apache.maven.doxia.sink.Sink

Overrides:

author in class FoAggregateSink

author_

public void author_()

Specified by:

author_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

author_ in class FoAggregateSink

date

public void date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Specified by:

date in interface org.apache.maven.doxia.sink.Sink

Overrides:

date in class FoAggregateSink

date

public void date()

Specified by:

date in interface org.apache.maven.doxia.sink.Sink

Overrides:

date in class FoAggregateSink

date_

public void date_()

Specified by:

date_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

date_ in class FoAggregateSink

body

public void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Specified by:

body in interface org.apache.maven.doxia.sink.Sink

Overrides:

body in class FoAggregateSink

body

public void body()

Specified by:

body in interface org.apache.maven.doxia.sink.Sink

Overrides:

body in class FoAggregateSink

body_

public void body_()

Specified by:

body_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

body_ in class FoAggregateSink

sectionTitle

public void sectionTitle()

Specified by:

sectionTitle in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle in class FoSink

sectionTitle_

public void sectionTitle_()

Specified by:

sectionTitle_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle_ in class FoSink

section

public void section(int level,
                    org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Specified by:

section in interface org.apache.maven.doxia.sink.Sink

Overrides:

section in class FoSink

section_

public void section_(int level)

Specified by:

section_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section_ in class FoSink

sectionTitle

public void sectionTitle(int level,
                         org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Specified by:

sectionTitle in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle in class FoSink

sectionTitle_

public void sectionTitle_(int level)

Specified by:

sectionTitle_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle_ in class FoSink

section1

public void section1()

Specified by:

section1 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section1 in class FoSink

sectionTitle1

public void sectionTitle1()

Specified by:

sectionTitle1 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle1 in class FoSink

sectionTitle1_

public void sectionTitle1_()

Specified by:

sectionTitle1_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle1_ in class FoSink

section1_

public void section1_()

Specified by:

section1_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section1_ in class FoSink

section2

public void section2()

Specified by:

section2 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section2 in class FoSink

sectionTitle2

public void sectionTitle2()

Specified by:

sectionTitle2 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle2 in class FoSink

sectionTitle2_

public void sectionTitle2_()

Specified by:

sectionTitle2_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle2_ in class FoSink

section2_

public void section2_()

Specified by:

section2_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section2_ in class FoSink

section3

public void section3()

Specified by:

section3 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section3 in class FoSink

sectionTitle3

public void sectionTitle3()

Specified by:

sectionTitle3 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle3 in class FoSink

sectionTitle3_

public void sectionTitle3_()

Specified by:

sectionTitle3_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle3_ in class FoSink

section3_

public void section3_()

Specified by:

section3_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section3_ in class FoSink

section4

public void section4()

Specified by:

section4 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section4 in class FoSink

sectionTitle4

public void sectionTitle4()

Specified by:

sectionTitle4 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle4 in class FoSink

sectionTitle4_

public void sectionTitle4_()

Specified by:

sectionTitle4_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle4_ in class FoSink

section4_

public void section4_()

Specified by:

section4_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section4_ in class FoSink

section5

public void section5()

Specified by:

section5 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section5 in class FoSink

sectionTitle5

public void sectionTitle5()

Specified by:

sectionTitle5 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle5 in class FoSink

sectionTitle5_

public void sectionTitle5_()

Specified by:

sectionTitle5_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle5_ in class FoSink

section5_

public void section5_()

Specified by:

section5_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section5_ in class FoSink

write

public void write(String str)

Description copied from class: FoAggregateSink

Writes a text, swallowing any exceptions.

Writes a text, swallowing any exceptions.

Overrides:

write in class FoAggregateSink

enrichTOCItemWithSubstructure

public void enrichTOCItemWithSubstructure(org.apache.maven.doxia.document.DocumentTOCItem docTOCItem)

reset

public void reset()

Resets the parameters to start-values. Has to be called after each parsing of a file, to clean up before the next run.