org.apache.jetspeed.portalsite.view
Class SiteView

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

public class SiteView
extends 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 String	ALT_CURRENT_PAGE_PATH ALT_CURRENT_PAGE_PATH - alternate expression used to match the current page
static String	CURRENT_PAGE_PATH CURRENT_PAGE_PATH - expression used to match the current page
static String	CUSTOM_PAGE_NAVIGATIONS_MENU_NAME CUSTOM_*_MENU_NAME - custom menu names
private org.apache.jetspeed.page.PageManager	pageManager pageManager - PageManager component
private org.apache.jetspeed.om.folder.Folder	rootFolderProxy rootFolderProxy - root folder proxy instance
private List	searchPaths searchPaths - validated list of ordered search path objects where paths have no trailing folder separator
private String	searchPathsString searchPathsString - search paths as string
static String	STANDARD_BACK_MENU_NAME STANDARD_*_MENU_NAME - standard menu names
static String	STANDARD_BREADCRUMBS_MENU_NAME
private static List	STANDARD_MENU_DEFINITION_LOCATORS STANDARD_MENU_DEFINITION_LOCATORS - list of standard menu definition locators
private static Set	STANDARD_MENU_NAMES STANDARD_MENU_NAMES - set of supported standard menu names
static String	STANDARD_NAVIGATIONS_MENU_NAME
static String	STANDARD_PAGES_MENU_NAME

Constructor Summary

SiteView(org.apache.jetspeed.page.PageManager pageManager)
SiteView - basic constructor

SiteView(org.apache.jetspeed.page.PageManager pageManager, List searchPaths)
SiteView - validating constructor

SiteView(org.apache.jetspeed.page.PageManager pageManager, Map locators)
SiteView - validating constructor

SiteView(org.apache.jetspeed.page.PageManager pageManager, org.apache.jetspeed.profiler.ProfileLocator locator)
SiteView - validating constructor

SiteView(org.apache.jetspeed.page.PageManager pageManager, String searchPaths)
SiteView - validating constructor

SiteView(org.apache.jetspeed.page.PageManager pageManager, String[] searchPaths)
SiteView - validating constructor

Method Summary

