org.apache.jetspeed.om.folder.psml
Class MenuDefinitionImpl

java.lang.Object
  org.apache.jetspeed.om.folder.psml.MenuMetadataImpl
      org.apache.jetspeed.om.folder.psml.MenuDefinitionImpl

All Implemented Interfaces:

org.apache.jetspeed.om.folder.MenuDefinition

public class MenuDefinitionImpl
extends MenuMetadataImpl
implements org.apache.jetspeed.om.folder.MenuDefinition

This class implements the MenuDefinition interface in a persistent object form for use by the page manager component.

Version:

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

Author:

Randy Watler

Field Summary

private int	depth depth - depth of inclusion for folder options
private List	menuElementImpls menuElementImpls - ordered homogeneous list of menu elements
private List	menuElements menuElements - ordered polymorphic list of menu options nested menu, separator, include, and exclude definitions
private String	name name - name of menu definition
private String	options options - comma separated option paths specification for menu
private String	order order - comma separated list of ordering patterns for options
private boolean	paths paths - generate ordered path options for options
private String	profile profile - profile locator name filter for options
private boolean	regexp regexp - interpret specified optionsas regexp
private String	shortTitle shortTitle - short title for menu
private String	skin skin - skin name for menu
private String	title title - title for menu

Fields inherited from interface org.apache.jetspeed.om.folder.MenuDefinition

ANY_PROFILE_LOCATOR

Constructor Summary

MenuDefinitionImpl()
MenuDefinitionImpl - constructor

Method Summary

int	getDepth() getDepth - get depth of inclusion for folder menu options
List	getMenuElementImpls() getMenuElementImpls - get ordered list of wrapped menu elements
List	getMenuElements() getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements
String	getName() getName - get menu name
String	getOptions() getOptions - get comma separated menu options if not specified as elements
String	getOrder() getOrder - get comma separated regexp ordering patterns for options
String	getProfile() getProfile - get profile locator used to filter specified options
String	getShortTitle() getShortTitle - get default short title for menu
String	getSkin() getSkin - get skin name for menu
String	getTitle() getTitle - get default title for menu
boolean	isPaths() isPaths - get generate ordered path options for specified options
boolean	isRegexp() isRegexp - get regexp flag for interpreting specified options
void	marshalling() marshalling - notification that this instance is to be saved to the persistent store
void	setDepth(int depth) setDepth - set depth of inclusion for folder menu options
void	setMenuElementImpls(List elements) setMenuElementImpls - set ordered list of menu elements using a list of wrapped menu elements
void	setMenuElements(List elements) setMenuElements - set ordered list of menu elements
void	setName(String name) setName - set menu name
void	setOptions(String options) setOptions - set comma separated menu options if not specified as elements
void	setOrder(String order) setOrder - set comma separated regexp ordering patterns for options
void	setPaths(boolean paths) setPaths - set generate ordered path options for specified options
void	setProfile(String locatorName) setProfile - set profile locator used to filter specified options
void	setRegexp(boolean regexp) setRegexp - set regexp flag for interpreting specified options
void	setShortTitle(String title) setShortTitle - set default short title for menu
void	setSkin(String name) setSkin - set skin name for menu
void	setTitle(String title) setTitle - set default title for menu
void	unmarshalled() unmarshalled - notification that this instance has been loaded from the persistent store

Methods inherited from class org.apache.jetspeed.om.folder.psml.MenuMetadataImpl

getMetadata, getMetadataFields, getShortTitle, getText, getText, getTitle, setMetadataFields

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jetspeed.om.folder.MenuDefinition

getMetadata, getShortTitle, getTitle

Field Detail

name

private String name

name - name of menu definition

options

private String options

options - comma separated option paths specification for menu

depth

private int depth

depth - depth of inclusion for folder options

paths

private boolean paths

paths - generate ordered path options for options

regexp

private boolean regexp

regexp - interpret specified optionsas regexp

profile

private String profile

profile - profile locator name filter for options

order

private String order

order - comma separated list of ordering patterns for options

skin

private String skin

skin - skin name for menu

title

private String title

title - title for menu

shortTitle

private String shortTitle

