org.apache.jetspeed.page.document.proxy
Class NodeProxy

java.lang.Object
  org.apache.jetspeed.portalsite.view.SiteViewProxy
      org.apache.jetspeed.page.document.proxy.NodeProxy

Direct Known Subclasses:

FolderProxy, LinkProxy, PageProxy

public abstract class NodeProxy
extends SiteViewProxy

This class proxies Node instances to create a logical view of site content.

Version:

$Id: NodeProxy.java 516448 2007-03-09 16:25:47Z ate $

Author:

Randy Watler

Field Summary

protected static Method	EQUALS_METHOD *_METHOD - Node method constants
protected static Method	GET_PARENT_METHOD
protected static Method	GET_PATH_METHOD
protected static Method	GET_URL_METHOD
protected static Method	HASH_CODE_METHOD
private boolean	hidden hidden - hidden status of this or parent node
protected static Method	IS_HIDDEN_METHOD
private List	menuDefinitionLocators menuDefinitionLocators - menu definitions aggregated by name saved in menu definition locators
private boolean	menuDefinitionLocatorsAggregated menuDefinitionLocatorsAggregated - boolean flag to indicate menuDefinitionLocators aggregated
private List	menuDefinitions menuDefinitions - menu definitions aggregated by name
private boolean	menuDefinitionsAggregated menuDefinitionsAggregated - boolean flag to indicate menuDefinitions aggregated from menuDefinitionLocators
private org.apache.jetspeed.om.folder.Folder	parent parent - view parent proxy folder instance
private String	path path - view path
protected static Method	TO_STRING_METHOD

Constructor Summary

protected

NodeProxy(SiteView view, String locatorName, org.apache.jetspeed.om.folder.Folder parent, String name, boolean hidden) NodeProxy - constructor

Method Summary

protected void	aggregateMenuDefinitionLocators() aggregateMenuDefinitionLocators - aggregate all menu definition locators in site view for this folder or page
boolean	equals(Object object) equals - proxy implementation of Object.equals()
private SiteViewMenuDefinitionLocator	findMenuDefinitionLocator(String name) findMenuDefinitionLocator - find menu definition locator by name
SiteViewMenuDefinitionLocator	getMenuDefinitionLocator(String name) getMenuDefinitionLocator - get menu definition locator by name
List	getMenuDefinitionLocators() getMenuDefinitionLocators - get list of menu definition locators aggregated by name for this folder or page
List	getMenuDefinitions() getMenuDefinitions - proxy implementation of Folder.getMenuDefinitions() and Page.getMenuDefinitions()
static NodeProxy	getNodeProxy(Object node) getNodeProxy - utility method to access NodeProxy handler from Node proxy instance
org.apache.jetspeed.page.document.Node	getParent() getParent - proxy implementation of Node.getParent()
String	getPath() getPath - proxy implementation of Node.getPath()
String	getUrl() getUrl - proxy implementation of Node.getUrl()
int	hashCode() hashCode - proxy implementation of Object.hashCode()
boolean	isHidden() getPath - proxy implementation of Node.isHidden()
private boolean	menuDefinitionLocatorsContains(String name) menuDefinitionLocatorsContains - contains test for menu definition locators by name
protected void	mergeMenuDefinitionLocators(List locators) mergeMenuDefinitionLocators - utilty to merge menu definition locator lists to be used by derived implementations to aggregate menu definition locators
protected void	mergeMenuDefinitionLocators(List definitions, org.apache.jetspeed.page.document.Node node) mergeMenuDefinitionLocators - utilty to merge menu definition locator lists to be used by derived implementations to aggregate menu definition locators
String	toString() toString - proxy implementation of Object.toString()

Methods inherited from class org.apache.jetspeed.portalsite.view.SiteViewProxy

getLocatorName, getSiteViewProxy, getView, reflectMethod

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EQUALS_METHOD

protected static final Method EQUALS_METHOD

*_METHOD - Node method constants

GET_PARENT_METHOD

protected static final Method GET_PARENT_METHOD

GET_PATH_METHOD

protected static final Method GET_PATH_METHOD

GET_URL_METHOD

protected static final Method GET_URL_METHOD

HASH_CODE_METHOD

protected static final Method HASH_CODE_METHOD

IS_HIDDEN_METHOD

protected static final Method IS_HIDDEN_METHOD

TO_STRING_METHOD

protected static final Method TO_STRING_METHOD

