org.apache.jetspeed.om.folder.impl
Class FolderImpl

java.lang.Object
  extended by org.apache.jetspeed.om.page.impl.BaseElementImpl
      extended by org.apache.jetspeed.page.document.impl.NodeImpl
          extended by org.apache.jetspeed.om.folder.impl.FolderImpl
All Implemented Interfaces:
SecuredResource, Folder, BaseElement, Node

public class FolderImpl
extends NodeImpl
implements Folder

FolderImpl

Version:
$Id$
Author:
Randy Watler

Field Summary
 
Fields inherited from interface org.apache.jetspeed.om.folder.Folder
COUNTRY_FOLDER, FALLBACK_DEFAULT_PAGE, FOLDER_TYPE, GROUP_FOLDER, LANGUAGE_FOLDER, MEDIATYPE_FOLDER, PAGE_NOT_FOUND_PAGE, RESERVED_COUNTRY_FOLDER_NAME, RESERVED_FOLDER_COUNTRY, RESERVED_FOLDER_GROUPS, RESERVED_FOLDER_LANGUAGE, RESERVED_FOLDER_MEDIATYPE, RESERVED_FOLDER_NONE, RESERVED_FOLDER_OTHER, RESERVED_FOLDER_PREFIX, RESERVED_FOLDER_ROLES, RESERVED_FOLDER_SUBSITES, RESERVED_FOLDER_USERS, RESERVED_GROUP_FOLDER_NAME, RESERVED_LANGUAGE_FOLDER_NAME, RESERVED_MEDIATYPE_FOLDER_NAME, RESERVED_ROLE_FOLDER_NAME, RESERVED_SUBSITE_FOLDER_PREFIX, RESERVED_USER_FOLDER_NAME, ROLE_FOLDER, USER_FOLDER
 
Fields inherited from interface org.apache.jetspeed.page.document.Node
PATH_SEPARATOR, PATH_SEPARATOR_CHAR
 
Constructor Summary
FolderImpl()
           
 
Method Summary
 java.util.List accessAll()
          accessAll Access all transient cache collection for use by PageManager.
 java.util.List accessFolders()
          accessFolders Access folders transient cache collection for use by PageManager.
 java.util.List accessLinks()
          accessLinks Access links transient cache collection for use by PageManager.
 java.util.List accessPages()
          accessPages Access pages transient cache collection for use by PageManager.
 PageSecurityImpl accessPageSecurity()
          accessPageSecurity Access pageSecurity cached instance for use by PageManager.
 void checkPermissions(java.lang.String path, int mask, boolean checkNodeOnly, boolean checkParentsOnly)
          checkPermissions
 NodeSet getAll()
           getAll
 java.lang.String getDefaultDecorator(java.lang.String fragmentType)
          Returns the name of the default decorator that applies to page fragments in this folder or subfolders.
 java.lang.String getDefaultPage()
           getDefaultPage
 java.util.List getDocumentOrder()
          getDocumentOrder
 java.lang.String getEffectiveDefaultDecorator(java.lang.String fragmentType)
          Returns the name of the default decorator as set here or in parent folders that applies to page fragments in this folder or subfolders.
 PageSecurity getEffectivePageSecurity()
          getEffectivePageSecurity
 Folder getFolder(java.lang.String name)
           getFolder
 NodeSet getFolders()
           getFolders
 Link getLink(java.lang.String name)
           getLink
 NodeSet getLinks()
           getLinks
 java.util.List getMenuDefinitions()
          getMenuDefinitions - get list of menu definitions
 Page getPage(java.lang.String name)
           getPage
 PageManager getPageManager()
           
 NodeSet getPages()
           getPages
 PageSecurity getPageSecurity()
           getPageSecurity
 int getReservedType()
          Returns a valid reserved folder type: RESERVED_FOLDER_SUBSITES RESERVED_FOLDER_USERS RESERVED_FOLDER_ROLES RESERVED_FOLDER_GROUPS RESERVED_FOLDER_MEDIATYPE RESERVED_FOLDER_LANGUAGE RESERVED_FOLDER_COUNTRY
 java.lang.String getSkin()
          Returns the name of the skin that applies to this folder.
 java.lang.String getTitle()
          Returns the title in the default Locale
 java.lang.String getType()
           getType
 boolean isReserved()
          Determines if a folder is a reserved folder.
 MenuDefinition newMenuDefinition()
          newMenuDefinition - creates a new empty menu definition
 MenuExcludeDefinition newMenuExcludeDefinition()
          newMenuExcludeDefinition - creates a new empty menu exclude definition
 MenuIncludeDefinition newMenuIncludeDefinition()
          newMenuIncludeDefinition - creates a new empty menu include definition
 MenuOptionsDefinition newMenuOptionsDefinition()
          newMenuOptionsDefinition - creates a new empty menu options definition
 MenuSeparatorDefinition newMenuSeparatorDefinition()
          newMenuSeparatorDefinition - creates a new empty menu separator definition
 PageMetadataImpl newPageMetadata(java.util.Collection fields)
          newPageMetadata Construct page manager specific metadata implementation.
 void resetAll(boolean cached)
          resetAll Reset all transient caches for use by PageManager.
 void resetFolders(boolean cached)
          resetFolders Reset folders transient caches for use by PageManager.
 void resetLinks(boolean cached)
          resetLinks Reset links transient caches for use by PageManager.
 void resetPages(boolean cached)
          resetPages Reset pages transient caches for use by PageManager.
 void resetPageSecurity(PageSecurityImpl newPageSecurity, boolean cached)
          resetPageSecurity Reset pageSecurity transient cache instance for use by PageManager.
 void setDefaultDecorator(java.lang.String decoratorName, java.lang.String fragmentType)
          Modifies the default decorator for the specified fragment type.
 void setDefaultPage(java.lang.String defaultPage)
           setDefaultPage
 void setDocumentOrder(java.util.List docNames)
          setDocumentOrder
 void setMenuDefinitions(java.util.List definitions)
          setMenuDefinitions - set list of menu definitions
 void setPageManager(PageManager pageManager)
          setPageManager Infuses PageManager for use by this folder instance.
 void setSkin(java.lang.String skinName)
          Modifies the skin for this folder.
 
