org.ametys.plugins.ugc.page

Class UGCPageHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.ugc.page.UGCPageHandler

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class UGCPageHandler
extends AbstractLogEnabled
implements Component, Serviceable

Component providing methods to retrieve ugc virtual pages, such as the ugc root, transitional page and ugc content page.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentTypeExtensionPoint	_cTypeEP The content type extension point
protected I18nUtils	_i18nUtils The i18n utils
protected AmetysObjectResolver	_resolver The ametys object resolver
static String	ATTRIBUTE_TRANSITIONAL_PAGE_METADATA_VALUE The attribute to get the name of transitional page
static String	ATTRIBUTE_TRANSITIONAL_PAGE_TITLE The attribute to get the title of transitional page
static String	CLASSIFICATION_METADATA_METADATA_NAME The metadata name for the classification metadata of the ugc
static String	CONTENT_TYPE_METADATA_NAME The metadata name for the content type of the ugc
static String	ROLE The avalon role.

Constructor Summary

Constructors

Constructor and Description
UGCPageHandler()

Method Summary

Modifier and Type	Method and Description
protected AmetysObjectIterable<Content>	_getAllContents(Page rootPage, String contentTypeId) Get all content with the content type id
String	getClassificationMetadata(Page rootPage) Gets the name of the classification metadata
AmetysObjectIterable<Content>	getContentsForRootPage(Page rootPage) Get orgUnit contents from rootPage
AmetysObjectIterable<Content>	getContentsForTransitionalPage(Page rootPage, String metadataValue) Get contents under transitional page
String	getContentTypeId(Page rootPage) Gets the content type id
Map<String,Map<String,String>>	getTransitionalPage(Page rootPage) Get the map of transitional page (name : (id, title))
Page	getUGCRootPage(String siteName, String sitemapName, String contentTypeId) Gets the ugc root pages from the given content type id.
Set<Page>	getUGCRootPages(String siteName, String sitemapName) Get the ugc root pages
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_TRANSITIONAL_PAGE_METADATA_VALUE

public static final String ATTRIBUTE_TRANSITIONAL_PAGE_METADATA_VALUE

The attribute to get the name of transitional page

See Also:

Constant Field Values

ATTRIBUTE_TRANSITIONAL_PAGE_TITLE

public static final String ATTRIBUTE_TRANSITIONAL_PAGE_TITLE

The attribute to get the title of transitional page

See Also:

Constant Field Values

ROLE

public static final String ROLE

The avalon role.

CONTENT_TYPE_METADATA_NAME

public static final String CONTENT_TYPE_METADATA_NAME

The metadata name for the content type of the ugc

See Also:

Constant Field Values

CLASSIFICATION_METADATA_METADATA_NAME

public static final String CLASSIFICATION_METADATA_METADATA_NAME

The metadata name for the classification metadata of the ugc

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

Constructor Detail

UGCPageHandler

public UGCPageHandler()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getClassificationMetadata

public String getClassificationMetadata(Page rootPage)

Gets the name of the classification metadata

Parameters:

rootPage - The ugc root page

Returns:

the name of the classification metadata

getContentTypeId

public String getContentTypeId(Page rootPage)

Gets the content type id

Parameters:

rootPage - The ugc root page

Returns:

the content type id

getUGCRootPage

public Page getUGCRootPage(String siteName,
                           String sitemapName,
                           String contentTypeId)
                    throws AmetysRepositoryException

Gets the ugc root pages from the given content type id.

Parameters:

siteName - the site name

sitemapName - the sitemap name

contentTypeId - The content type id

Returns:

the ugc root page.

Throws:

AmetysRepositoryException - if an error occured.

getUGCRootPages

public Set<Page> getUGCRootPages(String siteName,
                                 String sitemapName)
                          throws AmetysRepositoryException

Get the ugc root pages

Parameters:

siteName - the current site.

sitemapName - the sitemap name.

Returns:

the ugc root pages

Throws:

AmetysRepositoryException - if an error occured.

getContentsForRootPage

public AmetysObjectIterable<Content> getContentsForRootPage(Page rootPage)

Get orgUnit contents from rootPage

Parameters:

rootPage - the root page

Returns:

the list of orgUnit contents

getTransitionalPage

public Map<String,Map<String,String>> getTransitionalPage(Page rootPage)

Get the map of transitional page (name : (id, title))

Parameters:

rootPage - the root page

Returns:

The map of transitional page

getContentsForTransitionalPage

public AmetysObjectIterable<Content> getContentsForTransitionalPage(Page rootPage,
                                                                    String metadataValue)

Get contents under transitional page

Parameters:

rootPage - the root page

metadataValue - the metadata value (linked to the transitional page)

Returns:

list of contents under transitional page

_getAllContents

protected AmetysObjectIterable<Content> _getAllContents(Page rootPage,
                                                        String contentTypeId)

Get all content with the content type id

Parameters:

rootPage - the root page

contentTypeId - the content type id

Returns:

the list of contents