parent

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

parent - view parent proxy folder instance

path

private String path

path - view path

hidden

private boolean hidden

hidden - hidden status of this or parent node

menuDefinitionLocators

private List menuDefinitionLocators

menuDefinitionLocators - menu definitions aggregated by name saved in menu definition locators

menuDefinitionLocatorsAggregated

private boolean menuDefinitionLocatorsAggregated

menuDefinitionLocatorsAggregated - boolean flag to indicate menuDefinitionLocators aggregated

menuDefinitions

private List menuDefinitions

menuDefinitions - menu definitions aggregated by name

menuDefinitionsAggregated

private boolean menuDefinitionsAggregated

menuDefinitionsAggregated - boolean flag to indicate menuDefinitions aggregated from menuDefinitionLocators

Constructor Detail

NodeProxy

protected NodeProxy(SiteView view,
                    String locatorName,
                    org.apache.jetspeed.om.folder.Folder parent,
                    String name,
                    boolean hidden)

NodeProxy - constructor

Parameters:

view - site view owner of this proxy

locatorName - profile locator name associated with the derived delegate of this proxy in the site view

parent - view parent proxy folder

name - name of node to proxy

hidden - hidden status of node to proxy

Method Detail

getParent

public org.apache.jetspeed.page.document.Node getParent()

getParent - proxy implementation of Node.getParent()

Returns:

parent folder

getPath

public String getPath()

getPath - proxy implementation of Node.getPath()

Returns:

pages relative path used to identify proxy

isHidden

public boolean isHidden()

getPath - proxy implementation of Node.isHidden()

Returns:

hidden status of node or parent

getUrl

public String getUrl()

getUrl - proxy implementation of Node.getUrl()

Returns:

pages relative url used to navigate to folder

getMenuDefinitions

public List getMenuDefinitions()

getMenuDefinitions - proxy implementation of Folder.getMenuDefinitions() and Page.getMenuDefinitions()

Returns:

definition list

getMenuDefinitionLocators

public List getMenuDefinitionLocators()

getMenuDefinitionLocators - get list of menu definition locators aggregated by name for this folder or page

Returns:

definition locator list

getMenuDefinitionLocator

public SiteViewMenuDefinitionLocator getMenuDefinitionLocator(String name)

getMenuDefinitionLocator - get menu definition locator by name

Parameters:

name - menu definition name

Returns:

menu definition locator

aggregateMenuDefinitionLocators

protected void aggregateMenuDefinitionLocators()

aggregateMenuDefinitionLocators - aggregate all menu definition locators in site view for this folder or page

mergeMenuDefinitionLocators

protected void mergeMenuDefinitionLocators(List definitions,
                                           org.apache.jetspeed.page.document.Node node)

mergeMenuDefinitionLocators - utilty to merge menu definition locator lists to be used by derived implementations to aggregate menu definition locators

Parameters:

definitions - list of menu definitions to merge

node - page or folder node that defines menu definitions

mergeMenuDefinitionLocators

protected void mergeMenuDefinitionLocators(List locators)

mergeMenuDefinitionLocators - utilty to merge menu definition locator lists to be used by derived implementations to aggregate menu definition locators

Parameters:

locators - list of menu definition locators to merge

menuDefinitionLocatorsContains

private boolean menuDefinitionLocatorsContains(String name)

menuDefinitionLocatorsContains - contains test for menu definition locators by name

Parameters:

name - menu definition name

Returns:

contains name result

findMenuDefinitionLocator

private SiteViewMenuDefinitionLocator findMenuDefinitionLocator(String name)

findMenuDefinitionLocator - find menu definition locator by name

Parameters:

name - menu definition name

Returns:

menu definition locator

equals

public boolean equals(Object object)

equals - proxy implementation of Object.equals()

Overrides:

equals in class Object

Parameters:

object - test instance

Returns:

equals test result

toString

public String toString()

toString - proxy implementation of Object.toString()

Overrides:

toString in class Object

Returns:

string representation of proxy path

hashCode

public int hashCode()

hashCode - proxy implementation of Object.hashCode()

Overrides:

hashCode in class Object

Returns:

hash code based on proxy path

getNodeProxy

public static NodeProxy getNodeProxy(Object node)

getNodeProxy - utility method to access NodeProxy handler from Node proxy instance

Parameters:

node - node proxy instance

Returns:

node proxy invocation handler instance