Package org.ametys.web.repository.page.virtual

Class AbstractConfigurableVirtualPage<T extends AbstractConfigurableVirtualPageFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.web.repository.page.virtual.AbstractConfigurableVirtualPage<T>

Type Parameters:

T - The type of page factory to use

All Implemented Interfaces:

AmetysObject, DataHolder, TagAwareAmetysObject, TraversableAmetysObject, Page, SitemapElement, SiteAwareAmetysObject

Direct Known Subclasses:

AbstractOdfPage, OrgUnitPage, TransitionalPage, UGCPage, UGCTransitionalPage, UserPage

public abstract class AbstractConfigurableVirtualPage<T extends AbstractConfigurableVirtualPageFactory>
extends AbstractAmetysObject
implements Page

An abstract configurable virtual page.

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	Description
protected VirtualPageConfiguration	_configuration	The AbstractVirtualPageConfiguration
protected T	_factory	The factory
protected Page	_root	The root page
protected String	_scheme	The page's scheme

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

METADATA_SITE

Constructor Summary

Constructors

Constructor	Description
AbstractConfigurableVirtualPage(Page root, VirtualPageConfiguration configuration, String scheme, T factory)	The constructor for an abstract configurable virtual page

Method Summary

Modifier and Type	Method	Description
<C extends Content> C	getContent()	Get the page's content
protected DataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
String	getPath()	Retrieves the path of the current object.
Set<String>	getReferers()	Retrieves all AmetysObject ids referencing this page.
ResourceCollection	getRootAttachments()	Retrieves the attachments root node
String	getScheme()	Get the page's scheme
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.
ModelAwareDataHolder	getTemplateParametersHolder()	Get the view parameters
Page.PageType	getType()	Retrieves the type.
String	getURL()	Retrieves the linked URL.
Page.LinkType	getURLType()	Retrieves the linked URL type.
Zone	getZone(String name)	Retrieves a given zone.
VirtualZoneConfiguration	getZoneConfiguration(String name)	Get a zone configuration by its name
AmetysObjectIterable<? extends Zone>	getZones()	Retrieves the zones.
boolean	hasZone(String name)	Determine if a zone exists
boolean	isIndexable()	Determine if the page is indexable
boolean	isVisible()	Determine if the page is visible into navigation elements

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

dataToJSON, dataToJSON, dataToSAX, dataToSAX, equals, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, 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, hashCode

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

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

getDepth, getLongTitle

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

getChildPageAt, getChildrenPages, getChildrenPages, getPathInSitemap, getTitle

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

getChild, getChildAt, getChildPosition, getChildren, hasChild

Field Details

_root

protected Page _root

The root page

_configuration

protected VirtualPageConfiguration _configuration

The AbstractVirtualPageConfiguration

_scheme

protected String _scheme

The page's scheme

_factory

protected T extends AbstractConfigurableVirtualPageFactory _factory

The factory

Constructor Details

AbstractConfigurableVirtualPage

public AbstractConfigurableVirtualPage(Page root,
 VirtualPageConfiguration configuration,
 String scheme,
 T factory)

The constructor for an abstract configurable virtual page

Parameters:

root - The root page

configuration - The abstract virtual page configuration

scheme - The page's scheme

factory - The page's factory

Method Details

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. Can be null if the page does not supports attachments

Throws:

AmetysRepositoryException - if an error occurs.

getZoneConfiguration

public VirtualZoneConfiguration getZoneConfiguration(String name)

Get a zone configuration by its name

Parameters:

name - The zone name

Returns:

the VirtualPageZoneConfiguration

getTemplate

public String getTemplate()
                   throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves the template name.

Specified by:

getTemplate in interface SitemapElement

Returns:

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

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

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

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.

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.

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()
                   throws AmetysRepositoryException

Description copied from interface: SiteAwareAmetysObject

Returns this object's site name.

Specified by:

getSiteName in interface SiteAwareAmetysObject

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.

Specified by:

getSitemap in interface SitemapElement

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

Specified by:

getSitemapName in interface SitemapElement

Returns:

this page's sitemap name

Throws:

AmetysRepositoryException - if an error occurs.

getPath

public String getPath()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the path of the current object.

Specified by:

getPath in interface AmetysObject

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.

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.

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.

getContent

public <C extends Content> C getContent()

Get the page's content

Type Parameters:

C - The content's type

Returns:

The content

getZone

public Zone getZone(String name)
             throws UnknownZoneException,
AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves a given zone.

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.

getZones

public AmetysObjectIterable<? extends Zone> getZones()
                                              throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves the zones.

Specified by:

getZones in interface SitemapElement

Returns:

the zones.

Throws:

AmetysRepositoryException - if an error occurs.

getTemplateParametersHolder

public ModelAwareDataHolder getTemplateParametersHolder()
                                                 throws AmetysRepositoryException

Description copied from interface: SitemapElement

Get the view parameters

Specified by:

getTemplateParametersHolder in interface SitemapElement

Returns:

the view parameters. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getScheme

public String getScheme()

Get the page's scheme

Returns:

The scheme of the page

isIndexable

public boolean isIndexable()

Description copied from interface: Page

Determine if the page is indexable

Specified by:

isIndexable in interface Page

Returns:

true if the page is indexable.

getDataHolder

protected DataHolder getDataHolder()

Description copied from class: AbstractAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in class AbstractAmetysObject

Returns:

the DataHolder of this AmetysObject