Field Detail

• siteRenderer

  @Component
  protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer

  Site renderer.

• reports

  @Parameter(defaultValue="${reports}",
             required=true,
             readonly=true)
  protected List<MavenReport> reports

  Reports (Maven 2).

• generatedSiteDirectory

  @Parameter(alias="workingDirectory",
             defaultValue="${project.build.directory}/generated-site")
  protected File generatedSiteDirectory

  Directory containing generated documentation in source format (Doxia supported markup). This is used to pick up other source docs that might have been generated at build time (by reports or any other build time mean). This directory is expected to have the same structure as siteDirectory (ie. one directory per Doxia-source-supported markup types).

• mavenSession

  @Parameter(defaultValue="${session}",
             readonly=true,
             required=true)
  protected MavenSession mavenSession

  The current Maven session.

Constructor Detail

• AbstractSiteRenderingMojo

  public AbstractSiteRenderingMojo()

Method Detail

• getInputEncoding

  protected String getInputEncoding()

  Gets the input files encoding.

  Returns:

  The input files encoding, never null.

• getOutputEncoding

  protected String getOutputEncoding()

  Gets the effective reporting output files encoding.

  Returns:

  The effective reporting output file encoding, never null.

• contextualize

  public void contextualize(org.codehaus.plexus.context.Context context)
                     throws org.codehaus.plexus.context.ContextException

  Specified by:

  contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

  Throws:

  org.codehaus.plexus.context.ContextException

• checkInputEncoding

  protected void checkInputEncoding()

• getReports

  protected List<org.apache.maven.reporting.exec.MavenReportExecution> getReports()
                                                                           throws MojoExecutionException

  Throws:

  MojoExecutionException

• createSiteRenderingContext

  protected org.apache.maven.doxia.siterenderer.SiteRenderingContext createSiteRenderingContext(Locale locale)
                                                                                         throws MojoExecutionException,
                                                                                                IOException,
                                                                                                MojoFailureException

  Throws:

  MojoExecutionException

  IOException

  MojoFailureException

• locateReports

  protected Map<String,MavenReport> locateReports(List<org.apache.maven.reporting.exec.MavenReportExecution> reports,
                                      Map<String,org.apache.maven.doxia.siterenderer.DocumentRenderer> documents,
                                      Locale locale)

  Go through the list of reports and process each one like this:

  • Add the report to a map of reports keyed by filename having the report itself as value
  • If the report is not yet in the map of documents, add it together with a suitable renderer

  Parameters:

  reports - A List of MavenReports

  documents - A Map of documents, keyed by filename

  locale - the Locale the reports are processed for.

  Returns:

  A map with all reports keyed by filename having the report itself as value. The map will be used to populate a menu.

• categoriseReports

  protected Map<String,List<MavenReport>> categoriseReports(Collection<MavenReport> reports)

  Go through the collection of reports and put each report into a list for the appropriate category. The list is put into a map keyed by the name of the category.

  Parameters:

  reports - A Collection of MavenReports

  Returns:

  A map keyed category having the report itself as value

• locateDocuments

  protected Map<String,org.apache.maven.doxia.siterenderer.DocumentRenderer> locateDocuments(org.apache.maven.doxia.siterenderer.SiteRenderingContext context,
                                                                                 List<org.apache.maven.reporting.exec.MavenReportExecution> reports,
                                                                                 Locale locale)
                                                                                      throws IOException,
                                                                                             org.apache.maven.doxia.siterenderer.RendererException

  Locate every document to be rendered for given locale:

  • handwritten content, ie Doxia files,
  • reports,
  • "Project Information" and "Project Reports" category summaries.

  Throws:

  IOException

  org.apache.maven.doxia.siterenderer.RendererException

  See Also:

  CategorySummaryDocumentRenderer

• populateReportItems

  protected void populateReportItems(org.apache.maven.doxia.site.decoration.DecorationModel decorationModel,
                         Locale locale,
                         Map<String,MavenReport> reportsByOutputName)