Methods inherited from class org.apache.jetspeed.page.document.impl.NodeImpl
checkConstraints, defaultTitleFromName, getCanonicalNodePath, getLogicalPermissionPath, getMetadata, getName, getPageMetadata, getParent, getPath, getPhysicalPermissionPath, getShortTitle, getTitle, getUrl, isHidden, setHidden, setName, setParent, setPath
 
Methods inherited from class org.apache.jetspeed.om.page.impl.BaseElementImpl
checkAccess, checkConstraints, checkPermissions, checkPermissions, equals, getConstraintsEnabled, getId, getPermissionsEnabled, getSecurityConstraints, getShortTitle, grantViewActionAccess, hashCode, newSecurityConstraint, newSecurityConstraints, resetCachedSecurityConstraints, setConstraintsEnabled, setPermissionsEnabled, setSecurityConstraints, setShortTitle, setTitle
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.page.document.Node
getMetadata, getName, getParent, getPath, getShortTitle, getTitle, getUrl, isHidden, setHidden, setParent, setPath
 
Methods inherited from interface org.apache.jetspeed.om.page.BaseElement
getId, getShortTitle, setShortTitle, setTitle
 
Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource
checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, newSecurityConstraint, newSecurityConstraints, setSecurityConstraints
 

Constructor Detail

FolderImpl

public FolderImpl()
Method Detail

setPageManager

public void setPageManager(PageManager pageManager)
setPageManager Infuses PageManager for use by this folder instance.

Parameters:
pageManager - page manager that manages this folder instance

accessFolders

public java.util.List accessFolders()
accessFolders Access folders transient cache collection for use by PageManager.

Returns:
folders collection

resetFolders

public void resetFolders(boolean cached)
resetFolders Reset folders transient caches for use by PageManager.

Parameters:
cached - set cached state for folders

accessPages

public java.util.List accessPages()
accessPages Access pages transient cache collection for use by PageManager.

Returns:
pages collection

resetPages

public void resetPages(boolean cached)
resetPages Reset pages transient caches for use by PageManager.

Parameters:
cached - set cached state for pages

accessLinks

public java.util.List accessLinks()
accessLinks Access links transient cache collection for use by PageManager.

Returns:
links collection

resetLinks

public void resetLinks(boolean cached)
resetLinks Reset links transient caches for use by PageManager.

Parameters:
cached - set cached state for links

accessPageSecurity

public PageSecurityImpl accessPageSecurity()
accessPageSecurity Access pageSecurity cached instance for use by PageManager.

Returns:
pageSecurity instance

resetPageSecurity

public void resetPageSecurity(PageSecurityImpl newPageSecurity,
                              boolean cached)
resetPageSecurity Reset pageSecurity transient cache instance for use by PageManager.

Parameters:
newPageSecurty - cached page security instance.
cached - set cached state for page security

accessAll

