org.codehaus.mojo.l10n
Class L10NStatusReport

java.lang.Object
  extended byorg.apache.maven.plugin.AbstractMojo
      extended byorg.apache.maven.reporting.AbstractMavenReport
          extended byorg.codehaus.mojo.l10n.L10NStatusReport
All Implemented Interfaces:
ContextEnabled, MavenReport, Mojo

public class L10NStatusReport
extends AbstractMavenReport

A simple report for keeping track of l10n status. It lists all bundle properties files and the number of properties in them. For a configurable list of locales it also tracks the progress of localization.

Author:
Milos Kleint

Field Summary
protected  boolean aggregate
          Whether to build an aggregated report at the root, or build individual reports.
protected  List reactorProjects
          The projects in the reactor for aggregation report.
 
Fields inherited from interface org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
L10NStatusReport()
           
 
Method Summary
 boolean canGenerateReport()
           
protected  boolean canGenerateReport(Map sourceDirs)
           
protected  Map constructResourceDirs()
          Collects resource definitions from all projects in reactor.
protected  void executeReport(Locale locale)
           
 String getDescription(Locale locale)
           
 String getName(Locale locale)
           
protected  String getOutputDirectory()
           
 String getOutputName()
           
protected  MavenProject getProject()
           
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport, setReportOutputDirectory
 
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
 

Field Detail

reactorProjects

protected List reactorProjects
The projects in the reactor for aggregation report.


aggregate

protected boolean aggregate
Whether to build an aggregated report at the root, or build individual reports.

Constructor Detail

L10NStatusReport

public L10NStatusReport()
Method Detail

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
See Also:
AbstractMavenReport.getSiteRenderer()

getOutputDirectory

protected String getOutputDirectory()
See Also:
AbstractMavenReport.getOutputDirectory()

getProject

protected MavenProject getProject()
See Also:
AbstractMavenReport.getProject()

canGenerateReport

public boolean canGenerateReport()

canGenerateReport

protected boolean canGenerateReport(Map sourceDirs)
Parameters:
sourceDirs -
Returns:
true if the report can be generated

constructResourceDirs

protected Map constructResourceDirs()
Collects resource definitions from all projects in reactor.

Returns:

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException
Throws:
MavenReportException
See Also:
AbstractMavenReport.executeReport(java.util.Locale)

getDescription

public String getDescription(Locale locale)
See Also:
MavenReport.getDescription(java.util.Locale)

getName

public String getName(Locale locale)
See Also:
MavenReport.getName(java.util.Locale)

getOutputName

public String getOutputName()
See Also:
MavenReport.getOutputName()


Copyright © 2007-2009 Codehaus. All Rights Reserved.