Package org.ametys.plugins.blog.repository

Class VirtualMonthPage

java.lang.Object

org.ametys.plugins.blog.repository.AbstractBlogPage

org.ametys.plugins.blog.repository.VirtualMonthPage

All Implemented Interfaces:

AmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, TagAwareAmetysObject, TraversableAmetysObject, MetadataAwareSitemapElement, Page, SitemapElement, SiteAwareAmetysObject

public class VirtualMonthPage
extends AbstractBlogPage

Virtual page representing a month page.

Nested Class Summary

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

Page.LinkType, Page.PageType

Field Summary

Fields inherited from class org.ametys.plugins.blog.repository.AbstractBlogPage

BLOG_MONTH_TEMPLATE, BLOG_POST_TEMPLATE, BLOG_TAG_TEMPLATE, BLOG_YEAR_TEMPLATE

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

METADATA_SITE

Constructor Summary

Constructors

Constructor	Description
VirtualMonthPage(AmetysObjectResolver resolver, BlogCacheManager cacheManager, SkinsManager skinsManager, int year, int month, String title, SitemapElement root, ModelItemTypeExtensionPoint pageDataTypeExtensionPoint, ModelItemTypeExtensionPoint zoneDataTypeExtensionPoint, ServiceExtensionPoint serviceExtensionPoint, ModelItemTypeExtensionPoint zoneItemDataTypeExtensionPoint)	Constructor.

Method Summary

Modifier and Type	Method	Description
<A extends AmetysObject> A	getChild(String path)	Retrieves a given child from its relative path.
Page	getChildPageAt(int index)	Gets the child Page at the given position
AmetysObjectIterable<? extends AmetysObject>	getChildren()	Retrieves children of the current object.
AmetysObjectIterable<? extends Page>	getChildrenPages()	Retrieves child pages.
AmetysObjectIterable<? extends Page>	getChildrenPages(boolean includeInvisiblePages)	Retrieves child pages.
ModelLessDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
protected Zone	getDefaultZone()	Get the "default" zone.
int	getDepth()	Get the page depth
String	getId()	Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
String	getLongTitle()	Retrieves the long title.
int	getMonth()	Get the page's month.
String	getName()	Retrieves the name of the current object.
SitemapElement	getParent()	Returns the parent object in the Ametys hierarchy.
String	getParentPath()	Returns the path of the parent object in the Ametys hierarchy.
String	getPath()	Retrieves the path of the current object.
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.
ModelAwareDataHolder	getTemplateParametersHolder()	Get the view parameters
String	getTitle()	Retrieves the title.
String	getURL()	Retrieves the linked URL.
Page.LinkType	getURLType()	Retrieves the linked URL type.
int	getYear()	Get the page's year.
boolean	hasChild(String name)	Tests if this Object has at least one child with the given name.
boolean	isVisible()	Determine if the page is visible into navigation elements

Methods inherited from class org.ametys.plugins.blog.repository.AbstractBlogPage

getReferencePage, getType, getZone, getZones, hasZone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

equals, hashCode

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

copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDataNames, getRepositoryData

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

dataToJSON, dataToSAX, 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

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

getChildAt, getChildPosition

Constructor Details

VirtualMonthPage

public VirtualMonthPage(AmetysObjectResolver resolver,
 BlogCacheManager cacheManager,
 SkinsManager skinsManager,
 int year,
 int month,
 String title,
 SitemapElement root,
 ModelItemTypeExtensionPoint pageDataTypeExtensionPoint,
 ModelItemTypeExtensionPoint zoneDataTypeExtensionPoint,
 ServiceExtensionPoint serviceExtensionPoint,
 ModelItemTypeExtensionPoint zoneItemDataTypeExtensionPoint)

Constructor.

Parameters:

resolver - the AmetysObjectResolver.

cacheManager - the AmetysObjectResolver.

skinsManager - the SkinsManager

year - the year

month - the month

