com.agilejava.docbkx.maven

Class DocbkxTemplateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.agilejava.docbkx.maven.AbstractTransformerMojo

com.agilejava.docbkx.maven.DocbkxTemplateMojo

All Implemented Interfaces:

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

public class DocbkxTemplateMojo
extends AbstractTransformerMojo

A Maven plugin for generating template output from DocBook documents, using version 1.78.1 of the DocBook XSL stylesheets.

See Also:

http://docbook.sourceforge.net/

Field Summary

Fields

Modifier and Type	Field and Description
protected String	ns (Original XSL attribut: ns.)

Fields inherited from class com.agilejava.docbkx.maven.AbstractTransformerMojo

catalogs

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
DocbkxTemplateMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure(Transformer transformer) Configure the Transformer by passing in some parameters.
List	getArtifacts() Returns the plugin dependencies.
List	getCustomizationParameters() A list of additional XSL parameters to give to the XSLT engine.
String	getDefaultStylesheetLocation() Returns the default stylesheet location within the root of the stylesheet distribution.
List	getEntities() Returns a list of Entities
File	getGeneratedSourceDirectory() Returns the directory to use to save the resolved docbook XML before it is given to the Transformer.
String[]	getIncludes() Returns the include patterns, as a comma-seperate collection of patterns.
org.apache.maven.project.MavenProject	getMavenProject() Returns a reference to the current project.
org.apache.tools.ant.Target	getPostProcess() Returns the tasks that should be executed after the transformation.
org.apache.tools.ant.Target	getPreProcess() Returns the tasks that should be executed before the transformation.
File	getSourceDirectory() Returns the source directory containing the source XML files.
String	getStylesheetLocation() Returns the actual stylesheet location.
Properties	getSystemProperties() Returns the additional System Properties.
File	getTargetDirectory() Returns the target directory in which all results should be placed.
String	getTargetFileExtension() Returns the extension of the target files, e.g.
String	getType() Returns the type of conversion.
protected boolean	getXIncludeSupported() Returns a boolean indicating if XInclude should be supported.
protected boolean	isShowXslMessages() Returns true if the xslt engine have to print xsl:messages to standard output.
protected boolean	isSkip()
protected boolean	isUseStandardOutput() Returns false if the stylesheet is responsible to create the output file(s) using its own naming scheme.
protected void	setShowXslMessages(boolean showXslMessages)
protected void	setSkip(boolean skip)
void	setTargetFileExtension(String extension) Sets the file extension, this can be usefull to override this value especially for multiple transformations plugins (like XML to FO to PDF).
protected void	setUseStandardOutput(boolean useStandardOutput)

Methods inherited from class com.agilejava.docbkx.maven.AbstractTransformerMojo

adjustTransformer, configureXref, convertBooleanToXsltParam, convertStringToXsltParam, createCatalogManager, createDocumentBuilder, createSource, createTitleXPath, createTransformerBuilder, dumpResolvedXML, execute, executeTasks, getDefaultStylesheetURL, getNonDefaultStylesheetLocation, getNonDefaultStylesheetURL, getProperty, getStylesheetURL, postProcess, postProcessResult, preProcess, setProperty, shouldProcessResult

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

ns

protected String ns

(Original XSL attribut: ns.)

Constructor Detail

DocbkxTemplateMojo

public DocbkxTemplateMojo()

Method Detail

configure

protected void configure(Transformer transformer)

Description copied from class: AbstractTransformerMojo

Configure the Transformer by passing in some parameters.

Specified by:

configure in class AbstractTransformerMojo

Parameters:

transformer - The Transformer that needs to be configured.

getSourceDirectory

public File getSourceDirectory()

Description copied from class: AbstractTransformerMojo

Returns the source directory containing the source XML files.

Specified by:

getSourceDirectory in class AbstractTransformerMojo

Returns:

The source directory containing the source XML files.

getTargetDirectory

public File getTargetDirectory()

Description copied from class: AbstractTransformerMojo

Returns the target directory in which all results should be placed.

Specified by:

getTargetDirectory in class AbstractTransformerMojo

Returns:

The target directory in which all results should be placed.

getGeneratedSourceDirectory

public File getGeneratedSourceDirectory()

Description copied from class: AbstractTransformerMojo

Returns the directory to use to save the resolved docbook XML before it is given to the Transformer.

Specified by:

getGeneratedSourceDirectory in class AbstractTransformerMojo

Returns:

getDefaultStylesheetLocation

public String getDefaultStylesheetLocation()

Description copied from class: AbstractTransformerMojo

Returns the default stylesheet location within the root of the stylesheet distribution.

Specified by:

getDefaultStylesheetLocation in class AbstractTransformerMojo

Returns:

The location of the directory containing the stylesheets.

getType

public String getType()

Description copied from class: AbstractTransformerMojo

Returns the type of conversion.

Specified by:

getType in class AbstractTransformerMojo

getStylesheetLocation

public String getStylesheetLocation()

Description copied from class: AbstractTransformerMojo

Returns the actual stylesheet location.

Specified by:

getStylesheetLocation in class AbstractTransformerMojo

Returns:

The actual stylesheet location.

getTargetFileExtension

public String getTargetFileExtension()

Description copied from class: AbstractTransformerMojo

Returns the extension of the target files, e.g. "html" for HTML files, etc.

Specified by:

getTargetFileExtension in class AbstractTransformerMojo

Returns:

The extension of the target files.

setTargetFileExtension

public void setTargetFileExtension(String extension)

Description copied from class: AbstractTransformerMojo

Sets the file extension, this can be usefull to override this value especially for multiple transformations plugins (like XML to FO to PDF).

Specified by:

setTargetFileExtension in class AbstractTransformerMojo

Parameters:

extension - The file extension to set

getIncludes

public String[] getIncludes()

Description copied from class: AbstractTransformerMojo

Returns the include patterns, as a comma-seperate collection of patterns.

Specified by:

getIncludes in class AbstractTransformerMojo

getEntities

public List getEntities()

Description copied from class: AbstractTransformerMojo

Returns a list of Entities

Specified by:

getEntities in class AbstractTransformerMojo

getCustomizationParameters

public List getCustomizationParameters()

Description copied from class: AbstractTransformerMojo

A list of additional XSL parameters to give to the XSLT engine. These parameters overrides regular docbook ones as they are last configured.
For regular docbook parameters prefer the use of this plugin facilities offering named paramters.
These parameters feet well for custom properties you may have defined within your customization layer.

customizationParameters

Specified by:

getCustomizationParameters in class AbstractTransformerMojo

getSystemProperties

public Properties getSystemProperties()

Description copied from class: AbstractTransformerMojo

Returns the additional System Properties. JVM System Properties are copied back if no problem have occurred during the plugin process.

Specified by:

getSystemProperties in class AbstractTransformerMojo

Returns:

The current forked System Properties.

getPreProcess

public org.apache.tools.ant.Target getPreProcess()

Description copied from class: AbstractTransformerMojo

Returns the tasks that should be executed before the transformation.

Specified by:

getPreProcess in class AbstractTransformerMojo

Returns:

The tasks that should be executed before the transformation.

getPostProcess

public org.apache.tools.ant.Target getPostProcess()

Description copied from class: AbstractTransformerMojo

Returns the tasks that should be executed after the transformation.

Specified by:

getPostProcess in class AbstractTransformerMojo

Returns:

The tasks that should be executed after the transformation.

getMavenProject

public org.apache.maven.project.MavenProject getMavenProject()

Description copied from class: AbstractTransformerMojo

Returns a reference to the current project.

Specified by:

getMavenProject in class AbstractTransformerMojo

Returns:

A reference to the current project.

getArtifacts

public List getArtifacts()

Description copied from class: AbstractTransformerMojo

Returns the plugin dependencies.

Specified by:

getArtifacts in class AbstractTransformerMojo

Returns:

The plugin dependencies.

getXIncludeSupported

protected boolean getXIncludeSupported()

Description copied from class: AbstractTransformerMojo

Returns a boolean indicating if XInclude should be supported.

Specified by:

getXIncludeSupported in class AbstractTransformerMojo

Returns:

A boolean indicating if XInclude should be supported.

isUseStandardOutput

protected boolean isUseStandardOutput()

Returns false if the stylesheet is responsible to create the output file(s) using its own naming scheme.

Specified by:

isUseStandardOutput in class AbstractTransformerMojo

Returns:

If using the standard output.

isShowXslMessages

protected boolean isShowXslMessages()

Description copied from class: AbstractTransformerMojo

Returns true if the xslt engine have to print xsl:messages to standard output.

Specified by:

isShowXslMessages in class AbstractTransformerMojo

Returns:

If the xslt engine have to print messages.

setShowXslMessages

protected void setShowXslMessages(boolean showXslMessages)

Specified by:

setShowXslMessages in class AbstractTransformerMojo

setUseStandardOutput

protected void setUseStandardOutput(boolean useStandardOutput)

Specified by:

setUseStandardOutput in class AbstractTransformerMojo

setSkip

protected void setSkip(boolean skip)

isSkip

protected boolean isSkip()

Specified by:

isSkip in class AbstractTransformerMojo

Returns:

true if execution should be skipped