org.apache.maven.doxia.module.docbook
Class DocBookParser

java.lang.Object
  org.apache.maven.doxia.parser.AbstractParser
      org.apache.maven.doxia.parser.AbstractXmlParser
          org.apache.maven.doxia.module.docbook.DocBookParser

All Implemented Interfaces:

LogEnabled, Markup, XmlMarkup, DocbookMarkup, SimplifiedDocbookMarkup, Parser

public class DocBookParser
extends AbstractXmlParser
implements DocbookMarkup, SimplifiedDocbookMarkup

Parse a Simplified DocBook document and emit events into the specified doxia Sink.

Since:

1.0

Version:

$Id: DocBookParser.java 1090706 2011-04-09 23:15:28Z hboutemy $

Author:

Jason van Zyl

Plexus component:

role:

"org.apache.maven.doxia.parser.Parser"

role-hint:

"docbook"

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.maven.doxia.parser.AbstractXmlParser

AbstractXmlParser.CachedFileEntityResolver

Field Summary

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, DEFAULT_SGML_PUBLIC_ID, DEFAULT_SGML_SYSTEM_ID, DEFAULT_XML_PUBLIC_ID, DEFAULT_XML_SYSTEM_ID, 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.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.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, DEFAULT_XML_PUBLIC_ID, DEFAULT_XML_SYSTEM_ID, 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.parser.Parser

ROLE, TXT_TYPE, UNKNOWN_TYPE, XML_TYPE

Constructor Summary

DocBookParser()

Method Summary

protected void	handleCdsect(XmlPullParser parser, Sink sink)
protected void	handleComment(XmlPullParser parser, Sink sink)
protected void	handleEndTag(XmlPullParser parser, Sink sink)
protected void	handleEntity(XmlPullParser parser, Sink sink)
protected void	handleStartTag(XmlPullParser parser, Sink sink)
protected void	handleText(XmlPullParser parser, Sink sink)
protected void	init()

Methods inherited from class org.apache.maven.doxia.parser.AbstractXmlParser

getAttributesFromParser, getLocalEntities, getText, getType, handleUnknown, isCollapsibleWhitespace, isIgnorableWhitespace, isTrimmableWhitespace, isValidate, parse, parse, setCollapsibleWhitespace, setIgnorableWhitespace, setTrimmableWhitespace, setValidate

Methods inherited from class org.apache.maven.doxia.parser.AbstractParser

doxiaVersion, enableLogging, executeMacro, getBasedir, getLog, getMacroManager, isSecondParsing, setSecondParsing

Methods inherited from class java.lang.Object

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

Constructor Detail

DocBookParser

public DocBookParser()

Method Detail

init

protected void init()

Overrides:

init in class AbstractParser

handleStartTag

protected void handleStartTag(XmlPullParser parser,
                              Sink sink)
                       throws XmlPullParserException,
                              MacroExecutionException

Specified by:

handleStartTag in class AbstractXmlParser

Throws:

XmlPullParserException

MacroExecutionException

handleEndTag

protected void handleEndTag(XmlPullParser parser,
                            Sink sink)
                     throws XmlPullParserException,
                            MacroExecutionException

Specified by:

handleEndTag in class AbstractXmlParser

Throws:

XmlPullParserException

MacroExecutionException

handleComment

protected void handleComment(XmlPullParser parser,
                             Sink sink)
                      throws XmlPullParserException

Overrides:

handleComment in class AbstractXmlParser

Throws:

XmlPullParserException

handleCdsect

protected void handleCdsect(XmlPullParser parser,
                            Sink sink)
                     throws XmlPullParserException

Overrides:

handleCdsect in class AbstractXmlParser

Throws:

XmlPullParserException

handleEntity

protected void handleEntity(XmlPullParser parser,
                            Sink sink)
                     throws XmlPullParserException

Overrides:

handleEntity in class AbstractXmlParser

Throws:

XmlPullParserException

handleText

protected void handleText(XmlPullParser parser,
                          Sink sink)
                   throws XmlPullParserException

Overrides:

handleText in class AbstractXmlParser

Throws:

XmlPullParserException