org.apache.jetspeed.portalsite.view
Class SiteViewMenuDefinitionLocator

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

public class SiteViewMenuDefinitionLocator
extends Object

This class represents a menu definition locator that is comprised of the menu name, (the full definition is saved here from convenience), and concrete path of the defining folder or page.

Version:

$Id: SiteViewMenuDefinitionLocator.java 517121 2007-03-12 07:45:49Z ate $

Author:

Randy Watler

Field Summary

private String	locator locator - locator string defined for menu containing menu name and concrete path of defining node
private org.apache.jetspeed.om.folder.MenuDefinition	menuDefinition menuDefinition - menu definition

Constructor Summary

SiteViewMenuDefinitionLocator(org.apache.jetspeed.om.folder.MenuDefinition menuDefinition)
SiteViewMenuDefinitionLocator - standard menu definition constructor

SiteViewMenuDefinitionLocator(org.apache.jetspeed.om.folder.MenuDefinition menuDefinition, org.apache.jetspeed.page.document.Node definingNode)
SiteViewMenuDefinitionLocator - custom menu definition constructor

Method Summary

boolean	equals(Object obj) equals - compare as string to locator
org.apache.jetspeed.om.folder.MenuDefinition	getMenuDefinition() getMenuDefinition - return menu definition
String	getName() getName - return name of menu definition
int	hashCode() hashCode - return search path hash code
String	toString() toString - return locator

Methods inherited from class java.lang.Object

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

Field Detail

locator

private String locator

locator - locator string defined for menu containing menu name and concrete path of defining node

menuDefinition

private org.apache.jetspeed.om.folder.MenuDefinition menuDefinition

menuDefinition - menu definition

Constructor Detail

SiteViewMenuDefinitionLocator

public SiteViewMenuDefinitionLocator(org.apache.jetspeed.om.folder.MenuDefinition menuDefinition,
                                     org.apache.jetspeed.page.document.Node definingNode)

SiteViewMenuDefinitionLocator - custom menu definition constructor

Parameters:

menuDefinition - custom menu definition

definingNode - defining page or folder

SiteViewMenuDefinitionLocator

public SiteViewMenuDefinitionLocator(org.apache.jetspeed.om.folder.MenuDefinition menuDefinition)

SiteViewMenuDefinitionLocator - standard menu definition constructor

Parameters:

menuDefinition - standard menu definition

Method Detail

toString

public String toString()

toString - return locator

Overrides:

toString in class Object

Returns:

search path

equals

public boolean equals(Object obj)

equals - compare as string to locator

Overrides:

equals in class Object

Returns:

equals result

hashCode

public int hashCode()

hashCode - return search path hash code

Overrides:

hashCode in class Object

Returns:

hash code

getMenuDefinition

public org.apache.jetspeed.om.folder.MenuDefinition getMenuDefinition()

getMenuDefinition - return menu definition

Returns:

menu definition

getName

public String getName()

getName - return name of menu definition

Returns:

menu definition name