Package org.ametys.web.repository.sitemap

Class Sitemap

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.AbstractSitemapElement<SitemapFactory>

org.ametys.web.repository.sitemap.Sitemap

All Implemented Interfaces:

ACLAmetysObject, AmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, ModifiableModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, ModifiableDataHolder, ModifiableModelLessDataHolder, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject, MetadataAwareSitemapElement, ModifiableSitemapElement, SitemapElement, SiteAwareAmetysObject

public final class Sitemap
extends AbstractSitemapElement<SitemapFactory>

Sitemap of a web site. A sitemap is a hierarchical view of the site. It is composed by Pages A single web site may have many sitemaps.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NODE_TYPE	Sitemap node type name.

Fields inherited from class org.ametys.web.repository.page.jcr.AbstractSitemapElement

ZONE_NODE_TYPE, ZONES_NODE_NAME, ZONES_NODE_TYPE

Fields inherited from interface org.ametys.web.repository.SiteAwareAmetysObject

METADATA_SITE

Constructor Summary

Constructors

Constructor	Description
Sitemap(javax.jcr.Node node, String parentPath, SitemapFactory factory)	Creates a Sitemap.

Method Summary

Modifier and Type	Method	Description
String	getPathInSitemap()	Computes the path relative to the current sitemap.
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.
String	getTemplate()	Retrieves the template name.
String	getTitle()	Retrieves the title.

Methods inherited from class org.ametys.web.repository.page.jcr.AbstractSitemapElement

createZone, dataToSAX, dataToSAX, getChildPageAt, getChildrenPages, getChildrenPages, getDataHolder, getMetadataHolder, getTemplateParametersHolder, getZone, getZones, hasZone

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

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, createChild, disallowInheritance, getChild, getChildren, getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, hasChild, isInheritanceDisallowed, 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, 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.AmetysObject

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

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, dataToJSON, dataToJSON, dataToSAX, getDataNames, getRepositoryData

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

getNode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelLessDataAwareAmetysObject

dataToJSON, getComposite, getModelItemTypeExtensionPoint, getParentDataHolder, getRootDataHolder, getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, hasValueOrEmpty, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelLessDataHolder

dataToJSON, dataToSAX, hasValue, hasValueOrEmpty

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

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModifiableModelLessDataAwareAmetysObject

getComposite, getComposite, getParentDataHolder, getRepositoryData, getRootDataHolder, removeValue, setValue, setValue, synchronizeValues

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

remove

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

getChild, getChildAt, getChildPosition, getChildren, hasChild

Field Details

NODE_TYPE

public static final String NODE_TYPE

Sitemap node type name.

See Also:

• Constant Field Values

Constructor Details

Sitemap

public Sitemap(javax.jcr.Node node,
 String parentPath,
 SitemapFactory factory)

Creates a Sitemap.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the SitemapFactory which creates the AmetysObject.

Method Details

getPathInSitemap

public String getPathInSitemap()
                        throws AmetysRepositoryException

Description copied from interface: SitemapElement

Computes the path relative to the current sitemap.

Returns:

the path relative to the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getSite

public Site getSite()
             throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site.

Returns:

this object's site

Throws:

AmetysRepositoryException - if an error occurs.

getSiteName

public String getSiteName()
                   throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site name.

Returns:

this object's site name.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemap

public Sitemap getSitemap()
                   throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves the sitemap containing the current sitemap.

Returns:

the sitemap containing the current sitemap.

Throws:

AmetysRepositoryException - if an error occurs.

getSitemapName

public String getSitemapName()
                      throws AmetysRepositoryException

Description copied from interface: SitemapElement

Returns this page's sitemap name

Returns:

this page's sitemap name

Throws:

AmetysRepositoryException - if an error occurs.

getTitle

public String getTitle()
                throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves the title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getTemplate

public String getTemplate()
                   throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves the template name.

Returns:

the template name or null if none has been set or if the type is not container.

Throws:

AmetysRepositoryException - if an error occurs.