top.marchand.xml.maven.plugin.xsl

Class AbstractCompiler

java.lang.Object

org.apache.maven.plugin.AbstractMojo

top.marchand.xml.maven.plugin.xsl.AbstractCompiler

All Implemented Interfaces:

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

Direct Known Subclasses:

XslCompilerMojo

public abstract class AbstractCompiler
extends org.apache.maven.plugin.AbstractMojo

Ancestor class with all required code to compile a XSL

Author:

Christophe Marchand

Field Summary

Fields

Modifier and Type	Field and Description
protected net.sf.saxon.s9api.DocumentBuilder	builder
protected net.sf.saxon.s9api.XsltCompiler	compiler

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractCompiler()

Method Summary

Modifier and Type	Method and Description
protected void	compileFile(Source source, File targetFile) Compiles a sourceFile to a targetFile.
protected void	compileModule(net.sf.saxon.s9api.XdmNode document, File targetFile) Compiles a standard XSL module.
protected void	compilePackage(net.sf.saxon.s9api.XdmNode document, File targetFile) Compiles a package, and adds to to the compiler.
protected net.sf.saxon.s9api.DocumentBuilder	getBuilder() Because we may need a DocumentBuilder elsewhere !
abstract File	getCatalogFile() The catalog file to use.
protected EntityResolver2	getEntityResolver() Returns the EntityResolver to use
protected net.sf.saxon.s9api.Processor	getProcessor() Returns the Processor the plugin uses.
abstract top.marchand.maven.saxon.utils.SaxonOptions	getSaxonOptions() Returns the SaxonOptions associated to this plugin
protected URIResolver	getUriResolver() Because we may need a URIResolver elsewhere
protected net.sf.saxon.s9api.XsltCompiler	getXsltCompiler() Because we may need a compiler elsewhere
protected void	initSaxon() Initialize Saxon configuration

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

builder

protected net.sf.saxon.s9api.DocumentBuilder builder

compiler

protected net.sf.saxon.s9api.XsltCompiler compiler

Constructor Detail

AbstractCompiler

public AbstractCompiler()

Method Detail

getCatalogFile

public abstract File getCatalogFile()

The catalog file to use. It may retruns null.

Returns:

The catalog file to use.

compileFile

protected void compileFile(Source source,
                           File targetFile)
                    throws net.sf.saxon.s9api.SaxonApiException,
                           FileNotFoundException

Compiles a sourceFile to a targetFile. If the file is a <package>, compilePackage(net.sf.saxon.s9api.XdmNode, java.io.File) is called, else compileModule(net.sf.saxon.s9api.XdmNode, java.io.File) is called.

Parameters:

source - The source file to compile

targetFile - The target file to generate

Throws:

net.sf.saxon.s9api.SaxonApiException - In case of failure

FileNotFoundException - In case of failure

compileModule

protected void compileModule(net.sf.saxon.s9api.XdmNode document,
                             File targetFile)
                      throws net.sf.saxon.s9api.SaxonApiException,
                             FileNotFoundException

Compiles a standard XSL module.

Parameters:

document - The source document

targetFile - The file to generate

Throws:

net.sf.saxon.s9api.SaxonApiException - In case of failure

FileNotFoundException - In case of failure

compilePackage

protected void compilePackage(net.sf.saxon.s9api.XdmNode document,
                              File targetFile)
                       throws net.sf.saxon.s9api.SaxonApiException

Compiles a package, and adds to to the compiler.

Parameters:

document - The source document

targetFile - The file to generate

Throws:

net.sf.saxon.s9api.SaxonApiException - In case of failure

initSaxon

protected void initSaxon()
                  throws net.sf.saxon.trans.XPathException

Initialize Saxon configuration

Throws:

net.sf.saxon.trans.XPathException - In case of problem

getProcessor

protected net.sf.saxon.s9api.Processor getProcessor()

Returns the Processor the plugin uses.

Returns:

The processor used

getXsltCompiler

protected net.sf.saxon.s9api.XsltCompiler getXsltCompiler()

Because we may need a compiler elsewhere

Returns:

The XSL compiler used

getUriResolver

protected URIResolver getUriResolver()

Because we may need a URIResolver elsewhere

Returns:

The URI resolver used

getEntityResolver

protected EntityResolver2 getEntityResolver()

Returns the EntityResolver to use

Returns:

The EntityResolver

getBuilder

protected net.sf.saxon.s9api.DocumentBuilder getBuilder()

Because we may need a DocumentBuilder elsewhere !

Returns:

The document builder

getSaxonOptions

public abstract top.marchand.maven.saxon.utils.SaxonOptions getSaxonOptions()

Returns the SaxonOptions associated to this plugin

Returns:

Saxon optiones