org.sitemesh.config

Class PathMapper<T>

java.lang.Object

org.sitemesh.config.PathMapper<T>

public class PathMapper<T>
extends Object

The PathMapper is used to map file patterns to keys, and find an approriate key for a given file path. The pattern rules are consistent with those defined in the Servlet 2.3 API on the whole. Wildcard patterns are also supported, using any combination of * and ?.

Example

PathMapper pm = new PathMapper();

pm.put("/", one);
pm.put("/mydir/*", two);
pm.put("*.xml", three);
pm.put(""/myexactfile.html", four);
pm.put("/*\/admin/*.??ml", five);

result1 = pm.get("/mydir/myfile.xml"); // returns two;
result2 = pm.get("/mydir/otherdir/admin/myfile.html"); // returns five;


Author:

Joe Walnes, Mike Cannon-Brookes, Hani Suleiman, Vladimir Orany

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	DEFAULT_KEYS

Constructor Summary

Constructors

Constructor and Description
PathMapper()

Method Summary

Methods

Modifier and Type	Method and Description
T	get(String path) Retrieve appropriate key by matching patterns with supplied path.
String	getPatternInUse(String path) Retrieve appropriate pattern by matching patterns with supplied path.
static boolean	isComplexKey(String key) Return true if the key contains wild cards.
static boolean	isDefaultKey(String key) Return true if the key default key matching all paths.
static boolean	isMoreSpecific(String exclusionPattern, String decoratorPattern) Wheter the first pattern is more specific than the second one.
void	put(String pattern, T value) Add a key and appropriate matching pattern.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEYS

public static final Set<String> DEFAULT_KEYS

Constructor Detail

PathMapper

public PathMapper()

Method Detail

put

public void put(String pattern,
       T value)

Add a key and appropriate matching pattern.

get

public T get(String path)

Retrieve appropriate key by matching patterns with supplied path.

getPatternInUse

public String getPatternInUse(String path)

Retrieve appropriate pattern by matching patterns with supplied path.

isComplexKey

public static boolean isComplexKey(String key)

Return true if the key contains wild cards.

Parameters:

key - key under test

Returns:

true if the key contains wild cards

isDefaultKey

public static boolean isDefaultKey(String key)

Return true if the key default key matching all paths.

Parameters:

key - key under test

Returns:

true if the key default key matching all paths

isMoreSpecific

public static boolean isMoreSpecific(String exclusionPattern,
                     String decoratorPattern)

Wheter the first pattern is more specific than the second one. Exact patterns are more specific than complex patterns and complex patterns are more specific than default patterns.

Parameters:

exclusionPattern - pattern which must be more or equally specific to return true

decoratorPattern - pattern which must be less specific to return true

Returns:

true if the first pattern is more specific than the second one