org.apache.jetspeed.om.page.Page	getManagedPage(org.apache.jetspeed.om.page.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(org.apache.jetspeed.page.document.Node node, String name) getMenuDefinitionLocator - get named view node proxy menu definition locator; implemented here to hide view proxy manipulation from more general portal site implementation
List	getMenuDefinitionLocators(org.apache.jetspeed.page.document.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
List	getNodeProxies(String regexpPath, org.apache.jetspeed.page.document.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
org.apache.jetspeed.page.document.Node	getNodeProxy(String path, org.apache.jetspeed.page.document.Node currentNode, boolean onlyViewable, boolean onlyVisible) getNodeProxy - get single folder, page, or link proxy at relative or absolute path
org.apache.jetspeed.page.PageManager	getPageManager() getPageManager - return PageManager component instance
String	getProfileLocatorName(org.apache.jetspeed.page.document.Node node) getProfileLocatorName - get view node proxy profile locator name; implemented here to hide view proxy manipulation from more general portal site implementation
org.apache.jetspeed.om.folder.Folder	getRootFolderProxy() getRootFolderProxy - create and return root folder proxy instance
List	getSearchPaths() getSearchPaths - return ordered search paths list that defines this view
String	getSearchPathsString() getSearchPathsString - return search paths as string
List	getStandardMenuDefinitionLocators() getStandardMenuDefinitionLocators - get list of available standard menu definition locators
Set	getStandardMenuNames() getStandardMenuNames - get set of available standard menu names
private static boolean	isProxyViewable(org.apache.jetspeed.page.document.Node nodeProxy, boolean onlyVisible) isProxyViewable - tests for node proxy visibility in view
private static List	makeSearchPathList(Map locators) makeSearchPathList - construct from profile locators
private static List	makeSearchPathList(org.apache.jetspeed.profiler.ProfileLocator locator) makeSearchPathList - construct from profile locator
private static List	makeSearchPathList(String searchPaths) makeSearchPathList - construct from string
private static List	makeSearchPathList(String[] searchPaths) makeSearchPathList - construct from array
private static List	mergeSearchPathList(String locatorName, org.apache.jetspeed.profiler.ProfileLocator locator, List searchPaths) mergeSearchPathList - append search paths from profile locator
private static String	pathRegexpPattern(String regexp) pathRegexpPattern - tests for and converts simple path wildcard and character class regular exressions to perl5/standard java pattern syntax

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 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 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 String STANDARD_BACK_MENU_NAME

STANDARD_*_MENU_NAME - standard menu names

See Also:

Constant Field Values

STANDARD_BREADCRUMBS_MENU_NAME

public static final String STANDARD_BREADCRUMBS_MENU_NAME

See Also:

Constant Field Values

STANDARD_PAGES_MENU_NAME

public static final String STANDARD_PAGES_MENU_NAME

See Also:

Constant Field Values

STANDARD_NAVIGATIONS_MENU_NAME

public static final String STANDARD_NAVIGATIONS_MENU_NAME

See Also:

Constant Field Values

CUSTOM_PAGE_NAVIGATIONS_MENU_NAME

public static final String CUSTOM_PAGE_NAVIGATIONS_MENU_NAME

CUSTOM_*_MENU_NAME - custom menu names

See Also:

Constant Field Values

STANDARD_MENU_NAMES

private static final Set STANDARD_MENU_NAMES

STANDARD_MENU_NAMES - set of supported standard menu names

STANDARD_MENU_DEFINITION_LOCATORS

private static final List STANDARD_MENU_DEFINITION_LOCATORS

STANDARD_MENU_DEFINITION_LOCATORS - list of standard menu definition locators

pageManager

private org.apache.jetspeed.page.PageManager pageManager

pageManager - PageManager component

searchPaths

private List searchPaths

searchPaths - validated list of ordered search path objects where paths have no trailing folder separator

searchPathsString

private String searchPathsString

searchPathsString - search paths as string

rootFolderProxy

private org.apache.jetspeed.om.folder.Folder rootFolderProxy

rootFolderProxy - root folder proxy instance

Constructor Detail

SiteView

public SiteView(org.apache.jetspeed.page.PageManager pageManager,
                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(org.apache.jetspeed.page.PageManager pageManager,
                String[] searchPaths)

SiteView - validating constructor

Parameters:

pageManager - PageManager component instance

searchPaths - array of search paths

SiteView

public SiteView(org.apache.jetspeed.page.PageManager pageManager,
                String searchPaths)

SiteView - validating constructor

Parameters:

pageManager - PageManager component instance

searchPaths - string of comma separated search paths

SiteView

public SiteView(org.apache.jetspeed.page.PageManager pageManager,
                org.apache.jetspeed.profiler.ProfileLocator locator)

SiteView - validating constructor

Parameters:

pageManager - PageManager component instance

locator - profile locator search specification

SiteView

public SiteView(org.apache.jetspeed.page.PageManager pageManager,
                Map locators)

SiteView - validating constructor

Parameters:

pageManager - PageManager component instance

locators - map of named profile locator search specifications

SiteView

public SiteView(org.apache.jetspeed.page.PageManager pageManager)

SiteView - basic constructor

Parameters:

pageManager - PageManager component instance

Method Detail

makeSearchPathList

private static List makeSearchPathList(String[] searchPaths)

makeSearchPathList - construct from array

Parameters:

searchPaths - array of search paths

Returns:

search path list

makeSearchPathList

private static List makeSearchPathList(String searchPaths)

makeSearchPathList - construct from string

Parameters:

searchPaths - string of comma separated search paths

Returns:

search path list

makeSearchPathList

private static List makeSearchPathList(org.apache.jetspeed.profiler.ProfileLocator locator)

makeSearchPathList - construct from profile locator

Parameters:

locator - profile locator search specification

Returns:

search path list

makeSearchPathList

private static List makeSearchPathList(Map locators)

makeSearchPathList - construct from profile locators

Parameters:

locators - map of named profile locator search specifications

Returns:

search path list

mergeSearchPathList

private static List mergeSearchPathList(String locatorName,
                                        org.apache.jetspeed.profiler.ProfileLocator locator,
                                        List searchPaths)

mergeSearchPathList - append search paths from profile locator

Parameters:

locatorName - name of profile locator

locator - profile locator search specification

searchPaths - list of search paths to merge into

Returns:

search path list

getPageManager

public org.apache.jetspeed.page.PageManager getPageManager()

getPageManager - return PageManager component instance

Returns:

PageManager instance

getSearchPaths

public List getSearchPaths()

getSearchPaths - return ordered search paths list that defines this view

Returns:

search paths list

getSearchPathsString

public String getSearchPathsString()

getSearchPathsString - return search paths as string

Returns:

search paths list as comma separated string

getRootFolderProxy

public org.apache.jetspeed.om.folder.Folder getRootFolderProxy()
                                                        throws org.apache.jetspeed.om.folder.FolderNotFoundException

getRootFolderProxy - create and return root folder proxy instance

Returns:

root folder proxy

Throws:

org.apache.jetspeed.om.folder.FolderNotFoundException - if not found

SecurityException - if view access not granted

getNodeProxy

public org.apache.jetspeed.page.document.Node getNodeProxy(String path,
                                                           org.apache.jetspeed.page.document.Node currentNode,
                                                           boolean onlyViewable,
                                                           boolean onlyVisible)
                                                    throws org.apache.jetspeed.page.document.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:

org.apache.jetspeed.page.document.NodeNotFoundException - if not found

SecurityException - if view access not granted

getNodeProxies

public List getNodeProxies(String regexpPath,
                           org.apache.jetspeed.page.document.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

pathRegexpPattern

private static String pathRegexpPattern(String regexp)

pathRegexpPattern - tests for and converts simple path wildcard and character class regular exressions to perl5/standard java pattern syntax

Parameters:

regexp - - candidate path regular expression

Returns:

- converted pattern or null if no regular expression

isProxyViewable

private static boolean isProxyViewable(org.apache.jetspeed.page.document.Node nodeProxy,
                                       boolean onlyVisible)

isProxyViewable - tests for node proxy visibility in view

Parameters:

nodeProxy - test node proxy

onlyVisible - nodes required to be visible

Returns:

- viewable flag

getStandardMenuNames

public Set getStandardMenuNames()

getStandardMenuNames - get set of available standard menu names

Returns:

menu names set

getStandardMenuDefinitionLocators

public List getStandardMenuDefinitionLocators()

getStandardMenuDefinitionLocators - get list of available standard menu definition locators

Returns:

menu definition locators list

getMenuDefinitionLocators

public List getMenuDefinitionLocators(org.apache.jetspeed.page.document.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(org.apache.jetspeed.page.document.Node node,
                                                              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 String getProfileLocatorName(org.apache.jetspeed.page.document.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 org.apache.jetspeed.om.page.Page getManagedPage(org.apache.jetspeed.om.page.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