org.apache.turbine.modules.pages
Class DefaultPage

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Page
          org.apache.turbine.modules.pages.DefaultPage

Direct Known Subclasses:

TemplatePage

public class DefaultPage

extends Page

When building sites using templates, Screens need only be defined for templates which require dynamic (database or object) data.

This page can be used on sites where the number of Screens can be much less than the number of templates. The templates can be grouped in directories with common layouts. Screen modules are then expected to be placed in packages corresponding with the templates' directories and follow a specific naming scheme.

The template parameter is parsed and and a Screen whose package matches the templates path and shares the same name minus any extension and beginning with a capital letter is searched for. If not found, a Screen in a package matching the template's path with name Default is searched for. If still not found, a Screen with name Default is looked for in packages corresponding to parent directories in the template's path until a match is found.

For example if data.getParameters().getString("template") returns /about_us/directions/driving.wm, the search follows about_us.directions.Driving, about_us.directions.Default, about_us.Default, Default, VelocitySiteScreen.

Only one Layout module is used, since it is expected that any dynamic content will be placed in navigations and screens. The layout template to be used is found in a similar way to the Screen. For example the following paths will be searched in the layouts subdirectory: /about_us/directions/driving.wm, /about_us/directions/default.wm, /about_us/default.wm, /default.wm.

This approach allows a site with largely static content to be updated and added to regularly by those with little Java experience.

The code is an almost a complete clone of the FreeMarkerSitePage written by John McNally. I've only modified it for Template use.

Version:

$Id: DefaultPage.java 264148 2005-08-29 14:21:04Z henning $

Author:

Dave Bryson, Henning P. Schmiedehausen

Field Summary

protected org.apache.commons.logging.Log

log Logging

Constructor Summary

DefaultPage()

Method Summary

void	doBuild(RunData data) Builds the Page.
protected void	doBuildAfterAction(RunData data) Can be overridden by template Pages to set up data needed to process a template.
protected void	doBuildBeforeAction(RunData data) Can be used by template Pages to stuff the Context into the RunData so that it is available to the Action module and the Screen module via getContext().
protected void	doPostBuild(RunData data) Can be overridden to perform actions when the request is fully processed.

Methods inherited from class org.apache.turbine.modules.Page

build

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

Logging

Constructor Detail

DefaultPage

public DefaultPage()

Method Detail

doBuild

public void doBuild(RunData data)
             throws java.lang.Exception

Builds the Page.

Specified by:

doBuild in class Page

Parameters:

data - Turbine information.

Throws:

Exception, - a generic exception.

java.lang.Exception - a generic exception.

doBuildBeforeAction

protected void doBuildBeforeAction(RunData data)
                            throws java.lang.Exception

Can be used by template Pages to stuff the Context into the RunData so that it is available to the Action module and the Screen module via getContext(). It does nothing here.

Parameters:

data - Turbine information.

Throws:

Exception, - a generic exception.

java.lang.Exception

doBuildAfterAction

protected void doBuildAfterAction(RunData data)
                           throws java.lang.Exception

Can be overridden by template Pages to set up data needed to process a template. It does nothing here.

Parameters:

data - Turbine information.

Throws:

Exception, - a generic exception.

java.lang.Exception

doPostBuild

protected void doPostBuild(RunData data)
                    throws java.lang.Exception

Can be overridden to perform actions when the request is fully processed. It does nothing here.

Parameters:

data - Turbine information.

Throws:

Exception, - a generic exception.

java.lang.Exception