org.apache.maven.plugins.site
Class AbstractSiteRenderingMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugins.site.AbstractSiteMojo
          extended by org.apache.maven.plugins.site.AbstractSiteRenderingMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
SiteMojo

public abstract class AbstractSiteRenderingMojo
extends AbstractSiteMojo

Base class for site rendering mojos.

Version:
$Id: AbstractSiteRenderingMojo.java 572806 2007-09-04 20:07:09Z dennisl $
Author:
Brett Porter

Field Summary
protected  org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
          The component used for creating artifact instances.
protected  org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver
          The component that is used to resolve additional artifacts required.
protected  org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler assembler
          The component for assembling inheritance.
protected  java.util.Map attributes
          The template properties for rendering the site.
protected  java.io.File generatedSiteDirectory
          Directory containing generated documentation.
protected  java.util.Map moduleExcludes
          Module type exclusion mappings ex: fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively)

The configuration looks like this:

protected  java.util.List reports
           
protected  java.util.List repositories
          Remote repositories used for the project.
protected  org.apache.maven.doxia.siterenderer.Renderer siteRenderer
          Site renderer.
 
Fields inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
i18n, inputEncoding, localRepository, mavenProjectBuilder, outputEncoding, project, reactorProjects, siteDirectory
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractSiteRenderingMojo()
           
 
Method Summary
protected  java.util.Map categoriseReports(java.util.Collection reports)
           
protected  org.apache.maven.doxia.siterenderer.SiteRenderingContext createSiteRenderingContext(java.util.Locale locale)
           
protected  java.util.List filterReports(java.util.List reports)
           
protected  org.apache.maven.doxia.site.decoration.DecorationModel getDecorationModel(org.apache.maven.project.MavenProject project, java.util.Locale locale, java.util.Map origProps)
           
protected  java.util.Map locateDocuments(org.apache.maven.doxia.siterenderer.SiteRenderingContext context, java.util.List reports, java.util.Locale locale)
           
protected  java.util.Map locateReports(java.util.List reports, java.util.Map documents, java.util.Locale locale)
           
 
Methods inherited from class org.apache.maven.plugins.site.AbstractSiteMojo
getAvailableLocales, getInterpolatedSiteDescriptorContent, getParentProject, getRelativePath, getSiteDescriptorFile, populateModules, populateProjectParentMenu, populateReportItems, populateReportsMenu
 
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.maven.plugin.Mojo
execute
 

Field Detail

moduleExcludes

protected java.util.Map moduleExcludes
Module type exclusion mappings ex: fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively)

The configuration looks like this:

   <moduleExcludes>
     <moduleType>filename1.ext,**/*sample.ext</moduleType>
     <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
     <!-- The value is a comma separated list of           -->
     <!-- filenames or fileset patterns.                   -->
     <!-- Here's an example:                               -->
     <xdoc>changes.xml,navigation.xml</xdoc>
   </moduleExcludes>
 


assembler

protected org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler assembler
The component for assembling inheritance.


artifactResolver

protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver
The component that is used to resolve additional artifacts required.


repositories

protected java.util.List repositories
Remote repositories used for the project.


artifactFactory

protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
The component used for creating artifact instances.


attributes

protected java.util.Map attributes
The template properties for rendering the site.


siteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
Site renderer.


reports

protected java.util.List reports

generatedSiteDirectory

protected java.io.File generatedSiteDirectory
Directory containing generated documentation.

Constructor Detail

AbstractSiteRenderingMojo

public AbstractSiteRenderingMojo()
Method Detail

getDecorationModel

protected org.apache.maven.doxia.site.decoration.DecorationModel getDecorationModel(org.apache.maven.project.MavenProject project,
                                                                                    java.util.Locale locale,
                                                                                    java.util.Map origProps)
                                                                             throws org.apache.maven.plugin.MojoExecutionException
Throws:
org.apache.maven.plugin.MojoExecutionException

filterReports

protected java.util.List filterReports(java.util.List reports)

createSiteRenderingContext

protected org.apache.maven.doxia.siterenderer.SiteRenderingContext createSiteRenderingContext(java.util.Locale locale)
                                                                                       throws org.apache.maven.plugin.MojoExecutionException,
                                                                                              java.io.IOException,
                                                                                              org.apache.maven.plugin.MojoFailureException
Throws:
org.apache.maven.plugin.MojoExecutionException
java.io.IOException
org.apache.maven.plugin.MojoFailureException

locateReports

protected java.util.Map locateReports(java.util.List reports,
                                      java.util.Map documents,
                                      java.util.Locale locale)

categoriseReports

protected java.util.Map categoriseReports(java.util.Collection reports)

locateDocuments

protected java.util.Map locateDocuments(org.apache.maven.doxia.siterenderer.SiteRenderingContext context,
                                        java.util.List reports,
                                        java.util.Locale locale)
                                 throws java.io.IOException,
                                        org.apache.maven.doxia.siterenderer.RendererException
Throws:
java.io.IOException
org.apache.maven.doxia.siterenderer.RendererException


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.