title - the page's title.

root - the blog root page.

pageDataTypeExtensionPoint - the extension point with available data types for pages

zoneDataTypeExtensionPoint - the extension point with available data types for zones

serviceExtensionPoint - The service extension point

zoneItemDataTypeExtensionPoint - the extension point with available data types for zone items

Method Details

getYear

public int getYear()

Get the page's year.

Returns:

the year.

getMonth

public int getMonth()

Get the page's month.

Returns:

the month.

getDepth

public int getDepth()
             throws AmetysRepositoryException

Description copied from interface: Page

Get the page depth

Returns:

the page depth

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.

Returns:

the AmetysObject ids referencing this page.

Throws:

AmetysRepositoryException - if an error occurs.

getRootAttachments

public ResourceCollection getRootAttachments()
                                      throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the attachments root node

Returns:

The the attachments root node

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.

getLongTitle

public String getLongTitle()
                    throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the long title.

Returns:

the title.

Throws:

AmetysRepositoryException - if an error occurs.

getURL

public String getURL()
              throws AmetysRepositoryException

Description copied from interface: Page

Retrieves the linked URL.

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.

Returns:

the linked URL type.

Throws:

AmetysRepositoryException - if an error occurs.

getDefaultZone

protected Zone getDefaultZone()

Description copied from class: AbstractBlogPage

Get the "default" zone.

Specified by:

getDefaultZone in class AbstractBlogPage

Returns:

the "default" zone.

getChildrenPages

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

Description copied from interface: SitemapElement

Retrieves child pages.

Returns:

the child pages.

Throws:

AmetysRepositoryException - if an error occurs.

getChildrenPages

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

Description copied from interface: SitemapElement

Retrieves child pages.

Parameters:

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

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

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.

getChild

public <A extends AmetysObject> A getChild(String path)
                                    throws AmetysRepositoryException,
UnknownAmetysObjectException

Description copied from interface: TraversableAmetysObject

Retrieves a given child from its relative path. The path cannot be null, empty nor begin with a '/'.

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

path - the path of the child which can contains a position with. [n] if same name sibling is allowed.

Returns:

the child found.

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if the object does not exist.

getChildren

public AmetysObjectIterable<? extends AmetysObject> getChildren()
                                                         throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Retrieves children of the current object.

Returns:

the children or an empty AmetysObjectIterable.

Throws:

AmetysRepositoryException - if an error occurs.

hasChild

public boolean hasChild(String name)
                 throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Tests if this Object has at least one child with the given name.

Parameters:

name - the name to test. Cannot be null nor empty nor begin with a '/' and it cannot contain '/'.

Returns:

true if the named child exists, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

getId

public String getId()
             throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Returns:

the unique identifier of this AmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getParent

public SitemapElement getParent()
                         throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

public String getParentPath()
                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the path of the parent object in the Ametys hierarchy.

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

getPath

public String getPath()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the path of the current object.

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.

getDataHolder

public ModelLessDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Returns:

the DataHolder of this AmetysObject

getTags

public Set<String> getTags()
                    throws AmetysRepositoryException

Description copied from interface: TagAwareAmetysObject

Retrieves current tags.

Returns:

the current tags.

Throws:

AmetysRepositoryException - if an error occurs.

getTemplate

public String getTemplate()
                   throws AmetysRepositoryException

Description copied from interface: SitemapElement

Retrieves the template name.

Specified by:

getTemplate in interface SitemapElement

Overrides:

getTemplate in class AbstractBlogPage

Returns:

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

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

Returns:

true if the page is visible.

Throws:

AmetysRepositoryException - if an error occurs.

getTemplateParametersHolder

public ModelAwareDataHolder getTemplateParametersHolder()
                                                 throws AmetysRepositoryException

Description copied from interface: SitemapElement

Get the view parameters

Returns:

the view parameters

Throws:

AmetysRepositoryException - if an error occurs.