Constructor Detail

• DefaultSiteRenderer

  public DefaultSiteRenderer()

Method Detail

• locateDocumentFiles

  public Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext)
                                                   throws IOException,
                                                          RendererException

  Locate Doxia document source files in the site source context.

  Specified by:

  locateDocumentFiles in interface Renderer

  Returns:

  the Doxia document renderers in a Map keyed by output file name.

  Throws:

  IOException - if it bombs.

  RendererException - if it bombs.

• locateDocumentFiles

  public Map<String,DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext,
                                                 boolean editable)
                                                   throws IOException,
                                                          RendererException

  Locate Doxia document source files in the site source context.

  Specified by:

  locateDocumentFiles in interface Renderer

  Returns:

  the Doxia document renderers in a Map keyed by output file name.

  Throws:

  IOException - if it bombs.

  RendererException - if it bombs.

• render

  public void render(Collection<DocumentRenderer> documents,
            SiteRenderingContext siteRenderingContext,
            File outputDirectory)
              throws RendererException,
                     IOException

  Render a collection of documents into a site.

  Specified by:

  render in interface Renderer

  Parameters:

  documents - the documents to render.

  siteRenderingContext - the SiteRenderingContext to use.

  outputDirectory - the output directory to write results.

  Throws:

  RendererException - if it bombs.

  IOException - if it bombs.

• renderDocument

  public void renderDocument(Writer writer,
                    RenderingContext docRenderingContext,
                    SiteRenderingContext siteContext)
                      throws RendererException,
                             FileNotFoundException,
                             UnsupportedEncodingException

  Render a document written in a Doxia markup language. This method is an internal method, used by DoxiaDocumentRenderer.

  Specified by:

  renderDocument in interface Renderer

  Parameters:

  writer - the writer to render the document to.

  docRenderingContext - the document's rendering context, which is expected to have a non-null parser id.

  siteContext - the site's rendering context

  Throws:

  RendererException - if it bombs.

  FileNotFoundException - if it bombs.

  UnsupportedEncodingException - if it bombs.

• createToolManagedVelocityContext

  protected Context createToolManagedVelocityContext(SiteRenderingContext siteRenderingContext)

  Creates a Velocity Context with all generic tools configured wit the site rendering context.

  Parameters:

  siteRenderingContext - the site rendering context

  Returns:

  a Velocity tools managed context

• createDocumentVelocityContext

  protected Context createDocumentVelocityContext(RenderingContext renderingContext,
                                      SiteRenderingContext siteRenderingContext)

  Create a Velocity Context for a Doxia document, containing every information about rendered document.

  Parameters:

  sink - the site renderer sink for the document

  siteRenderingContext - the site rendering context

  Returns:

• createSiteTemplateVelocityContext

  protected Context createSiteTemplateVelocityContext(DocumentContent content,
                                          SiteRenderingContext siteRenderingContext)

  Create a Velocity Context for the site template decorating the document. In addition to all the informations from the document, this context contains data gathered in SiteRendererSink during document rendering.

  Parameters:

  content - the document content to be merged into the template

  siteRenderingContext - the site rendering context

  Returns:

• generateDocument

  public void generateDocument(Writer writer,
                      SiteRendererSink sink,
                      SiteRenderingContext siteRenderingContext)
                        throws RendererException

  Generate a document output from a Doxia SiteRenderer Sink, i.e. merge the document content into the site template.

  Specified by:

  generateDocument in interface Renderer

  Parameters:

  writer - the Writer to use.

  sink - the Site Renderer Sink that received the Doxia events during document content rendering.

  siteRenderingContext - the SiteRenderingContext to use.

  Throws:

  RendererException - if it bombs.

• mergeDocumentIntoSite

  public void mergeDocumentIntoSite(Writer writer,
                           DocumentContent content,
                           SiteRenderingContext siteRenderingContext)
                             throws RendererException

  Generate a document output integrated in a site from a document content, i.e. merge the document content into the site template.

  Specified by:

  mergeDocumentIntoSite in interface Renderer

  Parameters:

  writer - the Writer to use.

  content - the document content to be merged

  siteRenderingContext - the SiteRenderingContext to use.

  Throws:

  RendererException - if it bombs.

• createContextForSkin

  public SiteRenderingContext createContextForSkin(Artifact skin,
                                          Map<String,?> attributes,
                                          DecorationModel decoration,
                                          String defaultWindowTitle,
                                          Locale locale)
                                            throws IOException,
                                                   RendererException

  Create a Site Rendering Context for a site using a skin.

  Specified by:

  createContextForSkin in interface Renderer

  Returns:

  a SiteRenderingContext.

  Throws:

  IOException - if it bombs.

  RendererException

• createContextForTemplate

  @Deprecated
  public SiteRenderingContext createContextForTemplate(File templateFile,
                                                         Map<String,?> attributes,
                                                         DecorationModel decoration,
                                                         String defaultWindowTitle,
                                                         Locale locale)
                                                throws MalformedURLException

  Deprecated. 
  Create a Site Rendering Context for a site using a local template.

  Specified by:

  createContextForTemplate in interface Renderer

  Returns:

  a SiteRenderingContext.

  Throws:

  MalformedURLException - if it bombs.

  See Also:

  #createContextForSkin(File, Map, DecorationModel, String, Locale)

• copyResources

  public void copyResources(SiteRenderingContext siteRenderingContext,
                   File resourcesDirectory,
                   File outputDirectory)
                     throws IOException

  Copy resource files.

  Specified by:

  copyResources in interface Renderer

  Throws:

  IOException - if it bombs.

• copyResources

  public void copyResources(SiteRenderingContext siteRenderingContext,
                   File outputDirectory)
                     throws IOException

  Copy resource files from skin, template, and site resources.

  Specified by:

  copyResources in interface Renderer

  Throws:

  IOException - if it bombs.

• copyDirectory

  protected void copyDirectory(File source,
                   File destination)
                        throws IOException

  Copy the directory

  Parameters:

  source - source file to be copied

  destination - destination file

  Throws:

  IOException - if any