org.expath.pkg.saxon

Class SaxonRepository

java.lang.Object

org.expath.pkg.saxon.SaxonRepository

public class SaxonRepository
extends java.lang.Object

Wrap an EXPath repository with Saxon-specific services. This handle for instance the extension functions written specifically for Saxon in Java. TODO: Document the "override" mechanism.

Author:

Florent Georges

Constructor Summary

Constructors

Constructor and Description
SaxonRepository(Repository parent)
SaxonRepository(Storage storage)

Method Summary

Modifier and Type	Method and Description
net.sf.saxon.lib.ModuleURIResolver	getModuleURIResolver()
Repository	getUnderlyingRepo()
javax.xml.transform.URIResolver	getURIResolver(URISpace space)
Package	installPackage(java.io.File pkg, boolean force, UserInteractionStrategy interact) Install a package from a file.
Package	installPackage(java.net.URI pkg, boolean force, UserInteractionStrategy interact) Install a package from a URI location.
void	registerExtensionFunctions(net.sf.saxon.Configuration config) TODO: Regarding versionning, see comments of Repository.resolve(String,URISpace) (AKA we don't always want the latest version).
boolean	removePackage(java.lang.String pkg, boolean force, UserInteractionStrategy interact) Remove a package from the repository, by name.
javax.xml.transform.Source	resolve(java.lang.String href, URISpace space) Resolve a Saxon-specific stuff in this repository, in the specified space, return a File.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SaxonRepository

public SaxonRepository(Storage storage)
                throws PackageException

Throws:

PackageException

SaxonRepository

public SaxonRepository(Repository parent)
                throws PackageException

Throws:

PackageException

Method Detail

getUnderlyingRepo

public Repository getUnderlyingRepo()

installPackage

public Package installPackage(java.io.File pkg,
                              boolean force,
                              UserInteractionStrategy interact)
                       throws PackageException

Install a package from a file.

Parameters:

pkg - The package file (typically a *.xar or *.xaw file).

force - If false, an error is thrown if the package already exists. If true, the package is first deleted from the repository if it already exists.

interact - How the repository interacts with the user.

Returns:

The freshly installed package.

Throws:

PackageException - If any error occurs.

installPackage

public Package installPackage(java.net.URI pkg,
                              boolean force,
                              UserInteractionStrategy interact)
                       throws PackageException

Install a package from a URI location.

Parameters:

pkg - The package file (typically a *.xar or *.xaw file).

force - If false, an error is thrown if the package already exists. If true, the package is first deleted from the repository if it already exists.

interact - How the repository interacts with the user.

Returns:

The freshly installed package.

Throws:

PackageException - If any error occurs.

removePackage

public boolean removePackage(java.lang.String pkg,
                             boolean force,
                             UserInteractionStrategy interact)
                      throws PackageException

Remove a package from the repository, by name. If a package with that name does not exist, or if there are several versions installed, this is an error (except if the package does not exist and force is true, then simply returns false).

Parameters:

pkg - The package name.

force - To silently ignore a non existing package (simply returns false in that case).

interact - How the repository interacts with the user.

Returns:

True if the package has been successfully removed, false if not (false is returned when the user canceled removing interactively, or if the package does not exist and force is true).

Throws:

PackageException - If any error occurs during removal.

resolve

public javax.xml.transform.Source resolve(java.lang.String href,
                                          URISpace space)
                                   throws PackageException

Resolve a Saxon-specific stuff in this repository, in the specified space, return a File. TODO: FIXME: To handle empty wrappers, just forget about the generated files and so on. Just return a StreamSource over a StringReader over a generated string with the empty stylesheet or query module. That small enough to be all dealt in memory, without filesystem access. Even better! And no need for install step! TODO: Regarding versionning, see comments of Repository.resolve(String,URISpace) (AKA we don't always want the latest version).

Parameters:

href - the URI

space - the URI space

Returns:

the source

Throws:

PackageException - if an error occurs

getModuleURIResolver

public net.sf.saxon.lib.ModuleURIResolver getModuleURIResolver()
                                                        throws PackageException

Throws:

PackageException

getURIResolver

public javax.xml.transform.URIResolver getURIResolver(URISpace space)
                                               throws PackageException

Throws:

PackageException

registerExtensionFunctions

public void registerExtensionFunctions(net.sf.saxon.Configuration config)
                                throws PackageException

TODO: Regarding versionning, see comments of Repository.resolve(String,URISpace) (AKA we don't always want the latest version).

Parameters:

config - the configuration

Throws:

PackageException - if an error occurs