org.apache.wicket.request.mapper

Class ParentPathReferenceRewriter

java.lang.Object

org.apache.wicket.request.mapper.ParentPathReferenceRewriter

All Implemented Interfaces:

IRequestMapper, IRequestMapperDelegate

public class ParentPathReferenceRewriter
extends Object
implements IRequestMapperDelegate

Mapper that rewrites parent path segments (../) with the specified string and viceversa.

Author:

igor.vaynberg

Constructor Summary

Constructors

Constructor and Description
ParentPathReferenceRewriter(IRequestMapper chain) Construct.
ParentPathReferenceRewriter(IRequestMapper chain, IProvider<String> escapeSequence) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCompatibilityScore(Request request) Returns the score representing how compatible this request mapper is to processing the given request.
IRequestMapper	getDelegateMapper() Returns the delegate IRequestMapper.
Url	mapHandler(IRequestHandler requestHandler) Returns the Url for given IRequestHandler or null if the request handler is not recognized.
IRequestHandler	mapRequest(Request request) Returns IRequestHandler for the request or null if the Url is not recognized.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParentPathReferenceRewriter

public ParentPathReferenceRewriter(IRequestMapper chain,
                           IProvider<String> escapeSequence)

Construct.

Parameters:

chain - chained request mapper

escapeSequence -

ParentPathReferenceRewriter

public ParentPathReferenceRewriter(IRequestMapper chain)

Construct.

Parameters:

chain - chained request mapper

Method Detail

mapRequest

public IRequestHandler mapRequest(Request request)

Description copied from interface: IRequestMapper

Returns IRequestHandler for the request or null if the Url is not recognized.

Specified by:

mapRequest in interface IRequestMapper

Parameters:

request - provides access to request data (i.e. Url and Parameters)

Returns:

RequestHandler instance or null

See Also:

IRequestMapper.mapRequest(org.apache.wicket.request.Request)

mapHandler

public Url mapHandler(IRequestHandler requestHandler)

Returns the Url for given IRequestHandler or null if the request handler is not recognized.

Specified by:

mapHandler in interface IRequestMapper

Returns:

Url instance or null.

getCompatibilityScore

public int getCompatibilityScore(Request request)

Returns the score representing how compatible this request mapper is to processing the given request. When a request comes in all mappers are scored and are tried in order from highest score to lowest.

A good criteria for calculating the score is the number of matched url segments. For example when there are two mappers for a mounted page, one mapped to /foo another to /foo/bar and the incoming request URL is /foo/bar/baz, the mapping to /foo/bar should probably handle the request first as it has matching segments count of 2 while the first one has only matching segments count of 1.

Note that the method can return value greater then zero even if the mapper does not recognize the request.

Specified by:

getCompatibilityScore in interface IRequestMapper

Returns:

the compatibility score, e.g. count of matching segments

getDelegateMapper

public IRequestMapper getDelegateMapper()

Returns the delegate IRequestMapper.

Specified by:

getDelegateMapper in interface IRequestMapperDelegate

Returns:

The delegate IRequestMapper.