org.expath.pkg.repo

Class Storage.PackageResolver

java.lang.Object

org.expath.pkg.repo.Storage.PackageResolver

Direct Known Subclasses:

ClasspathStorage.ClasspathResolver, FileSystemStorage.FileSystemResolver

Enclosing class:

Storage

public abstract static class Storage.PackageResolver
extends java.lang.Object

Resolve paths in a package installed in the repository.

Constructor Summary

Constructors

Constructor and Description
PackageResolver()

Method Summary

Modifier and Type	Method and Description
abstract java.net.URI	getContentDirBaseURI() The base URI of the package "content directory".
abstract java.lang.String	getResourceName()
abstract javax.xml.transform.Source	resolveComponent(java.lang.String path) Resolve a resource within the package "content directory".
abstract javax.xml.transform.Source	resolveResource(java.lang.String path) Resolve a resource within the "package directory".

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageResolver

public PackageResolver()

Method Detail

getResourceName

public abstract java.lang.String getResourceName()

Returns:

the package ID within the repository (i.e. its subdirectory name).

resolveResource

public abstract javax.xml.transform.Source resolveResource(java.lang.String path)
                                                    throws PackageException,
                                                           Storage.NotExistException

Resolve a resource within the "package directory".

Parameters:

path - The path to resolve, relative to the package directory.

Returns:

the corresponding Source object.

Throws:

Storage.NotExistException - if the corresponding resource does not exist in the package.

PackageException - in case of any other error.

resolveComponent

public abstract javax.xml.transform.Source resolveComponent(java.lang.String path)
                                                     throws PackageException,
                                                            Storage.NotExistException

Resolve a resource within the package "content directory".

Parameters:

path - The path to resolve, relative to the package content directory.

Returns:

the corresponding Source object.

Throws:

Storage.NotExistException - if the corresponding component does not exist in the package.

PackageException - in case of any other error.

getContentDirBaseURI

public abstract java.net.URI getContentDirBaseURI()
                                           throws PackageException

The base URI of the package "content directory". It is not recommended that the user resolves URIs him- or herself. Other functions in this class are all about resolving resources and components in this package. But sometimes, the user will want to simply get back the resolved URI, instead of the corresponding entity content. Using URI.resolve(String) on the returned value, with a relative filename, must resolve this filename in the installed package "content directory". Use with caution, especially on storages not on a (regular) file-system.

Returns:

the base URI of the package "content directory".

Throws:

PackageException - in case of any error. Also thrown by storage implementations for which such a URI does not make sense.