|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Sink
A Sink consumes Doxia events in a resultant output format like Docbook, PDF, or XHTML.
Doxia allows you to parse any supported input document format (ie for which a parser exists) and generate any supported output document format (ie for which a sink exists).
The upshot is that you can parse any front-end format, the parser is responsible for emitting the standard Doxia events which can then be consumed by any Doxia Sink. This is what allow us to parse the front- end format like APT, FML, and Xdoc for the Maven site plugin and have them all contribute to the final XHTML version of a site. All documents being parsed results in a stream of Doxia events (paragraph, bold, italic, text) which are then fed in the XHTML sink which results in a set of XHTML pages.
A sink is ultimately responsible for the final format and structure. So, for example, you can take a series of APT documents and have that be fed into a Sink which makes a single PDF, a book, a site, or a Word document. The Sink is fully responsible for the final output. Once you have Doxia events you can leverage any existing Sink. So if you wanted to integrate your custom XML format, or custom Wiki format, you would create a Doxia parser which could then be fed into any Sink to produce your desired final output.
Field Summary | |
---|---|
static int |
NUMBERING_DECIMAL
A numbering to handle a number list. |
static int |
NUMBERING_LOWER_ALPHA
A numbering to handle a lower alpha list. |
static int |
NUMBERING_LOWER_ROMAN
A numbering to handle a lower roman list. |
static int |
NUMBERING_UPPER_ALPHA
A numbering to handle a upper alpha list. |
static int |
NUMBERING_UPPER_ROMAN
A numbering to handle a upper roman list. |
static java.lang.String |
ROLE
The Plexus Sink Role |
static int |
SECTION_LEVEL_1
A level 1 section (section). |
static int |
SECTION_LEVEL_2
A level 2 section (subsection). |
static int |
SECTION_LEVEL_3
A level 3 section (sub-subsection). |
static int |
SECTION_LEVEL_4
A level 4 section (sub-sub-subsection). |
static int |
SECTION_LEVEL_5
A level 5 section (sub-sub-sub-subsection). |
Method Summary | |
---|---|
void |
anchor_()
Ending an anchor element. |
void |
anchor(java.lang.String name)
Starting an element which defines an anchor. |
void |
author_()
Ending the author element. |
void |
author()
Starting the author element which is used to identify the author of the document. |
void |
body_()
Ending the body element. |
void |
body()
Starting the body of a document which contains the document's content. |
void |
bold_()
Ending a bold element. |
void |
bold()
Starting a bold element. |
void |
close()
Close the writer or the stream, if needed. |
void |
date_()
Ending the date element. |
void |
date()
Starting the date element which is used to identify the date of the document. |
void |
definedTerm_()
Starting a definition term element within a definition list. |
void |
definedTerm()
Starting a definition term element within a definition list. |
void |
definition_()
Ending a definition element within a definition list. |
void |
definition()
Starting a definition element within a definition list. |
void |
definitionList_()
Ending a definition list element. |
void |
definitionList()
Starting a definition list element. |
void |
definitionListItem_()
Ending a list item element within a definition list. |
void |
definitionListItem()
Starting a list item element within a definition list. |
void |
figure_()
Ending a basic image embedding element. |
void |
figure()
Starting a basic image embedding element. |
void |
figureCaption_()
Ending a caption of an image. |
void |
figureCaption()
Starting a caption of an image element. |
void |
figureGraphics(java.lang.String name)
Adding a source of a graphic. |
void |
flush()
Flush the writer or the stream, if needed. |
void |
head_()
Ending the head element. |
void |
head()
Starting the head element which contains information about the current document, such as its title, that is not considered document content. |
void |
horizontalRule()
Adding a separator of sections from a text to each other. |
void |
italic_()
Ending an italic element. |
void |
italic()
Starting an italic element. |
void |
lineBreak()
Adding a line breaks. |
void |
link_()
Ending a link element. |
void |
link(java.lang.String name)
Starting an element which defines a link. |
void |
list_()
Ending an unordered list element. |
void |
list()
Starting an unordered list element. |
void |
listItem_()
Ending a list item element within an unordered list. |
void |
listItem()
Starting a list item element within an unordered list. |
void |
monospaced_()
Ending a monospaced element. |
void |
monospaced()
Starting a monospaced element. |
void |
nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations. |
void |
numberedList_()
Ending an ordered list element. |
void |
numberedList(int numbering)
Starting an ordered list element. |
void |
numberedListItem_()
Ending a list item element within an ordered list. |
void |
numberedListItem()
Starting a list item element within an ordered list. |
void |
pageBreak()
Adding a new page separator. |
void |
paragraph_()
Ending a paragraph element. |
void |
paragraph()
Starting an element which represents a paragraph. |
void |
rawText(java.lang.String text)
Adding a raw text, ie a text without any special formatting operations. |
void |
section1_()
Ending a first heading element. |
void |
section1()
Starting a first heading element which contains the topic of the section. |
void |
section2_()
Ending a second heading element. |
void |
section2()
Starting a second heading element which contains the topic of the section. |
void |
section3_()
Ending a third heading element. |
void |
section3()
Starting a third heading element which contains the topic of the section. |
void |
section4_()
Ending a 4th heading element. |
void |
section4()
Starting a 4th heading element which contains the topic of the section. |
void |
section5_()
Ending a 5th heading element. |
void |
section5()
Starting a 5th heading element which contains the topic of the section. |
void |
sectionTitle_()
Ending a title heading element. |
void |
sectionTitle()
Starting a title heading element. |
void |
sectionTitle1_()
Ending a first title heading element. |
void |
sectionTitle1()
Starting a first title heading element. |
void |
sectionTitle2_()
Ending a second title heading element. |
void |
sectionTitle2()
Starting a second title heading element. |
void |
sectionTitle3_()
Ending a third title heading element. |
void |
sectionTitle3()
Starting a third title heading element. |
void |
sectionTitle4_()
Ending a 4th title heading element. |
void |
sectionTitle4()
Starting a 4th title heading element. |
void |
sectionTitle5_()
Ending a 5th title heading element. |
void |
sectionTitle5()
Starting a 5th title heading element. |
void |
table_()
Ending a table element. |
void |
table()
Starting a table element for marking up tabular information in a document. |
void |
tableCaption_()
Ending a caption element of a table. |
void |
tableCaption()
Starting a caption element of a table. |
void |
tableCell_()
Ending a cell element. |
void |
tableCell()
Starting a cell element which defines a cell that contains data. |
void |
tableCell(java.lang.String width)
Starting a cell element which defines a cell that contains data. |
void |
tableHeaderCell_()
Ending a cell header element. |
void |
tableHeaderCell()
Starting a cell element which defines a cell that contains header information. |
void |
tableHeaderCell(java.lang.String width)
Starting a cell element which defines a cell that contains header information. |
void |
tableRow_()
Ending a row element. |
void |
tableRow()
Starting a row element which acts as a container for a row of table cells. |
void |
tableRows_()
Ending an element contains rows of table data. |
void |
tableRows(int[] justification,
boolean grid)
Starting an element contains rows of table data. |
void |
text(java.lang.String text)
Adding a text. |
void |
title_()
Ending the title element. |
void |
title()
Starting the title element which is used to identify the document. |
void |
verbatim_()
Ending a verbatim element. |
void |
verbatim(boolean boxed)
Starting an element which indicates that whitespace in the enclosed text has semantic relevance. |
Field Detail |
---|
static final java.lang.String ROLE
static final int NUMBERING_DECIMAL
numberedList(int)
,
Constant Field Valuesstatic final int NUMBERING_LOWER_ALPHA
numberedList(int)
,
Constant Field Valuesstatic final int NUMBERING_UPPER_ALPHA
numberedList(int)
,
Constant Field Valuesstatic final int NUMBERING_LOWER_ROMAN
numberedList(int)
,
Constant Field Valuesstatic final int NUMBERING_UPPER_ROMAN
numberedList(int)
,
Constant Field Valuesstatic final int SECTION_LEVEL_1
section1()
,
Constant Field Valuesstatic final int SECTION_LEVEL_2
section2()
,
Constant Field Valuesstatic final int SECTION_LEVEL_3
section3()
,
Constant Field Valuesstatic final int SECTION_LEVEL_4
section4()
,
Constant Field Valuesstatic final int SECTION_LEVEL_5
section5()
,
Constant Field ValuesMethod Detail |
---|
void head()
void head_()
void title()
void title_()
void author()
void author_()
void date()
void date_()
void body()
void body_()
void sectionTitle()
void sectionTitle_()
void section1()
void section1_()
void sectionTitle1()
void sectionTitle1_()
void section2()
void section2_()
void sectionTitle2()
void sectionTitle2_()
void section3()
void section3_()
void sectionTitle3()
void sectionTitle3_()
void section4()
void section4_()
void sectionTitle4()
void sectionTitle4_()
void section5()
void section5_()
void sectionTitle5()
void sectionTitle5_()
void list()
void list_()
void listItem()
void listItem_()
void numberedList(int numbering)
numbering
- the numbering wantedNUMBERING_DECIMAL
,
NUMBERING_LOWER_ALPHA
,
NUMBERING_LOWER_ROMAN
,
NUMBERING_UPPER_ALPHA
,
NUMBERING_UPPER_ROMAN
void numberedList_()
void numberedListItem()
void numberedListItem_()
void definitionList()
void definitionList_()
void definitionListItem()
void definitionListItem_()
void definition()
void definition_()
void definedTerm()
void definedTerm_()
void figure()
void figure_()
void figureCaption()
void figureCaption_()
void figureGraphics(java.lang.String name)
name
- the sourcevoid table()
void table_()
void tableRows(int[] justification, boolean grid)
justification
- the justification wantedgrid
- true to provide a grid, false otherwisevoid tableRows_()
void tableRow()
void tableRow_()
void tableCell()
void tableCell(java.lang.String width)
width
- the size of the cellvoid tableCell_()
void tableHeaderCell()
void tableHeaderCell(java.lang.String width)
width
- the size of the header cellvoid tableHeaderCell_()
void tableCaption()
void tableCaption_()
void paragraph()
void paragraph_()
void verbatim(boolean boxed)
boxed
- true to add a box, false otherwisevoid verbatim_()
void horizontalRule()
void pageBreak()
void anchor(java.lang.String name)
name
- the name of the anchorvoid anchor_()
void link(java.lang.String name)
name
- the name of the linkvoid link_()
void italic()
void italic_()
void bold()
void bold_()
void monospaced()
void monospaced_()
void lineBreak()
void nonBreakingSpace()
void text(java.lang.String text)
text
- The text to write.void rawText(java.lang.String text)
text
- The text to write.void flush()
void close()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |