com.neurosys.site.wicket.components.app

Class PageLocator

java.lang.Object

com.neurosys.site.wicket.components.app.PageLocator

All Implemented Interfaces:

IPageLocator

Direct Known Subclasses:

TemplatePageLocator

public class PageLocator
extends Object
implements IPageLocator

Locate pages/resources that map to application context. Wicket application pages are intended to be with the component. This allows you to specify the actual location on the drive and not have to keep them the same.

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected String	derivedPathPrefix
protected String	relativeClassPathToWicketPage

Constructor Summary

Constructors

Constructor and Description
PageLocator()
PageLocator(String relativeClassPathToWicketPage, String derivedPathPrefix)

Method Summary

Modifier and Type	Method and Description
String	getDerivedPathPrefix() A prefix added to the path to determine relative Folder path to the actual pages. Example: /admin/html folder relative to WebApp root, contains the pages for some admin context pages
String	getRelativeClassPathToWicketPage() Relative path to pages referred by wicket (classpath to base Page package).
org.apache.wicket.util.resource.IResourceStream	locate(Class<?> clazz, String path, org.apache.wicket.protocol.http.WebApplication app) If it cannot the path then return null
protected org.apache.wicket.util.resource.IResourceStream	locateMarkupPath(Class<?> clazz, javax.servlet.ServletContext sc, String requestedPagePath) Locate the Markup for the component
static String	optimizeOnLocale(String s) The first time the locator runs it searches through file names and suffixes Locale code and Country code (trial & error).

Methods inherited from class java.lang.Object

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

Field Detail

relativeClassPathToWicketPage

protected String relativeClassPathToWicketPage

derivedPathPrefix

protected String derivedPathPrefix

Constructor Detail

PageLocator

public PageLocator()

PageLocator

public PageLocator(String relativeClassPathToWicketPage,
                   String derivedPathPrefix)

Parameters:

relativeClassPathToWicketPage - as Relative path to pages referred by wicket (classpath to base Page package). Example: com/abc/admin

derivedPathPrefix - as A prefix added to the path to determine relative Folder path to the actual pages.
Example of derivedPathPrefix: /admin/html folder relative to WebApp root, contains the pages for some admin context pages

Method Detail

optimizeOnLocale

public static final String optimizeOnLocale(String s)

The first time the locator runs it searches through file names and suffixes Locale code and Country code (trial & error).
We are not availing Wickets localization for these pages so cutting the locale info to help it locate the page faster.

Parameters:

s -

Returns:

locateMarkupPath

protected org.apache.wicket.util.resource.IResourceStream locateMarkupPath(Class<?> clazz,
                                                                           javax.servlet.ServletContext sc,
                                                                           String requestedPagePath)

Locate the Markup for the component

Parameters:

clazz - for the markup container/component (used to represents the ClassLoader loading the resource)

sc - as ServletContext

requestedPagePath - as String (matches location version of classpath of component)

Returns:

IResourceStream

See Also:

SiteApplication#tweakMarkupCacheStreamProvider}

locate

public org.apache.wicket.util.resource.IResourceStream locate(Class<?> clazz,
                                                              String path,
                                                              org.apache.wicket.protocol.http.WebApplication app)

If it cannot the path then return null

Specified by:

locate in interface IPageLocator

Parameters:

clazz - for the markup container/component (used to represents the ClassLoader loading the resource)

path - as original requestedPagePath

app -

Returns:

See Also:

SiteApplication#tweakMarkupCacheStreamProvider}

getRelativeClassPathToWicketPage

public String getRelativeClassPathToWicketPage()

Relative path to pages referred by wicket (classpath to base Page package). Example: com/abc/admin

Returns:

String

getDerivedPathPrefix

public String getDerivedPathPrefix()

A prefix added to the path to determine relative Folder path to the actual pages.
Example: /admin/html folder relative to WebApp root, contains the pages for some admin context pages

Returns:

String