Class DoxiaDocumentRenderer

  • All Implemented Interfaces:
    DocumentRenderer

    public class DoxiaDocumentRenderer
    extends java.lang.Object
    implements DocumentRenderer
    Renderer for a document that has a source file to be parsed by Doxia. Details about the source file are in RenderingContext, which is expected to have a non-null parserId and extension.
    • Constructor Detail

      • DoxiaDocumentRenderer

        public DoxiaDocumentRenderer​(RenderingContext renderingContext)
        Constructor.
        Parameters:
        renderingContext - the document's RenderingContext to use.
    • Method Detail

      • renderDocument

        public void renderDocument​(java.io.Writer writer,
                                   Renderer siteRenderer,
                                   SiteRenderingContext siteRenderingContext)
                            throws RendererException,
                                   java.io.FileNotFoundException,
                                   java.io.UnsupportedEncodingException
        Render a document in a site.
        Specified by:
        renderDocument in interface DocumentRenderer
        Parameters:
        writer - the Writer for the document output.
        siteRenderer - the site renderer to merge document content to.
        siteRenderingContext - the site rendering context.
        Throws:
        RendererException - if it bombs.
        java.io.FileNotFoundException - if it bombs.
        java.io.UnsupportedEncodingException - if it bombs.
      • getOutputName

        public java.lang.String getOutputName()
        The name of the output document.
        Specified by:
        getOutputName in interface DocumentRenderer
        Returns:
        the name of the output document.
      • isOverwrite

        public boolean isOverwrite()
        Whether to always overwrite the document, or only do so when it is changed.
        Specified by:
        isOverwrite in interface DocumentRenderer
        Returns:
        whether to overwrite
      • isExternalReport

        public boolean isExternalReport()
        Description copied from interface: DocumentRenderer
        Whether this document is an external report, independent from the site templating.
        Specified by:
        isExternalReport in interface DocumentRenderer
        Returns:
        true if report is external, otherwise false