org.apache.jetspeed.portalsite.view
Class SiteView

java.lang.Object
  org.apache.jetspeed.portalsite.view.SiteView

public class SiteView
extends java.lang.Object

This class defines the logical view of site content.

Version:

$Id: SiteView.java 534967 2007-05-03 19:23:06Z taylor $

Author:

Randy Watler

Field Summary

static java.lang.String	ALT_CURRENT_PAGE_PATH ALT_CURRENT_PAGE_PATH - alternate expression used to match the current page
static java.lang.String	CURRENT_PAGE_PATH CURRENT_PAGE_PATH - expression used to match the current page
static java.lang.String	CUSTOM_PAGE_NAVIGATIONS_MENU_NAME CUSTOM_*_MENU_NAME - custom menu names
static java.lang.String	STANDARD_BACK_MENU_NAME STANDARD_*_MENU_NAME - standard menu names
static java.lang.String	STANDARD_BREADCRUMBS_MENU_NAME
static java.lang.String	STANDARD_NAVIGATIONS_MENU_NAME
static java.lang.String	STANDARD_PAGES_MENU_NAME

Constructor Summary

SiteView(PageManager pageManager)
SiteView - basic constructor

SiteView(PageManager pageManager, java.util.List searchPaths)
SiteView - validating constructor

SiteView(PageManager pageManager, java.util.Map locators)
SiteView - validating constructor

SiteView(PageManager pageManager, ProfileLocator locator)
SiteView - validating constructor

SiteView(PageManager pageManager, java.lang.String searchPaths)
SiteView - validating constructor

SiteView(PageManager pageManager, java.lang.String[] searchPaths)
SiteView - validating constructor

Method Summary

Page	getManagedPage(Page page) getManagedPage - get concrete page instance from page proxy; implemented here to hide view proxy manipulation from more general portal site implementation
SiteViewMenuDefinitionLocator	getMenuDefinitionLocator(Node node, java.lang.String name) getMenuDefinitionLocator - get named view node proxy menu definition locator; implemented here to hide view proxy manipulation from more general portal site implementation
java.util.List	getMenuDefinitionLocators(Node node) getMenuDefinitionLocators - get list of view node proxy menu definition locators; implemented here to hide view proxy manipulation from more general portal site implementation
java.util.List	getNodeProxies(java.lang.String regexpPath, Node currentNode, boolean onlyViewable, boolean onlyVisible) getNodeProxies - get folder, page, or link proxies at relative or absolute path using simple path wildcards and character classes
Node	getNodeProxy(java.lang.String path, Node currentNode, boolean onlyViewable, boolean onlyVisible) getNodeProxy - get single folder, page, or link proxy at relative or absolute path
PageManager	getPageManager() getPageManager - return PageManager component instance
java.lang.String	getProfileLocatorName(Node node) getProfileLocatorName - get view node proxy profile locator name; implemented here to hide view proxy manipulation from more general portal site implementation
Folder	getRootFolderProxy() getRootFolderProxy - create and return root folder proxy instance
java.util.List	getSearchPaths() getSearchPaths - return ordered search paths list that defines this view
java.lang.String	getSearchPathsString() getSearchPathsString - return search paths as string
java.util.List	getStandardMenuDefinitionLocators() getStandardMenuDefinitionLocators - get list of available standard menu definition locators
java.util.Set	getStandardMenuNames() getStandardMenuNames - get set of available standard menu names

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_PAGE_PATH

public static final java.lang.String CURRENT_PAGE_PATH

CURRENT_PAGE_PATH - expression used to match the current page

See Also:

Constant Field Values

ALT_CURRENT_PAGE_PATH

public static final java.lang.String ALT_CURRENT_PAGE_PATH

ALT_CURRENT_PAGE_PATH - alternate expression used to match the current page

See Also:

Constant Field Values

STANDARD_BACK_MENU_NAME

public static final java.lang.String STANDARD_BACK_MENU_NAME

STANDARD_*_MENU_NAME - standard menu names

See Also:

Constant Field Values

STANDARD_BREADCRUMBS_MENU_NAME

public static final java.lang.String STANDARD_BREADCRUMBS_MENU_NAME

See Also:

Constant Field Values

STANDARD_PAGES_MENU_NAME

public static final java.lang.String STANDARD_PAGES_MENU_NAME

See Also:

Constant Field Values

STANDARD_NAVIGATIONS_MENU_NAME

public static final java.lang.String STANDARD_NAVIGATIONS_MENU_NAME

See Also:

Constant Field Values

CUSTOM_PAGE_NAVIGATIONS_MENU_NAME

