Package org.ametys.web.repository.page.jcr

Class AbstractSitemapElement<F extends AbstractSitemapElementFactory>

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<F>

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

ACLAmetysObject, AmetysObject, DataHolder, ModifiableDataHolder, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject, ModifiableSitemapElement, SitemapElement, SiteAwareAmetysObject

Direct Known Subclasses:

DefaultPage, Sitemap

public abstract class AbstractSitemapElement<F extends AbstractSitemapElementFactory>
extends DefaultTraversableAmetysObject<F>
implements ModifiableSitemapElement

SitemapElement implementation stored into a JCR node.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ZONE_NODE_TYPE	Constant for the zone node type.
static final String	ZONES_NODE_NAME	Constant for the zones node name.
static final String	ZONES_NODE_TYPE	Constant for the zones node type.

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

METADATA_SITE

Constructor Summary

Constructors

Constructor	Description
AbstractSitemapElement(javax.jcr.Node node, String parentPath, F factory)	Creates an AbstractSitemapElement.

Method Summary

Modifier and Type	Method	Description
ModifiableZone	createZone(String name)	Creates a given zone.
void	dataToSAX(ContentHandler contentHandler, String dataPath, DataContext context)	Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path
void	dataToSAX(ContentHandler contentHandler, DataContext context)	Generates SAX events for data contained in this DataHolder
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.
ModifiableCompositeMetadata	getMetadataHolder()	Returns the root CompositeMetadata of this AmetysObject.
ModifiableModelAwareDataHolder	getTemplateParametersHolder()	Get the view parameters
ModifiableZone	getZone(String name)	Retrieves a given zone.
AmetysObjectIterable<ModifiableZone>	getZones()	Retrieves the zones.
boolean	hasZone(String name)	Determine if a zone exists

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, getComposite, getComposite, getDataHolder, getId, getName, getNode, getParent, getParentDataHolder, getParentPath, getPath, getRepositoryData, getRootDataHolder, needsSave, remove, removeValue, rename, revertChanges, saveChanges, setValue, setValue, synchronizeValues

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

dataToJSON, dataToJSON, equals, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hashCode, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, 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.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

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

getNode

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

needsSave, rename, revertChanges, saveChanges

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

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

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

createChild

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

remove

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

getSite, getSiteName

Methods inherited from interface org.ametys.web.repository.page.SitemapElement

getPathInSitemap, getSitemap, getSitemapName, getTemplate, getTitle

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

getChild, getChildAt, getChildPosition, getChildren, hasChild

Field Details

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

Constructor Details

AbstractSitemapElement

public AbstractSitemapElement(javax.jcr.Node node,
 String parentPath,
 F factory)

Creates an AbstractSitemapElement.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the DefaultPageFactory which creates the AmetysObject.

Method Details

getChildrenPages

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

Description copied from interface: SitemapElement

Retrieves child pages.

Specified by:

getChildrenPages in interface SitemapElement

Returns:

the child pages.

Throws:

AmetysRepositoryException - if an error occurs.

getChildrenPages

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

Description copied from interface: SitemapElement

Retrieves child pages.

Specified by:

getChildrenPages in interface SitemapElement

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: SitemapElement

Gets the child Page at the given position

Specified by:

getChildPageAt in interface SitemapElement

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

getZones

public AmetysObjectIterable<ModifiableZone> getZones()
                                              throws AmetysRepositoryException

Description copied from interface: ModifiableSitemapElement

Retrieves the zones.

Specified by:

getZones in interface ModifiableSitemapElement

Specified by:

getZones in interface SitemapElement

Returns:

the zones.

Throws:

AmetysRepositoryException - if an error occurs.

hasZone

public boolean hasZone(String name)
                throws AmetysRepositoryException

Description copied from interface: SitemapElement

Determine if a zone exists

Specified by:

hasZone in interface SitemapElement

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: ModifiableSitemapElement

Retrieves a given zone.

Specified by:

getZone in interface ModifiableSitemapElement

Specified by:

getZone in interface SitemapElement

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: ModifiableSitemapElement

Creates a given zone.

Specified by:

createZone in interface ModifiableSitemapElement

Parameters:

name - the name of the zone.

Returns:

the given zone.

Throws:

AmetysRepositoryException - if an error occurs.

getMetadataHolder

public ModifiableCompositeMetadata getMetadataHolder()

Description copied from class: SimpleAmetysObject

Returns the root CompositeMetadata of this AmetysObject.

Specified by:

getMetadataHolder in interface MetadataAwareAmetysObject

Specified by:

getMetadataHolder in interface ModifiableMetadataAwareAmetysObject

Overrides:

getMetadataHolder in class SimpleAmetysObject<F extends AbstractSitemapElementFactory>

Returns:

the root CompositeMetadata of this AmetysObject

getTemplateParametersHolder

public ModifiableModelAwareDataHolder getTemplateParametersHolder()
                                                           throws AmetysRepositoryException

Description copied from interface: ModifiableSitemapElement

Get the view parameters

Specified by:

getTemplateParametersHolder in interface ModifiableSitemapElement

Specified by:

getTemplateParametersHolder in interface SitemapElement

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 DataContext context)
               throws SAXException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Generates SAX events for data contained in this DataHolder

Specified by:

dataToSAX in interface DataHolder

Overrides:

dataToSAX in class AbstractAmetysObject

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

UnknownTypeException - if there is no compatible type with the saxed value

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one) with the saxed value

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 String dataPath,
 DataContext context)
               throws SAXException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path

Specified by:

dataToSAX in interface DataHolder

Overrides:

dataToSAX in class AbstractAmetysObject

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

UnknownTypeException - if there is no compatible type with the saxed value

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one) with the saxed value

BadItemTypeException - if the saxed value's type does not matches the stored data