com.manydesigns.portofino.dispatcher

Class PageInstance

java.lang.Object

com.manydesigns.portofino.dispatcher.PageInstance

public class PageInstance
extends Object

A PageInstance is the realization of a Portofino page on permanent storage (page.xml + configuration.xml + action.groovy) into a live object in the context of a single http request.
A PageInstance includes the parameters extracted from the decomposition of the URL in a sequence of fragments (not to be confused with query string parameters).

Author:

Paolo Predonzani - paolo.predonzani@manydesigns.com, Angelo Lupo - angelo.lupo@manydesigns.com, Giampiero Granatella - giampiero.granatella@manydesigns.com, Alessio Stalla - alessio.stalla@manydesigns.com

Field Summary

Fields

Modifier and Type	Field and Description
protected PageAction	actionBean
protected Class<? extends PageAction>	actionClass
protected Object	configuration
protected String	description
static String	DETAIL
protected File	directory
static org.slf4j.Logger	logger
protected Page	page
protected List<String>	parameters
protected PageInstance	parent
protected boolean	prepared
protected String	title

Constructor Summary

Constructors

Constructor and Description
PageInstance(PageInstance parent, File directory, Page page, Class<? extends PageAction> actionClass)

Method Summary

Methods

Modifier and Type	Method and Description
PageInstance	copy()
PageAction	getActionBean() Returns an object that implements this page.
Class<? extends PageAction>	getActionClass() Returns the class that implements this page.
Page	getChildPage(String name)
File	getChildPageDirectory(String name)
File	getChildrenDirectory()
Object	getConfiguration() Returns the configuration object for this page.
String	getDescription()
File	getDirectory() Returns the directory from which this page was loaded.
Layout	getLayout() Returns the layout that drives the display of the embedded children of this page.
String	getName()
Page	getPage()
List<String>	getParameters() Returns the parameters extracted from the URL for this page.
PageInstance	getParent() Returns the page instance that precedes this one in the path, or null if this is an instance of the root page.
String	getPath() Reconstructs the URL path to this PageInstance from the root of the application (not including the webapp's context path).
String	getTitle()
String	getUrlFragment() Returns the portion of the URL that identifies this PageInstance, including any parameters.
boolean	isPrepared()
void	setActionBean(PageAction actionBean)
void	setConfiguration(Object configuration)
void	setDescription(String description)
void	setLayout(Layout layout) Sets the layout that drives the display of the embedded children of this page.
void	setPrepared(boolean prepared)
void	setTitle(String title)

Methods inherited from class java.lang.Object

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

Field Detail

page

protected final Page page

directory

protected final File directory

parameters

protected final List<String> parameters

parent

protected final PageInstance parent

actionClass

protected final Class<? extends PageAction> actionClass

configuration

protected Object configuration

actionBean

protected PageAction actionBean

title

protected String title

description

protected String description

prepared

protected boolean prepared

DETAIL

public static final String DETAIL

See Also:

Constant Field Values

logger

public static final org.slf4j.Logger logger

Constructor Detail

PageInstance

public PageInstance(PageInstance parent,
            File directory,
            Page page,
            Class<? extends PageAction> actionClass)

Method Detail

copy

public PageInstance copy()

getPage

public Page getPage()

getUrlFragment

public String getUrlFragment()

Returns the portion of the URL that identifies this PageInstance, including any parameters.

getPath

public String getPath()

Reconstructs the URL path to this PageInstance from the root of the application (not including the webapp's context path).

getDirectory

public File getDirectory()

Returns the directory from which this page was loaded.

getParameters

public List<String> getParameters()

Returns the parameters extracted from the URL for this page.

getConfiguration

public Object getConfiguration()

Returns the configuration object for this page.

setConfiguration

public void setConfiguration(Object configuration)

getActionClass

public Class<? extends PageAction> getActionClass()

Returns the class that implements this page.

getActionBean

public PageAction getActionBean()

Returns an object that implements this page.

See Also:

getActionClass()

setActionBean

public void setActionBean(PageAction actionBean)

getParent

public PageInstance getParent()

Returns the page instance that precedes this one in the path, or null if this is an instance of the root page.

getLayout

public Layout getLayout()

Returns the layout that drives the display of the embedded children of this page. If this page instance has parameters, the detail layout is returned; else, the regular layout is returned.

Returns:

the layout.

setLayout

public void setLayout(Layout layout)

Sets the layout that drives the display of the embedded children of this page. If this page instance has parameters, the detail layout is set; else, the regular layout is set.

Parameters:

layout - the new layout.

getChildPage

public Page getChildPage(String name)
                  throws Exception

Throws:

Exception

getChildPageDirectory

public File getChildPageDirectory(String name)

getChildrenDirectory

public File getChildrenDirectory()

getName

public String getName()

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

isPrepared

public boolean isPrepared()

setPrepared

public void setPrepared(boolean prepared)