Package org.ametys.plugins.odfweb.repository

Class AbstractOdfPage<T extends AbstractOdfPageFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

org.ametys.plugins.odfweb.repository.AbstractOdfPage<T>

Type Parameters:

T - The type of factory to use

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractProgramItemPage, FirstLevelPage, SecondLevelPage

public abstract class AbstractOdfPage<T extends AbstractOdfPageFactory>
extends AbstractConfigurableVirtualPage<T>

Common class for ODF virtual pages

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
static final String	INDEXABLE_CHILDREN	Indexable children attribute name.

Fields inherited from class org.ametys.web.repository.page.virtual.AbstractConfigurableVirtualPage

_configuration, _factory, _root, _scheme

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

METADATA_SITE

Constructor Summary

Constructors

Constructor	Description
AbstractOdfPage(Page root, VirtualPageConfiguration configuration, String scheme, T factory)	The constructor of abstract odf pages

Method Summary

Modifier and Type	Method	Description
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(boolean includeInvisiblePages)	Retrieves child pages.
boolean	isIndexable()	Determine if the page is indexable

Methods inherited from class org.ametys.web.repository.page.virtual.AbstractConfigurableVirtualPage

getContent, getDataHolder, getPath, getReferers, getRootAttachments, getScheme, getSite, getSitemap, getSitemapName, getSiteName, getTags, getTemplate, getTemplateParametersHolder, getType, getURL, getURLType, getZone, getZoneConfiguration, getZones, hasZone, isVisible

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

getChildrenPages, getPathInSitemap, getTitle

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

getChild, getChildAt, getChildPosition, hasChild

Field Details

INDEXABLE_CHILDREN

public static final String INDEXABLE_CHILDREN

Indexable children attribute name.

See Also:

• Constant Field Values

Constructor Details

AbstractOdfPage

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

The constructor of abstract odf pages

Parameters:

root - the odf root page.

configuration - The abstract virtual page configuration

scheme - The scheme

factory - The factory

Method Details

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.

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

isIndexable

public boolean isIndexable()

Description copied from interface: Page

Determine if the page is indexable

Specified by:

isIndexable in interface Page

Overrides:

isIndexable in class AbstractConfigurableVirtualPage<T extends AbstractOdfPageFactory>

Returns:

true if the page is indexable.