org.ametys.web.repository.page.jcr

Class DefaultPage<F extends DefaultPageFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>

org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject<F>

org.ametys.web.repository.page.jcr.DefaultPage<F>

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

TagAwareAmetysObject, TaggableAmetysObject, ACLAmetysObject, AmetysObject, CopiableAmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, MovableAmetysObject, RemovableAmetysObject, TraversableAmetysObject, MetadataAwarePagesContainer, ModifiablePage, MoveablePage, Page, PagesContainer, SiteAwareAmetysObject

public class DefaultPage<F extends DefaultPageFactory>
extends DefaultTraversableAmetysObject<F>
implements ModifiablePage, CopiableAmetysObject, MoveablePage

Page implementation stored into a JCR node using ametys:defaultPage node type.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.web.repository.page.Page

Page.LinkType, Page.PageType

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTACHMENTS_NODE_NAME Constant for the attachment node name.
static String	METADATA_LONG_TITLE Constant for long title metadata.
static String	METADATA_PUBLICATION_END_DATE Constant for publication end date metadata.
static String	METADATA_PUBLICATION_START_DATE Constant for publication start date metadata.
static String	METADATA_REFERERS Constant for referers metadata.
static String	METADATA_ROBOTS_DISALLOW Constant for robots metadata.
static String	METADATA_SITE Constants for site Metadata*
static String	METADATA_SITEMAP Constants for sitemap Metadata*
static String	METADATA_TEMPLATE Constant for template metadata.
static String	METADATA_TITLE Constant for title metadata.
static String	METADATA_TYPE Constant for title metadata.
static String	METADATA_URL Constant for title metadata.
static String	METADATA_URLTYPE Constant for title metadata.
static String	METADATA_VISIBLE Constant for the visible attribute.
static String	ZONE_NODE_TYPE Constant for the zone node type.
static String	ZONES_NODE_NAME Constant for the zones node name.
static String	ZONES_NODE_TYPE Constant for the zones node type.

Constructor Summary

Constructors

Constructor and Description
DefaultPage(Node node, String parentPath, F factory) Creates a DefaultPage.

Method Summary

