org.codehaus.mojo.l10n
Class L10NStatusReport

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

public class L10NStatusReport
extends org.apache.maven.reporting.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  java.util.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(java.util.Map sourceDirs)
           
protected  java.util.Map constructResourceDirs()
          Collects resource definitions from all projects in reactor.
protected  void executeReport(java.util.Locale locale)
           
 java.lang.String getDescription(java.util.Locale locale)
           
 java.lang.String getName(java.util.Locale locale)
           
protected  java.lang.String getOutputDirectory()
           
 java.lang.String getOutputName()
           
protected  org.apache.maven.project.MavenProject getProject()
           
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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 java.util.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()
Specified by:
getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getSiteRenderer()

getOutputDirectory

protected java.lang.String getOutputDirectory()
Specified by:
getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getOutputDirectory()

getProject

protected org.apache.maven.project.MavenProject getProject()
Specified by:
getProject in class org.apache.maven.reporting.AbstractMavenReport
See Also:
AbstractMavenReport.getProject()

canGenerateReport

public boolean canGenerateReport()
Specified by:
canGenerateReport in interface org.apache.maven.reporting.MavenReport
Overrides:
canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport

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

constructResourceDirs

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

Returns:

executeReport

protected void executeReport(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException
Specified by:
executeReport in class org.apache.maven.reporting.AbstractMavenReport
Throws:
org.apache.maven.reporting.MavenReportException
See Also:
AbstractMavenReport.executeReport(java.util.Locale)

getDescription

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

getName

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

getOutputName

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


Copyright © 2007-2010. All Rights Reserved.