org.expath.pkg.repo

Class FileSystemStorage.FileSystemResolver

java.lang.Object

org.expath.pkg.repo.Storage.PackageResolver

org.expath.pkg.repo.FileSystemStorage.FileSystemResolver

Enclosing class:

FileSystemStorage

public class FileSystemStorage.FileSystemResolver
extends Storage.PackageResolver

Constructor Summary

Constructors

Constructor and Description
FileSystemResolver(java.nio.file.Path pkg_dir, java.lang.String abbrev, java.lang.String rsrc_name)

Method Summary

Modifier and Type	Method and Description
java.net.URI	getContentDirBaseURI() The base URI of the package "content directory".
java.lang.String	getResourceName()
javax.xml.transform.stream.StreamSource	resolveComponent(java.lang.String path) Resolve a resource within the package "content directory".
java.nio.file.Path	resolveComponentAsFile(java.lang.String path)
javax.xml.transform.stream.StreamSource	resolveResource(java.lang.String path) Resolve a resource within the "package directory".
java.nio.file.Path	resolveResourceAsFile(java.lang.String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemResolver

public FileSystemResolver(@Nullable
                          java.nio.file.Path pkg_dir,
                          java.lang.String abbrev,
                          java.lang.String rsrc_name)
                   throws PackageException

Throws:

PackageException

Method Detail

getResourceName

public java.lang.String getResourceName()

Specified by:

getResourceName in class Storage.PackageResolver

Returns:

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

getContentDirBaseURI

public java.net.URI getContentDirBaseURI()

Description copied from class: Storage.PackageResolver

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.

Specified by:

getContentDirBaseURI in class Storage.PackageResolver

Returns:

the base URI of the package "content directory".

resolveResourceAsFile

public java.nio.file.Path resolveResourceAsFile(java.lang.String path)

resolveComponentAsFile

public java.nio.file.Path resolveComponentAsFile(java.lang.String path)

resolveResource

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

Description copied from class: Storage.PackageResolver

Resolve a resource within the "package directory".

Specified by:

resolveResource in class Storage.PackageResolver

Parameters:

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

Returns:

the corresponding Source object.

Throws:

PackageException - in case of any other error.

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

resolveComponent

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

Description copied from class: Storage.PackageResolver

Resolve a resource within the package "content directory".

Specified by:

resolveComponent in class Storage.PackageResolver

Parameters:

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

Returns:

the corresponding Source object.

Throws:

PackageException - in case of any other error.

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