shortTitle - short title for menu

menuElements

private List menuElements

menuElements - ordered polymorphic list of menu options nested menu, separator, include, and exclude definitions

menuElementImpls

private List menuElementImpls

menuElementImpls - ordered homogeneous list of menu elements

Constructor Detail

MenuDefinitionImpl

public MenuDefinitionImpl()

MenuDefinitionImpl - constructor

Method Detail

getName

public String getName()

getName - get menu name

Specified by:

getName in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

menu name

setName

public void setName(String name)

setName - set menu name

Specified by:

setName in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

name - menu name

getOptions

public String getOptions()

getOptions - get comma separated menu options if not specified as elements

Specified by:

getOptions in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

option paths specification

setOptions

public void setOptions(String options)

setOptions - set comma separated menu options if not specified as elements

Specified by:

setOptions in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

options - option paths specification

getDepth

public int getDepth()

getDepth - get depth of inclusion for folder menu options

Specified by:

getDepth in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

inclusion depth

setDepth

public void setDepth(int depth)

setDepth - set depth of inclusion for folder menu options

Specified by:

setDepth in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

depth - inclusion depth

isPaths

public boolean isPaths()

isPaths - get generate ordered path options for specified options

Specified by:

isPaths in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

paths options flag

setPaths

public void setPaths(boolean paths)

setPaths - set generate ordered path options for specified options

Specified by:

setPaths in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

paths - paths options flag

isRegexp

public boolean isRegexp()

isRegexp - get regexp flag for interpreting specified options

Specified by:

isRegexp in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

regexp flag

setRegexp

public void setRegexp(boolean regexp)

setRegexp - set regexp flag for interpreting specified options

Specified by:

setRegexp in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

regexp - regexp flag

getProfile

public String getProfile()

getProfile - get profile locator used to filter specified options

Specified by:

getProfile in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

profile locator name

setProfile

public void setProfile(String locatorName)

setProfile - set profile locator used to filter specified options

Specified by:

setProfile in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

locatorName - profile locator name

getOrder

public String getOrder()

getOrder - get comma separated regexp ordering patterns for options

Specified by:

getOrder in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

ordering patterns list

setOrder

public void setOrder(String order)

setOrder - set comma separated regexp ordering patterns for options

Specified by:

setOrder in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

order - ordering patterns list

getSkin

public String getSkin()

getSkin - get skin name for menu

Specified by:

getSkin in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

skin name

setSkin

public void setSkin(String name)

setSkin - set skin name for menu

Specified by:

setSkin in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

name - skin name

getTitle

public String getTitle()

getTitle - get default title for menu

Specified by:

getTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Overrides:

getTitle in class MenuMetadataImpl

Returns:

title text

setTitle

public void setTitle(String title)

setTitle - set default title for menu

Specified by:

setTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

title - title text

getShortTitle

public String getShortTitle()

getShortTitle - get default short title for menu

Specified by:

getShortTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Overrides:

getShortTitle in class MenuMetadataImpl

Returns:

short title text

setShortTitle

public void setShortTitle(String title)

setShortTitle - set default short title for menu

Specified by:

setShortTitle in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

title - short title text

getMenuElements

public List getMenuElements()

getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements

Specified by:

getMenuElements in interface org.apache.jetspeed.om.folder.MenuDefinition

Returns:

element list

setMenuElements

public void setMenuElements(List elements)

setMenuElements - set ordered list of menu elements

Specified by:

setMenuElements in interface org.apache.jetspeed.om.folder.MenuDefinition

Parameters:

elements - element list

getMenuElementImpls

public List getMenuElementImpls()

getMenuElementImpls - get ordered list of wrapped menu elements

Returns:

element list

setMenuElementImpls

public void setMenuElementImpls(List elements)

setMenuElementImpls - set ordered list of menu elements using a list of wrapped menu elements

Parameters:

elements - element list

unmarshalled

public void unmarshalled()

unmarshalled - notification that this instance has been loaded from the persistent store

Overrides:

unmarshalled in class MenuMetadataImpl

marshalling

public void marshalling()

marshalling - notification that this instance is to be saved to the persistent store