public java.util.List accessAll()
accessAll Access all transient cache collection for use by PageManager.

Returns:
all collection

resetAll

public void resetAll(boolean cached)
resetAll Reset all transient caches for use by PageManager.

Parameters:
cached - set cached state for all

newPageMetadata

public PageMetadataImpl newPageMetadata(java.util.Collection fields)
Description copied from class: NodeImpl
newPageMetadata Construct page manager specific metadata implementation.

Overrides:
newPageMetadata in class NodeImpl
Parameters:
fields - mutable fields collection
Returns:
page metadata

getEffectivePageSecurity

public PageSecurity getEffectivePageSecurity()
Description copied from class: BaseElementImpl
getEffectivePageSecurity

Overrides:
getEffectivePageSecurity in class NodeImpl
Returns:
effective page security object

checkPermissions

public void checkPermissions(java.lang.String path,
                             int mask,
                             boolean checkNodeOnly,
                             boolean checkParentsOnly)
                      throws java.lang.SecurityException
Description copied from class: BaseElementImpl
checkPermissions

Overrides:
checkPermissions in class NodeImpl
Parameters:
path - permissions path to check
mask - mask of actions to check
checkNodeOnly - check node scope only
checkParentsOnly - check parent folder scope only
Throws:
java.lang.SecurityException

getTitle

public java.lang.String getTitle()
Description copied from interface: BaseElement
Returns the title in the default Locale

Specified by:
getTitle in interface BaseElement
Overrides:
getTitle in class BaseElementImpl
Returns:
the page title

getSkin

public java.lang.String getSkin()
Description copied from interface: Folder
Returns the name of the skin that applies to this folder.

Specified by:
getSkin in interface Folder
Returns:
the page default skin name

setSkin

public void setSkin(java.lang.String skinName)
Description copied from interface: Folder
Modifies the skin for this folder.

Specified by:
setSkin in interface Folder
Parameters:
skinName - the name of the new skin for the folder

getEffectiveDefaultDecorator

public java.lang.String getEffectiveDefaultDecorator(java.lang.String fragmentType)
Description copied from interface: Folder
Returns the name of the default decorator as set here or in parent folders that applies to page fragments in this folder or subfolders.

Specified by:
getEffectiveDefaultDecorator in interface Folder
Parameters:
fragmentType - the type of fragment considered
Returns:
the decorator name for the selected type

getDefaultDecorator

public java.lang.String getDefaultDecorator(java.lang.String fragmentType)
Description copied from interface: Folder
Returns the name of the default decorator that applies to page fragments in this folder or subfolders.

Specified by:
getDefaultDecorator in interface Folder
Parameters:
fragmentType - the type of fragment considered
Returns:
the decorator name for the selected type

setDefaultDecorator

public void setDefaultDecorator(java.lang.String decoratorName,
                                java.lang.String fragmentType)
Description copied from interface: Folder
Modifies the default decorator for the specified fragment type.

Specified by:
setDefaultDecorator in interface Folder
Parameters:
decoratorName - the name of the new decorator for the type
fragmentType - the type of fragment considered

getDocumentOrder

public java.util.List getDocumentOrder()
Description copied from interface: Folder
getDocumentOrder

Specified by:
getDocumentOrder in interface Folder
Returns:
list of ordered document names in folder

setDocumentOrder

public void setDocumentOrder(java.util.List docNames)
Description copied from interface: Folder
setDocumentOrder

Specified by:
setDocumentOrder in interface Folder
Parameters:
docNames - list of ordered document names in folder

getDefaultPage

public java.lang.String getDefaultPage()
Description copied from interface: Folder

getDefaultPage

Specified by:
getDefaultPage in interface Folder
Returns:
A String representing the default psml page for this folder

setDefaultPage

public void setDefaultPage(java.lang.String defaultPage)
Description copied from interface: Folder

setDefaultPage

Specified by:
setDefaultPage in interface Folder

getFolders

public NodeSet getFolders()
                   throws DocumentException
Description copied from interface: Folder

getFolders

Specified by:
getFolders in interface Folder
Returns:
A NodeSet containing all sub-folders directly under this folder.
Throws:
DocumentException

getFolder

public Folder getFolder(java.lang.String name)
                 throws FolderNotFoundException,
                        DocumentException
Description copied from interface: Folder

getFolder

Specified by:
getFolder in interface Folder
Returns:
A Folder referenced by this folder.
Throws:
FolderNotFoundException
DocumentException

getPages

public NodeSet getPages()
                 throws NodeException
Description copied from interface: Folder

getPages

