fr.sii.ogham.core.resource.resolver

Class RelativeResolver

java.lang.Object

fr.sii.ogham.core.resource.resolver.RelativeResolver

All Implemented Interfaces:

DelegateResourceResolver, ResourceResolver

public class RelativeResolver
extends Object
implements DelegateResourceResolver

Decorator resource resolver that use parent path and extension for resource resolution.

For example, the parent path values "email/user/" and the extension is ".html". The resource name is "hello". This resource resolver appends the parent path, the resource name and the extension generating the path "email/user/hello.html".

Once the path is generated, then this implementation delegates the real resource resolution to another implementation.

Author:

Aurélien Baudet

Constructor Summary

Constructors

Constructor and Description
RelativeResolver(RelativisableResourceResolver delegate, String parentPath) Initialize the resolver with the mandatory delegate and a parent path.
RelativeResolver(RelativisableResourceResolver delegate, String parentPath, String extension) Initialize the resolver with the mandatory delegate, a parent path and a extension.

Method Summary

Modifier and Type	Method and Description
ResourceResolver	getActualResourceResolver() Finds the final delegated ResourceResolver by any level of delegation.
String	getExtension()
String	getParentPath()
Resource	getResource(String path) Find the resource using the resource path (or its name).
ResourcePath	getResourcePath(String path) Transforms a string path in a ResourcePath.
boolean	supports(String path) Indicates if the resource path can be handled by this resource resolver or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelativeResolver

public RelativeResolver(RelativisableResourceResolver delegate,
                        String parentPath)

Initialize the resolver with the mandatory delegate and a parent path. No extension will be appended to the resource path.

Parameters:

delegate - the resolver that will do the real resource resolution

parentPath - a string to add before the resource path

RelativeResolver

public RelativeResolver(RelativisableResourceResolver delegate,
                        String parentPath,
                        String extension)

Initialize the resolver with the mandatory delegate, a parent path and a extension.

Parameters:

delegate - the resolver that will do the real resource resolution

parentPath - a string to add before the resource path

extension - a string to add after the resource path

Method Detail

getResource

public Resource getResource(String path)
                     throws ResourceResolutionException

Description copied from interface: ResourceResolver

Find the resource using the resource path (or its name).

Specified by:

getResource in interface ResourceResolver

Parameters:

path - the path of the resource

Returns:

the found resource

Throws:

ResourceResolutionException - when the resource couldn't be found

getParentPath

public String getParentPath()

getExtension

public String getExtension()

supports

public boolean supports(String path)

Description copied from interface: ResourceResolver

Indicates if the resource path can be handled by this resource resolver or not.

Specified by:

supports in interface ResourceResolver

Parameters:

path - the name or the path of the resource

Returns:

true if the resource path can be handled by this resource resolver, false otherwise

getResourcePath

public ResourcePath getResourcePath(String path)

Description copied from interface: ResourceResolver

Transforms a string path in a ResourcePath.

Specified by:

getResourcePath in interface ResourceResolver

Returns:

the resolved resource path or null if it does not support it.

getActualResourceResolver

public ResourceResolver getActualResourceResolver()

Description copied from interface: DelegateResourceResolver

Finds the final delegated ResourceResolver by any level of delegation.

Specified by:

getActualResourceResolver in interface DelegateResourceResolver

Returns:

a ResourceResolver that can be translated to an template engine adapter