org.apache.wicket.request.mapper
Class HomePageMapper

java.lang.Object
  extended by org.apache.wicket.request.mapper.AbstractMapper
      extended by org.apache.wicket.request.mapper.AbstractComponentMapper
          extended by org.apache.wicket.request.mapper.HomePageMapper
All Implemented Interfaces:
IRequestMapper

public class HomePageMapper
extends AbstractComponentMapper

Default mapper for rendering the configured home page.

Note: Handles requests to '/' but does not produce Url for it, thus BookmarkableMapper produces something like '/wicket/bookmarkable/com.example.MyHomePage' for it. If the user application wants to preserve '/' then it should mount the home page explicitly in MyApplication#init()

Author:
Matej Knopp

Constructor Summary
HomePageMapper()
          Construct.
HomePageMapper(IPageParametersEncoder pageParametersEncoder)
          Construct.
 
Method Summary
 int getCompatibilityScore(Request request)
          Returns the score representing how compatible this request mapper is to processing the given request.
 Url mapHandler(IRequestHandler requestHandler)
          Returns the Url for given IRequestHandler or null if the encoder does not recognize the request handler.
 IRequestHandler mapRequest(Request request)
          Returns IRequestHandler for the request or null if the encoder does not recognize the URL.
 
Methods inherited from class org.apache.wicket.request.mapper.AbstractComponentMapper
encodePageComponentInfo, getContext, getPageClass, getPageComponentInfo, removeMetaParameter, requestListenerInterfaceFromString, requestListenerInterfaceToString
 
Methods inherited from class org.apache.wicket.request.mapper.AbstractMapper
encodePageParameters, extractPageParameters, getMountSegments, getPlaceholder, urlStartsWith
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HomePageMapper

public HomePageMapper()
Construct.


HomePageMapper

public HomePageMapper(IPageParametersEncoder pageParametersEncoder)
Construct.

Parameters:
pageParametersEncoder -
Method Detail

getCompatibilityScore

public int getCompatibilityScore(Request request)
Description copied from interface: IRequestMapper
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 encoders for mounted page, one mapped to /foo another to /foo/bar and the incoming request URL is /foo/bar/baz, the encoder mapped to /foo/bar will 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 encoder can not decode the request.

Returns:
count of matching segments

mapHandler

public Url mapHandler(IRequestHandler requestHandler)
Description copied from interface: IRequestMapper
Returns the Url for given IRequestHandler or null if the encoder does not recognize the request handler.

Returns:
Url instance or null.

mapRequest

public IRequestHandler mapRequest(Request request)
Description copied from interface: IRequestMapper
Returns IRequestHandler for the request or null if the encoder does not recognize the URL.

Parameters:
request - provides access to request data (i.e. Url and Parameters)
Returns:
RequestHandler instance or null


Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.