Specified by:
getPages in interface Folder
Returns:
NodeSet of all the Pages referenced by this Folder.
Throws:
NodeException

getPage

public Page getPage(java.lang.String name)
             throws PageNotFoundException,
                    NodeException
Description copied from interface: Folder

getPage

Specified by:
getPage in interface Folder
Returns:
A Page referenced by this folder.
Throws:
PageNotFoundException - if the Page requested could not be found.
DocumentException
NodeException

getLinks

public NodeSet getLinks()
                 throws NodeException
Description copied from interface: Folder

getLinks

Specified by:
getLinks in interface Folder
Returns:
NodeSet of all the Links referenced by this Folder.
Throws:
DocumentException
NodeException

getLink

public Link getLink(java.lang.String name)
             throws DocumentNotFoundException,
                    NodeException
Description copied from interface: Folder

getLink

Specified by:
getLink in interface Folder
Returns:
A Link referenced by this folder.
Throws:
DocumentNotFoundException - if the document requested could not be found.
NodeException

getPageSecurity

public PageSecurity getPageSecurity()
                             throws DocumentNotFoundException,
                                    NodeException
Description copied from interface: Folder

getPageSecurity

Specified by:
getPageSecurity in interface Folder
Returns:
A PageSecurity referenced by this folder.
Throws:
DocumentNotFoundException - if the document requested could not be found.
NodeException

getAll

public NodeSet getAll()
               throws DocumentException
Description copied from interface: Folder

getAll

Specified by:
getAll in interface Folder
Returns:
A NodeSet containing all sub-folders and documents directly under this folder.
Throws:
DocumentException

getMenuDefinitions

public java.util.List getMenuDefinitions()
Description copied from interface: Folder
getMenuDefinitions - get list of menu definitions

Specified by:
getMenuDefinitions in interface Folder
Returns:
definition list

newMenuDefinition

public MenuDefinition newMenuDefinition()
Description copied from interface: Folder
newMenuDefinition - creates a new empty menu definition

Specified by:
newMenuDefinition in interface Folder
Returns:
a newly created MenuDefinition object for use in Folder

newMenuExcludeDefinition

public MenuExcludeDefinition newMenuExcludeDefinition()
Description copied from interface: Folder
newMenuExcludeDefinition - creates a new empty menu exclude definition

Specified by:
newMenuExcludeDefinition in interface Folder
Returns:
a newly created MenuExcludeDefinition object for use in Folder

newMenuIncludeDefinition

public MenuIncludeDefinition newMenuIncludeDefinition()
Description copied from interface: Folder
newMenuIncludeDefinition - creates a new empty menu include definition

Specified by:
newMenuIncludeDefinition in interface Folder
Returns:
a newly created MenuIncludeDefinition object for use in Folder

newMenuOptionsDefinition

public MenuOptionsDefinition newMenuOptionsDefinition()
Description copied from interface: Folder
newMenuOptionsDefinition - creates a new empty menu options definition

Specified by:
newMenuOptionsDefinition in interface Folder
Returns:
a newly created MenuOptionsDefinition object for use in Folder

newMenuSeparatorDefinition

public MenuSeparatorDefinition newMenuSeparatorDefinition()
Description copied from interface: Folder
newMenuSeparatorDefinition - creates a new empty menu separator definition

Specified by:
newMenuSeparatorDefinition in interface Folder
Returns:
a newly created MenuSeparatorDefinition object for use in Folder

setMenuDefinitions

public void setMenuDefinitions(java.util.List definitions)
Description copied from interface: Folder
setMenuDefinitions - set list of menu definitions

Specified by:
setMenuDefinitions in interface Folder
Parameters:
definitions - definition list

isReserved

public boolean isReserved()
Description copied from interface: Folder
Determines if a folder is a reserved folder. Reserved folders are special folders that can hold subsites, the root of user folders, and the root of role folders.

Specified by:
isReserved in interface Folder
Returns:

getReservedType

public int getReservedType()
Description copied from interface: Folder
Returns a valid reserved folder type: RESERVED_FOLDER_SUBSITES RESERVED_FOLDER_USERS RESERVED_FOLDER_ROLES RESERVED_FOLDER_GROUPS RESERVED_FOLDER_MEDIATYPE RESERVED_FOLDER_LANGUAGE RESERVED_FOLDER_COUNTRY

Specified by:
getReservedType in interface Folder
Returns:
one of the valid reserved folder types

getType

public java.lang.String getType()
Description copied from interface: Node

getType

Specified by:
getType in interface Node
Specified by:
getType in class NodeImpl
Returns:

getPageManager

public PageManager getPageManager()


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