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

Class ConfigurableVirtualZoneFactory

java.lang.Object

org.ametys.web.repository.page.virtual.ConfigurableVirtualZoneFactory

All Implemented Interfaces:

AmetysObjectFactory<ConfigurableVirtualZone>, Component, Configurable, Serviceable

public class ConfigurableVirtualZoneFactory
extends Object
implements AmetysObjectFactory<ConfigurableVirtualZone>, Serviceable, Configurable

The factory to manage configurable zones

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectFactoryExtensionPoint	_ametysObjectFactoryEP	The ametys object factory extension point
protected I18nUtils	_i18nUtils	the i18n utils component
protected ServiceManager	_manager	The service manager
protected ModelItemTypeExtensionPoint	_pageDataTypeExtensionPoint	The page data type extension point
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SAXParser	_saxParser	Excalibur SaxParser
protected String	_scheme	The scheme
protected ServiceExtensionPoint	_serviceExtensionPoint	The service extension point
protected String	_zoneItemFactoryId	The zone item factory id
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
ConfigurableVirtualZoneFactory()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
ConfigurableVirtualZone	createZone(AbstractConfigurableVirtualPage page, String zoneName)	Create a zone with its page and name
ConfigurableVirtualZone	getAmetysObjectById(String id)	Retrieves an AmetysObject, given its id. Id are like <protocol>://<protocol-specific-part>.
String	getScheme()	Returns the protocol of this factory, used to construct unique ids.
ModelItemTypeExtensionPoint	getZoneDataTypeExtensionPoint()	Get the zone data type extension point
ConfigurableVirtualZoneItemFactory	getZoneItemFactory()	Get the Configurable virtual zone item's factory
boolean	hasAmetysObjectForId(String id)	Return true if the specified id correspond to an existing AmetysObject.
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The avalon role

_manager

protected ServiceManager _manager

The service manager

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_ametysObjectFactoryEP

protected AmetysObjectFactoryExtensionPoint _ametysObjectFactoryEP

The ametys object factory extension point

_i18nUtils

protected I18nUtils _i18nUtils

the i18n utils component

_saxParser

protected SAXParser _saxParser

Excalibur SaxParser

_pageDataTypeExtensionPoint

protected ModelItemTypeExtensionPoint _pageDataTypeExtensionPoint

The page data type extension point

_serviceExtensionPoint

protected ServiceExtensionPoint _serviceExtensionPoint

The service extension point

_scheme

protected String _scheme

The scheme

_zoneItemFactoryId

protected String _zoneItemFactoryId

The zone item factory id

Constructor Details

ConfigurableVirtualZoneFactory

public ConfigurableVirtualZoneFactory()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

createZone

public ConfigurableVirtualZone createZone(AbstractConfigurableVirtualPage page,
 String zoneName)

Create a zone with its page and name

Parameters:

page - The zone's page

zoneName - The zone's name

Returns:

The created ConfigurableVirtualZone

getAmetysObjectById

public ConfigurableVirtualZone 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<ConfigurableVirtualZone>

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

Parameters:

id - the identifier.

Returns:

true if the specified id correspond to an existing AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

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

Returns:

the protocol of this factory.

getZoneDataTypeExtensionPoint

public ModelItemTypeExtensionPoint getZoneDataTypeExtensionPoint()

Get the zone data type extension point

Returns:

The ModelItemTypeExtensionPoint

getZoneItemFactory

public ConfigurableVirtualZoneItemFactory getZoneItemFactory()

Get the Configurable virtual zone item's factory

Returns:

The ConfigurableVirtualZoneItemFactory