Modifier and Type	Method and Description
void	addReferer(String ametysObjectId) Add a new AmetysObject referencing this page.
boolean	canMoveTo(AmetysObject newParent) Test if a move can be a success or if it is impossible (e.g.
DefaultPage	copyTo(ModifiableTraversableAmetysObject parent, String name) Copy the current AmetysObject to the given object.
DefaultPage	copyTo(ModifiableTraversableAmetysObject parent, String name, List<String> restrictTo) Copy the current AmetysObject to the given object if it is not in the restriction list.
ModifiableZone	createZone(String name) Creates a given zone.
Page	getChildPageAt(int index) Gets the child Page at the given position
AmetysObjectIterable<? extends Page>	getChildrenPages() Retrieves child pages.
AmetysObjectIterable<? extends Page>	getChildrenPages(boolean includeInvisiblePage) Retrieves child pages.
int	getDepth() Get the page depth
String	getLongTitle() Retrieves the long title.
String	getPathInSitemap() Computes the path relative to the current sitemap.
Set<String>	getReferers() Retrieves all AmetysObject ids referencing this page.
ResourceCollection	getRootAttachments() Retrieves the attachments root node
Site	getSite() Returns this object's site.
Sitemap	getSitemap() Retrieves the sitemap containing the current sitemap.
String	getSitemapName() Returns this page's sitemap name
String	getSiteName() Returns this object's site name.
Set<String>	getTags() Retrieves current tags.
String	getTemplate() Retrieves the template name.
String	getTitle() Retrieves the title.
Page.PageType	getType() Retrieves the type.
String	getURL() Retrieves the linked URL.
Page.LinkType	getURLType() Retrieves the linked URL type.
ModifiableZone	getZone(String name) Retrieves a given zone.
AmetysObjectIterable<ModifiableZone>	getZones() Retrieves the zones.
boolean	hasZone(String name) Determine if a zone exists
boolean	isVisible() Determine if the page is visible into navigation elements
void	moveTo(AmetysObject newParent, boolean renameIfExist) Move the current object as a new child of the given object.
void	orderBefore(AmetysObject siblingNode) Order a node before another sibling node (or as the last node)
void	removeReferer(String ametysObjectId) Removes an AmetysObject referencing this page.
void	setLongTitle(String title) Set the long title.
void	setSitemapName(String sitemapName) Set the sitemap name.
void	setSiteName(String siteName) Set the site name.
void	setTemplate(String template) Set the template name.
void	setTitle(String title) Set the title.
void	setType(Page.PageType type) Set the type.
void	setURL(Page.LinkType type, String url) Set the linked URL.
void	setVisible(boolean isVisible) Set the visibility of the page
void	tag(String tag) Tags.
void	untag(String tag) Untags.

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, createChild, getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getChild, getChildren, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers, hasChild, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.repository.metadata.MetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChild, getChildAt, getChildPosition, getChildren, hasChild

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.ModifiableTraversableAmetysObject

createChild

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Field Detail

METADATA_TITLE

public static final String METADATA_TITLE

Constant for title metadata.

See Also:

Constant Field Values

METADATA_LONG_TITLE

public static final String METADATA_LONG_TITLE

Constant for long title metadata.

See Also:

Constant Field Values

METADATA_TYPE

public static final String METADATA_TYPE

Constant for title metadata.

See Also:

Constant Field Values

METADATA_URL

public static final String METADATA_URL

Constant for title metadata.

See Also:

Constant Field Values

METADATA_URLTYPE

public static final String METADATA_URLTYPE

Constant for title metadata.

See Also:

Constant Field Values

METADATA_TEMPLATE

public static final String METADATA_TEMPLATE

Constant for template metadata.

See Also:

Constant Field Values

METADATA_REFERERS

public static final String METADATA_REFERERS

Constant for referers metadata.

See Also:

Constant Field Values

METADATA_VISIBLE

public static final String METADATA_VISIBLE

Constant for the visible attribute.

See Also:

Constant Field Values

METADATA_ROBOTS_DISALLOW

public static final String METADATA_ROBOTS_DISALLOW

Constant for robots metadata.

See Also:

Constant Field Values

ZONES_NODE_NAME

public static final String ZONES_NODE_NAME

Constant for the zones node name.

See Also:

Constant Field Values

ZONES_NODE_TYPE

public static final String ZONES_NODE_TYPE

Constant for the zones node type.

See Also:

Constant Field Values

ZONE_NODE_TYPE

public static final String ZONE_NODE_TYPE

Constant for the zone node type.

See Also:

Constant Field Values

ATTACHMENTS_NODE_NAME

public static final String ATTACHMENTS_NODE_NAME

Constant for the attachment node name.

See Also:

Constant Field Values

METADATA_SITE

public static final String METADATA_SITE

Constants for site Metadata*

See Also:

Constant Field Values

METADATA_SITEMAP

public static final String METADATA_SITEMAP

Constants for sitemap Metadata*

See Also:

Constant Field Values

METADATA_PUBLICATION_START_DATE

public static final String METADATA_PUBLICATION_START_DATE

Constant for publication start date metadata.

See Also:

Constant Field Values

METADATA_PUBLICATION_END_DATE

public static final String METADATA_PUBLICATION_END_DATE

Constant for publication end date metadata.

See Also:

Constant Field Values

Constructor Detail

DefaultPage

public DefaultPage(Node node,
                   String parentPath,
                   F factory)

Creates a DefaultPage.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the DefaultPageFactory which creates the AmetysObject.

Method Detail

getTags

public Set<String> getTags()
                    throws AmetysRepositoryException

Description copied from interface: TagAwareAmetysObject

Retrieves current tags.

Specified by:

getTags in interface TagAwareAmetysObject

Returns:

the current tags.

Throws:

AmetysRepositoryException - if an error occurs.

tag

public void tag(String tag)
         throws AmetysRepositoryException

Description copied from interface: TaggableAmetysObject

Tags.

Specified by:

tag in interface TaggableAmetysObject

Parameters:

tag - the tag to add.

Throws:

AmetysRepositoryException - if an error occurs.

untag

public void untag(String tag)
           throws AmetysRepositoryException

Description copied from interface: TaggableAmetysObject

Untags.

Specified by:

untag in interface TaggableAmetysObject

Parameters:

tag - the tag to remove.

Throws:

AmetysRepositoryException - if an error occurs.

getTitle

public String getTitle()
                throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the title.

Specified by:

getTitle in interface Page

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

setTitle

public void setTitle(String title)
              throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Set the title.

Specified by:

setTitle in interface ModifiablePage

Parameters:

title - the title.

Throws:

AmetysRepositoryException - if an error occurs.

getLongTitle

public String getLongTitle()
                    throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the long title.

Specified by:

getLongTitle in interface Page

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

setLongTitle

public void setLongTitle(String title)
                  throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Set the long title.

Specified by:

setLongTitle in interface ModifiablePage

Parameters:

title - the title.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemap

public Sitemap getSitemap()
                   throws AmetysRepositoryException

Description copied from interface: PagesContainer

Retrieves the sitemap containing the current sitemap.

Specified by:

getSitemap in interface PagesContainer

Returns:

the sitemap containing the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getDepth

public int getDepth()
             throws AmetysRepositoryException

Description copied from interface: Page

Get the page depth

Specified by:

getDepth in interface Page

Returns:

the page depth

Throws:

AmetysRepositoryException - if an error occurs.

getSite

public Site getSite()
             throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site.

Specified by:

getSite in interface SiteAwareAmetysObject

Returns:

this object's site

Throws:

AmetysRepositoryException - if an error occurs.

getSiteName

public String getSiteName()

Description copied from interface: SiteAwareAmetysObject

Returns this object's site name.

Specified by:

getSiteName in interface SiteAwareAmetysObject

Returns:

this object's site name.

setSiteName

public void setSiteName(String siteName)

Description copied from interface: ModifiablePage

Set the site name.

Specified by:

setSiteName in interface ModifiablePage

Parameters:

siteName - the site name.

getSitemapName

public String getSitemapName()
                      throws AmetysRepositoryException

Description copied from interface: PagesContainer

Returns this page's sitemap name

Specified by:

getSitemapName in interface PagesContainer

Returns:

this page's sitemap name

Throws:

AmetysRepositoryException - if an error occurs.

setSitemapName

public void setSitemapName(String sitemapName)
                    throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Set the sitemap name.

Specified by:

setSitemapName in interface ModifiablePage

Parameters:

sitemapName - the sitemap name.

Throws:

AmetysRepositoryException - if an error occurs.

getPathInSitemap

public String getPathInSitemap()
                        throws AmetysRepositoryException

Description copied from interface: PagesContainer

Computes the path relative to the current sitemap.

Specified by:

getPathInSitemap in interface PagesContainer

Returns:

the path relative to the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getType

public Page.PageType getType()
                      throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the type.

Specified by:

getType in interface Page

Returns:

the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

Page.PageType

setType

public void setType(Page.PageType type)
             throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Set the type.

Specified by:

setType in interface ModifiablePage

Parameters:

type - the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

Page.PageType

getURL

public String getURL()
              throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the linked URL.

Specified by:

getURL in interface Page

Returns:

the linked URL.

Throws:

AmetysRepositoryException - if an error occurs.

getURLType

public Page.LinkType getURLType()
                         throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the linked URL type.

Specified by:

getURLType in interface Page

Returns:

the linked URL type.

Throws:

AmetysRepositoryException - if an error occurs.

setURL

public void setURL(Page.LinkType type,
                   String url)
            throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Set the linked URL.

Specified by:

setURL in interface ModifiablePage

Parameters:

type - the type of link

url - the linked URL (depending on the type)

Throws:

AmetysRepositoryException - if an error occurs.

getTemplate

public String getTemplate()
                   throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the template name.

Specified by:

getTemplate in interface Page

Returns:

the template name or null if none has been set.

Throws:

AmetysRepositoryException - if an error occurs.

setTemplate

public void setTemplate(String template)
                 throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Set the template name.

Specified by:

setTemplate in interface ModifiablePage

Parameters:

template - the template name.

Throws:

AmetysRepositoryException - if an error occurs.

getZones

public AmetysObjectIterable<ModifiableZone> getZones()
                                              throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Retrieves the zones.

Specified by:

getZones in interface ModifiablePage

Specified by:

getZones in interface Page

Returns:

the zones.

Throws:

AmetysRepositoryException - if an error occurs.

hasZone

public boolean hasZone(String name)
                throws AmetysRepositoryException

Description copied from interface: Page

Determine if a zone exists

Specified by:

hasZone in interface Page

Parameters:

name - The name of the zone

Returns:

true if the zone exists

Throws:

AmetysRepositoryException - If an error occured

getZone

public ModifiableZone getZone(String name)
                       throws UnknownZoneException,
                              AmetysRepositoryException

Description copied from interface: ModifiablePage

Retrieves a given zone.

Specified by:

getZone in interface ModifiablePage

Specified by:

getZone in interface Page

Parameters:

name - the name of the zone.

Returns:

the given zone.

Throws:

UnknownZoneException - if there is no zone for the given name.

AmetysRepositoryException - if an error occurs.

createZone

public ModifiableZone createZone(String name)
                          throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Creates a given zone.

Specified by:

createZone in interface ModifiablePage

Parameters:

name - the name of the zone.

Returns:

the given zone.

Throws:

AmetysRepositoryException - if an error occurs.

getRootAttachments

public ResourceCollection getRootAttachments()
                                      throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the attachments root node

Specified by:

getRootAttachments in interface Page

Returns:

The the attachments root node

Throws:

AmetysRepositoryException - if an error occurs.

getReferers

public Set<String> getReferers()
                        throws AmetysRepositoryException

Description copied from interface: Page

Retrieves all AmetysObject ids referencing this page.

Specified by:

getReferers in interface Page

Returns:

the AmetysObject ids referencing this page.

Throws:

AmetysRepositoryException - if an error occurs.

addReferer

public void addReferer(String ametysObjectId)
                throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Add a new AmetysObject referencing this page.

Specified by:

addReferer in interface ModifiablePage

Parameters:

ametysObjectId - the AmetysObject ids referencing this page.

Throws:

AmetysRepositoryException - if an error occurs.

removeReferer

public void removeReferer(String ametysObjectId)
                   throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Removes an AmetysObject referencing this page.

Specified by:

removeReferer in interface ModifiablePage

Parameters:

ametysObjectId - the AmetysObject ids referencing this page.

Throws:

AmetysRepositoryException - if an error occurs.

getChildrenPages

public AmetysObjectIterable<? extends Page> getChildrenPages()
                                                      throws AmetysRepositoryException

Description copied from interface: PagesContainer

Retrieves child pages.

Specified by:

getChildrenPages in interface PagesContainer

Returns:

the child pages.

Throws:

AmetysRepositoryException - if an error occurs.

getChildrenPages

public AmetysObjectIterable<? extends Page> getChildrenPages(boolean includeInvisiblePage)
                                                      throws AmetysRepositoryException

Description copied from interface: PagesContainer

Retrieves child pages.

Specified by:

getChildrenPages in interface PagesContainer

Parameters:

includeInvisiblePage - true to include invisible pages

Returns:

the child pages.

Throws:

AmetysRepositoryException - if an error occurs.

getChildPageAt

public Page getChildPageAt(int index)
                    throws UnknownAmetysObjectException,
                           AmetysRepositoryException

Description copied from interface: PagesContainer

Gets the child Page at the given position

Specified by:

getChildPageAt in interface PagesContainer

Parameters:

index - the position of the Page within the ordered set of its sibling objects.

Returns:

the Page if found

Throws:

UnknownAmetysObjectException - if no child page was found at this position

AmetysRepositoryException - if an error occurs

copyTo

public DefaultPage copyTo(ModifiableTraversableAmetysObject parent,
                          String name,
                          List<String> restrictTo)
                   throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object if it is not in the restriction list. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

restrictTo - A restrict list of CopiableAmetysObject authorized to be copied

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public DefaultPage copyTo(ModifiableTraversableAmetysObject parent,
                          String name)
                   throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

moveTo

public void moveTo(AmetysObject newParent,
                   boolean renameIfExist)
            throws AmetysRepositoryException,
                   RepositoryIntegrityViolationException

Description copied from interface: MovableAmetysObject

Move the current object as a new child of the given object. This node will be the last child. You should call canMoveTo to know if this is a supported operation.

Specified by:

moveTo in interface MovableAmetysObject

Parameters:

newParent - The new parent for the current object. Can not be null. Can not be a child of the current node. Must be a TraversableAmetyObject.

renameIfExist - true to rename moved page if a page with same name already exist

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if a page with the same name already exists.

canMoveTo

public boolean canMoveTo(AmetysObject newParent)
                  throws AmetysRepositoryException

Description copied from interface: MovableAmetysObject

Test if a move can be a success or if it is impossible (e.g. due to the implementation of the target)

Specified by:

canMoveTo in interface MovableAmetysObject

Parameters:

newParent - See moveTo.

Returns:

true if the move operation may succeed. If false is returned and you call moveTo anyway, you may encontered a RuntimeException (such as UnsupportedOperationException)

Throws:

AmetysRepositoryException - if an error occurs.

orderBefore

public void orderBefore(AmetysObject siblingNode)
                 throws AmetysRepositoryException

Description copied from interface: MovableAmetysObject

Order a node before another sibling node (or as the last node)

Specified by:

orderBefore in interface MovableAmetysObject

Parameters:

siblingNode - The node that will be the next sibling node of the current node. Must have the same parent as the current node. Can be null to set the current node as the last node.

Throws:

AmetysRepositoryException - if an error occurs.

isVisible

public boolean isVisible()
                  throws AmetysRepositoryException

Description copied from interface: Page

Determine if the page is visible into navigation elements

Specified by:

isVisible in interface Page

Returns:

true if the page is visible.

Throws:

AmetysRepositoryException - if an error occurs.

setVisible

public void setVisible(boolean isVisible)
                throws AmetysRepositoryException

Description copied from interface: ModifiablePage

Set the visibility of the page

Specified by:

setVisible in interface ModifiablePage

Parameters:

isVisible - the page visibility.

Throws:

AmetysRepositoryException - if an error occurs.