org.jboss.maven.plugins.jdocbook
Class TranslationDiffReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo
          org.jboss.maven.plugins.jdocbook.TranslationDiffReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

public class TranslationDiffReport
extends AbstractDocBookMojo
implements org.apache.maven.reporting.MavenReport

A plugin for generating a "translation diff" report across different translations of the same document. This is useful for the translators to know what changes exist between their translation and the master.

Eventually, there is a possibility this will not be needed as we move forward if it is decided to move to the xliff format for translations.

Author:

Christian Bauer, Steve Ebersole

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

AbstractDocBookMojo.ArtifactProcessor

Field Summary

static java.lang.String

NAME

Fields inherited from class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

archiverManager, cssDirectory, fontConfig, fontsDirectory, formats, imagesDirectory, masterTranslationArtifactId, masterTranslationFile, options, PLUGIN_NAME, pluginArtifacts, project, projectArtifacts, projectHelper, siteRenderer, sourceDirectory, sourceDocumentName, stagingDirectory, targetDirectory

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

TranslationDiffReport()

Method Summary

boolean	canGenerateReport()
void	generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale)
java.lang.String	getCategoryName()
java.lang.String	getDescription(java.util.Locale locale)
java.lang.String	getName(java.util.Locale locale)
java.lang.String	getOutputName()
java.io.File	getReportOutputDirectory()
boolean	isExternalReport()
protected void	process(Formatting[] formattings) Copied nearly verbatim from AbstractMavenReport.execute() The override method to perform the actual processing of the mojo.
void	setReportOutputDirectory(java.io.File dir)

Methods inherited from class org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo

execute, processArtifacts, processPluginArtifacts, processProjectArtifacts

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

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

TranslationDiffReport

public TranslationDiffReport()

Method Detail

process

protected void process(Formatting[] formattings)
                throws RenderingException

Copied nearly verbatim from AbstractMavenReport.execute() The override method to perform the actual processing of the mojo.

Specified by:

process in class AbstractDocBookMojo

Parameters:

formattings - The fomattings configured for render

Throws:

RenderingException - Indicates problem performing rendering

getOutputName

public java.lang.String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

getName

public java.lang.String getName(java.util.Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

getCategoryName

public java.lang.String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(java.io.File dir)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public java.io.File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     java.util.Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException