Package org.ametys.plugins.blog.repository

Class BlogRootPageFactory

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.blog.repository.BlogRootPageFactory

All Implemented Interfaces:

AmetysObjectFactory<Page>, VirtualAmetysObjectFactory<Page>, PluginAware, Component, LogEnabled, Serviceable

public class BlogRootPageFactory
extends AbstractLogEnabled
implements VirtualAmetysObjectFactory<Page>, Serviceable, PluginAware

AmetysObjectFactory for handling "virtual" blog root page.

Field Summary

Fields

Modifier and Type	Field	Description
protected BlogCacheManager	_cacheManager	The blog cache manager.
protected String	_i18nCatalogue	The i18n catalogue.
protected I18nUtils	_i18nUtils	The i18n cache.
protected PageDataTypeExtensionPoint	_pageDataTypeExtensionPoint	The extension point with available data types for pages
protected String	_pluginName	The plugin name.
protected AmetysObjectResolver	_resolver	The ametys object resolver.
protected ServiceExtensionPoint	_serviceExtensionPoint	The service extension point
protected SkinsManager	_skinsManager	The skins manager
protected TagProviderExtensionPoint	_tagProviderEP	The tag provider extension point.
static String	SCHEME	The sub-pages scheme.

Constructor Summary

Constructors

Constructor	Description
BlogRootPageFactory()

Method Summary

Modifier and Type	Method	Description
Page	getAmetysObjectById(String id)	Retrieves an AmetysObject, given its id. Id are like <protocol>://<protocol-specific-part>.
Page	getChild(JCRAmetysObject parent, String childName)	Returns a named AmetysObject.
AmetysObjectIterable<Page>	getChildren(JCRAmetysObject parent)	Returns the "root" objects of this virtual factory, hosted in the Ametys hierarchy under a TraversableAmetysObject, which is backed by a concrete JCR Node.
String	getScheme()	Returns the protocol of this factory, used to construct unique ids.
boolean	hasAmetysObjectForId(String id)	Return true if the specified id correspond to an existing AmetysObject.
boolean	hasChild(JCRAmetysObject parent, String childName)	Returns true if the named AmetysObject exists.
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
String	translate(String language, String key)	Get a translated i18n message from the cache.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME

public static final String SCHEME

The sub-pages scheme.

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

_cacheManager

protected BlogCacheManager _cacheManager

The blog cache manager.

_tagProviderEP

protected TagProviderExtensionPoint _tagProviderEP

The tag provider extension point.

_i18nUtils

protected I18nUtils _i18nUtils

The i18n cache.

_pluginName

protected String _pluginName

The plugin name.

_i18nCatalogue

protected String _i18nCatalogue

The i18n catalogue.

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_pageDataTypeExtensionPoint

protected PageDataTypeExtensionPoint _pageDataTypeExtensionPoint

The extension point with available data types for pages

_serviceExtensionPoint

protected ServiceExtensionPoint _serviceExtensionPoint

The service extension point

Constructor Detail

BlogRootPageFactory

public BlogRootPageFactory()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getScheme

public String getScheme()

Description copied from interface: AmetysObjectFactory

Returns the protocol of this factory, used to construct unique ids.

Specified by:

getScheme in interface AmetysObjectFactory<Page>

Returns:

the protocol of this factory.

getChildren

public AmetysObjectIterable<Page> getChildren(JCRAmetysObject parent)

Description copied from interface: VirtualAmetysObjectFactory

Returns the "root" objects of this virtual factory, hosted in the Ametys hierarchy under a TraversableAmetysObject, which is backed by a concrete JCR Node.

Specified by:

getChildren in interface VirtualAmetysObjectFactory<Page>

Parameters:

parent - the JCRAmetysObject "hosting" this factory.

Returns:

the root objects of this virtual factory.

hasChild

public boolean hasChild(JCRAmetysObject parent,
                        String childName)

Description copied from interface: VirtualAmetysObjectFactory

Returns true if the named AmetysObject exists.

Specified by:

hasChild in interface VirtualAmetysObjectFactory<Page>

Parameters:

parent - the JCRAmetysObject "hosting" this factory.

childName - the name of the virtual child.

Returns:

true if the named AmetysObject exists.

getChild

public Page getChild(JCRAmetysObject parent,
                     String childName)

Description copied from interface: VirtualAmetysObjectFactory

Returns a named AmetysObject.

Specified by:

getChild in interface VirtualAmetysObjectFactory<Page>

Parameters:

parent - the JCRAmetysObject "hosting" this factory.

childName - the name of the virtual child.

Returns:

the corresponding AmetysObject.

getAmetysObjectById

public Page getAmetysObjectById(String id)
                         throws AmetysRepositoryException

Description copied from interface: AmetysObjectFactory

Retrieves an AmetysObject, given its id.
Id are like <protocol>://<protocol-specific-part>.

Specified by:

getAmetysObjectById in interface AmetysObjectFactory<Page>

Parameters:

id - the identifier.

Returns:

the corresponding AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

hasAmetysObjectForId

public boolean hasAmetysObjectForId(String id)
                             throws AmetysRepositoryException

Description copied from interface: AmetysObjectFactory

Return true if the specified id correspond to an existing AmetysObject. Id are like <protocol>://<protocol-specific-part>.

Specified by:

hasAmetysObjectForId in interface AmetysObjectFactory<Page>

Parameters:

id - the identifier.

Returns:

true if the specified id correspond to an existing AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

translate

public String translate(String language,
                        String key)

Get a translated i18n message from the cache.

Parameters:

language - the language.

key - the i18n message key.

Returns:

the translated text.