org.apache.jetspeed.page.document.psml
Class AbstractNode

java.lang.Object
  org.apache.jetspeed.om.page.psml.AbstractBaseElement
      org.apache.jetspeed.page.document.psml.AbstractNode

All Implemented Interfaces:

java.io.Serializable, SecuredResource, BaseElement, Node

Direct Known Subclasses:

DocumentImpl, FolderImpl

public abstract class AbstractNode
extends AbstractBaseElement
implements Node

AbstractNode

Version:

$Id: AbstractNode.java 551606 2007-06-28 16:07:53Z taylor $

Author:

Scott T. Weaver

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.jetspeed.page.document.Node

PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Constructor Summary

AbstractNode()

Method Summary

void	checkConstraints(java.util.List actions, java.util.List userPrincipals, java.util.List rolePrincipals, java.util.List groupPrincipals, boolean checkNodeOnly, boolean checkParentsOnly) checkConstraints
void	checkPermissions(java.lang.String path, int mask, boolean checkNodeOnly, boolean checkParentsOnly) checkPermissions
PageSecurity	getEffectivePageSecurity() getEffectivePageSecurity
java.lang.String	getLogicalPermissionPath() getLogicalPermissionPath
GenericMetadata	getMetadata() getMetadata - get/construct metadata
java.util.Collection	getMetadataFields() getMetadataFields - get metadata fields collection for marshalling/unmarshalling
java.lang.String	getName() getName
Node	getParent() getParent
Node	getParent(boolean checkAccess) getParent
java.lang.String	getPath() getPath
java.lang.String	getPhysicalPermissionPath() getPhysicalPermissionPath
java.lang.String	getProfiledPath()
java.lang.String	getShortTitle(java.util.Locale locale) getShortTitle
java.lang.String	getTitle(java.util.Locale locale) getTitle
java.lang.String	getTitleName() getTitleName - get name for use as default titles
java.lang.String	getUrl() getUrl
boolean	isDirty()
boolean	isHidden() isHidden
void	setDirty(boolean dirty)
void	setHidden(boolean hidden) setHidden
void	setMetadata(GenericMetadata metadata) setMetadata - set metadata fields
void	setMetadataFields(java.util.Collection metadataFields) setMetadataFields - set metadata fields collection
void	setParent(Node parent) setParent
void	setPath(java.lang.String path) setPath
void	setProfiledPath(java.lang.String profiledPath)
void	setUrl(java.lang.String url) setUrl
void	unmarshalled() unmarshalled - notification that this instance has been loaded from the persistent store

Methods inherited from class org.apache.jetspeed.om.page.psml.AbstractBaseElement

checkAccess, checkAccess, checkConstraints, checkPermissions, checkPermissions, equals, getConstraintsEnabled, getHandlerFactory, getId, getPermissionsEnabled, getSecurityConstraints, getShortTitle, getTitle, grantViewActionAccess, hashCode, marshalling, newSecurityConstraint, newSecurityConstraints, setConstraintsEnabled, setHandlerFactory, setId, setPermissionsEnabled, setSecurityConstraints, setShortTitle, setTitle, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jetspeed.page.document.Node

getType

Methods inherited from interface org.apache.jetspeed.om.page.BaseElement

getId, getShortTitle, getTitle, setShortTitle, setTitle

Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource

checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled, getSecurityConstraints, newSecurityConstraint, newSecurityConstraints, setSecurityConstraints

Constructor Detail

AbstractNode

public AbstractNode()

Method Detail

getMetadata

public GenericMetadata getMetadata()

getMetadata - get/construct metadata

Specified by:

getMetadata in interface Node

Returns:

metadata

setMetadata

public void setMetadata(GenericMetadata metadata)

setMetadata - set metadata fields

Parameters:

metadata - metadata

getMetadataFields

public java.util.Collection getMetadataFields()

getMetadataFields - get metadata fields collection for marshalling/unmarshalling

Returns:

metadata fields collection

setMetadataFields

public void setMetadataFields(java.util.Collection metadataFields)

setMetadataFields - set metadata fields collection

Parameters:

metadataFields - metadata fields collection

getTitle

public java.lang.String getTitle(java.util.Locale locale)