public static final java.lang.String CUSTOM_PAGE_NAVIGATIONS_MENU_NAME

CUSTOM_*_MENU_NAME - custom menu names

See Also:

Constant Field Values

Constructor Detail

SiteView

public SiteView(PageManager pageManager,
                java.util.List searchPaths)

SiteView - validating constructor

Parameters:

pageManager - PageManager component instance

searchPaths - list of search paths in string or search path object form

SiteView

public SiteView(PageManager pageManager,
                java.lang.String[] searchPaths)

SiteView - validating constructor

Parameters:

pageManager - PageManager component instance

searchPaths - array of search paths

SiteView

public SiteView(PageManager pageManager,
                java.lang.String searchPaths)

SiteView - validating constructor

Parameters:

pageManager - PageManager component instance

searchPaths - string of comma separated search paths

SiteView

public SiteView(PageManager pageManager,
                ProfileLocator locator)

SiteView - validating constructor

Parameters:

pageManager - PageManager component instance

locator - profile locator search specification

SiteView

public SiteView(PageManager pageManager,
                java.util.Map locators)

SiteView - validating constructor

Parameters:

pageManager - PageManager component instance

locators - map of named profile locator search specifications

SiteView

public SiteView(PageManager pageManager)

SiteView - basic constructor

Parameters:

pageManager - PageManager component instance

Method Detail

getPageManager

public PageManager getPageManager()

getPageManager - return PageManager component instance

Returns:

PageManager instance

getSearchPaths

public java.util.List getSearchPaths()

getSearchPaths - return ordered search paths list that defines this view

Returns:

search paths list

getSearchPathsString

public java.lang.String getSearchPathsString()

getSearchPathsString - return search paths as string

Returns:

search paths list as comma separated string

getRootFolderProxy

public Folder getRootFolderProxy()
                          throws FolderNotFoundException

getRootFolderProxy - create and return root folder proxy instance

Returns:

root folder proxy

Throws:

FolderNotFoundException - if not found

java.lang.SecurityException - if view access not granted

getNodeProxy

public Node getNodeProxy(java.lang.String path,
                         Node currentNode,
                         boolean onlyViewable,
                         boolean onlyVisible)
                  throws NodeNotFoundException

getNodeProxy - get single folder, page, or link proxy at relative or absolute path

Parameters:

path - single node path

currentNode - current folder or page for relative paths or null

onlyViewable - node required to be viewable

onlyVisible - node required to be visible, (or current)

Returns:

folder, page, or link node proxy

Throws:

NodeNotFoundException - if not found

java.lang.SecurityException - if view access not granted

getNodeProxies

public java.util.List getNodeProxies(java.lang.String regexpPath,
                                     Node currentNode,
                                     boolean onlyViewable,
                                     boolean onlyVisible)

getNodeProxies - get folder, page, or link proxies at relative or absolute path using simple path wildcards and character classes

Parameters:

regexpPath - regular expression node path

currentNode - current folder or page for relative paths or null

onlyViewable - nodes required to be viewable flag

onlyVisible - node required to be visible, (or current)

Returns:

list of folder, page, or link node proxies

getStandardMenuNames

public java.util.Set getStandardMenuNames()

getStandardMenuNames - get set of available standard menu names

Returns:

menu names set

getStandardMenuDefinitionLocators

public java.util.List getStandardMenuDefinitionLocators()

getStandardMenuDefinitionLocators - get list of available standard menu definition locators

Returns:

menu definition locators list

getMenuDefinitionLocators

public java.util.List getMenuDefinitionLocators(Node node)

getMenuDefinitionLocators - get list of view node proxy menu definition locators; implemented here to hide view proxy manipulation from more general portal site implementation

Parameters:

node - node proxy

Returns:

definition locator list

getMenuDefinitionLocator

public SiteViewMenuDefinitionLocator getMenuDefinitionLocator(Node node,
                                                              java.lang.String name)

getMenuDefinitionLocator - get named view node proxy menu definition locator; implemented here to hide view proxy manipulation from more general portal site implementation

Parameters:

node - node proxy

name - menu definition name

Returns:

menu definition locator

getProfileLocatorName

public java.lang.String getProfileLocatorName(Node node)

getProfileLocatorName - get view node proxy profile locator name; implemented here to hide view proxy manipulation from more general portal site implementation

Parameters:

node - node proxy

Returns:

profile locator name

getManagedPage

public Page getManagedPage(Page page)

getManagedPage - get concrete page instance from page proxy; implemented here to hide view proxy manipulation from more general portal site implementation

Parameters:

page - page proxy

Returns:

managed page