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

java.lang.Object
  extended by org.apache.jetspeed.portalsite.view.SiteViewProxy
      extended by 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 java.lang.reflect.Method EQUALS_METHOD
          *_METHOD - Node method constants
protected static java.lang.reflect.Method GET_PARENT_METHOD
           
protected static java.lang.reflect.Method GET_PATH_METHOD
           
protected static java.lang.reflect.Method GET_URL_METHOD
           
protected static java.lang.reflect.Method HASH_CODE_METHOD
           
protected static java.lang.reflect.Method IS_HIDDEN_METHOD
           
protected static java.lang.reflect.Method TO_STRING_METHOD
           
 
Constructor Summary
protected NodeProxy(SiteView view, java.lang.String locatorName, Folder parent, java.lang.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(java.lang.Object object)
          equals - proxy implementation of Object.equals()
 SiteViewMenuDefinitionLocator getMenuDefinitionLocator(java.lang.String name)
          getMenuDefinitionLocator - get menu definition locator by name
 java.util.List getMenuDefinitionLocators()
          getMenuDefinitionLocators - get list of menu definition locators aggregated by name for this folder or page
 java.util.List getMenuDefinitions()
          getMenuDefinitions - proxy implementation of Folder.getMenuDefinitions() and Page.getMenuDefinitions()
static NodeProxy getNodeProxy(java.lang.Object node)
          getNodeProxy - utility method to access NodeProxy handler from Node proxy instance
 Node getParent()
          getParent - proxy implementation of Node.getParent()
 java.lang.String getPath()
          getPath - proxy implementation of Node.getPath()
 java.lang.String getUrl()
          getUrl - proxy implementation of Node.getUrl()
 int hashCode()
          hashCode - proxy implementation of Object.hashCode()
 boolean isHidden()
          getPath - proxy implementation of Node.isHidden()
protected  void mergeMenuDefinitionLocators(java.util.List locators)
          mergeMenuDefinitionLocators - utilty to merge menu definition locator lists to be used by derived implementations to aggregate menu definition locators
protected  void mergeMenuDefinitionLocators(java.util.List definitions, Node node)
          mergeMenuDefinitionLocators - utilty to merge menu definition locator lists to be used by derived implementations to aggregate menu definition locators
 java.lang.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 java.lang.reflect.Method EQUALS_METHOD
*_METHOD - Node method constants


GET_PARENT_METHOD

protected static final java.lang.reflect.Method GET_PARENT_METHOD

GET_PATH_METHOD

protected static final java.lang.reflect.Method GET_PATH_METHOD

GET_URL_METHOD

protected static final java.lang.reflect.Method GET_URL_METHOD

HASH_CODE_METHOD

protected static final java.lang.reflect.Method HASH_CODE_METHOD

IS_HIDDEN_METHOD

protected static final java.lang.reflect.Method IS_HIDDEN_METHOD

TO_STRING_METHOD

protected static final java.lang.reflect.Method TO_STRING_METHOD
Constructor Detail

NodeProxy

protected NodeProxy(SiteView view,
                    java.lang.String locatorName,
                    Folder parent,
                    java.lang.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 Node getParent()
getParent - proxy implementation of Node.getParent()

Returns:
parent folder

getPath

public java.lang.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 java.lang.String getUrl()
getUrl - proxy implementation of Node.getUrl()

Returns:
pages relative url used to navigate to folder

getMenuDefinitions

public java.util.List getMenuDefinitions()
getMenuDefinitions - proxy implementation of Folder.getMenuDefinitions() and Page.getMenuDefinitions()

Returns:
definition list

getMenuDefinitionLocators

public java.util.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(java.lang.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(java.util.List definitions,
                                           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(java.util.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

equals

public boolean equals(java.lang.Object object)
equals - proxy implementation of Object.equals()

Overrides:
equals in class java.lang.Object
Parameters:
object - test instance
Returns:
equals test result

toString

public java.lang.String toString()
toString - proxy implementation of Object.toString()

Overrides:
toString in class java.lang.Object
Returns:
string representation of proxy path

hashCode

public int hashCode()
hashCode - proxy implementation of Object.hashCode()

Overrides:
hashCode in class java.lang.Object
Returns:
hash code based on proxy path

getNodeProxy

public static NodeProxy getNodeProxy(java.lang.Object node)
getNodeProxy - utility method to access NodeProxy handler from Node proxy instance

Parameters:
node - node proxy instance
Returns:
node proxy invocation handler instance


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.