getTitle

Specified by:

getTitle in interface Node

Parameters:

locale -

Returns:

title in specified locale

See Also:

Node.getTitle(java.util.Locale)

getShortTitle

public java.lang.String getShortTitle(java.util.Locale locale)

getShortTitle

Specified by:

getShortTitle in interface Node

Parameters:

locale -

Returns:

short title in specified locale

See Also:

Node.getShortTitle(java.util.Locale)

getParent

public Node getParent(boolean checkAccess)

getParent

Parameters:

checkAccess - flag

Returns:

parent node

getParent

public Node getParent()

getParent

Specified by:

getParent in interface Node

Returns:

parent node

See Also:

Node.getParent()

setParent

public void setParent(Node parent)

setParent

Specified by:

setParent in interface Node

Parameters:

parent -

See Also:

Node.setParent(Node)

getName

public java.lang.String getName()

getName

Specified by:

getName in interface Node

Returns:

Name

See Also:

Node.getName()

getTitleName

public java.lang.String getTitleName()

getTitleName - get name for use as default titles

Returns:

title name

getPath

public java.lang.String getPath()

Description copied from interface: Node

getPath

Specified by:

getPath in interface Node

Returns:

Returns the path.

setPath

public void setPath(java.lang.String path)

setPath

Specified by:

setPath in interface Node

Parameters:

path - The path to set.

getUrl

public java.lang.String getUrl()

getUrl

Same as invoking Node.getPath() unless url explicitly set.

Specified by:

getUrl in interface Node

Returns:

url as string

See Also:

Node.getUrl()

setUrl

public void setUrl(java.lang.String url)

setUrl

Parameters:

url - The url to set.

isHidden

public boolean isHidden()

isHidden

Specified by:

isHidden in interface Node

Returns:

hidden

See Also:

Node.isHidden()

setHidden

public void setHidden(boolean hidden)

Description copied from interface: Node

setHidden

Whether or not this Node should be hidden in terms of the view.

Specified by:

setHidden in interface Node

Parameters:

hidden - The hidden to set.

getProfiledPath

public java.lang.String getProfiledPath()

Returns:

Returns the profiled path.

setProfiledPath

public void setProfiledPath(java.lang.String profiledPath)

Parameters:

profiledPath - The profiled path to set.

getEffectivePageSecurity

public PageSecurity getEffectivePageSecurity()

getEffectivePageSecurity

Overrides:

getEffectivePageSecurity in class AbstractBaseElement

Returns:

effective page security object

See Also:

AbstractBaseElement.getEffectivePageSecurity()

checkConstraints

public void checkConstraints(java.util.List actions,
                             java.util.List userPrincipals,
                             java.util.List rolePrincipals,
                             java.util.List groupPrincipals,
                             boolean checkNodeOnly,
                             boolean checkParentsOnly)
                      throws java.lang.SecurityException

checkConstraints

Overrides:

checkConstraints in class AbstractBaseElement

Parameters:

actions -

userPrincipals -

rolePrincipals -

groupPrincipals -

checkNodeOnly -

checkParentsOnly -

Throws:

java.lang.SecurityException

checkPermissions

public void checkPermissions(java.lang.String path,
                             int mask,
                             boolean checkNodeOnly,
                             boolean checkParentsOnly)
                      throws java.lang.SecurityException

checkPermissions

Overrides:

checkPermissions in class AbstractBaseElement

Parameters:

path -

mask - Mask of actions requested

checkNodeOnly -

checkParentsOnly -

Throws:

java.lang.SecurityException

getLogicalPermissionPath

public java.lang.String getLogicalPermissionPath()

getLogicalPermissionPath

Overrides:

getLogicalPermissionPath in class AbstractBaseElement

Returns:

path used for permissions checks

getPhysicalPermissionPath

public java.lang.String getPhysicalPermissionPath()

getPhysicalPermissionPath

Overrides:

getPhysicalPermissionPath in class AbstractBaseElement

Returns:

path used for permissions checks

unmarshalled

public void unmarshalled()

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

Overrides:

unmarshalled in class AbstractBaseElement

isDirty

public boolean isDirty()

setDirty

public void setDirty(boolean dirty)