com.sapportals.wcm.rendering.base

Class AbstractFactory

java.lang.Object
  com.sapportals.wcm.rendering.base.AbstractFactory

All Implemented Interfaces:

IFactoryInfoProvider

Direct Known Subclasses:

CollectionRendererFactory, ResourceRendererFactory

public abstract class AbstractFactory

extends Object

implements IFactoryInfoProvider

Nested Class Summary

Nested classes inherited from class com.sapportals.wcm.rendering.base.IFactoryInfoProvider

IFactoryInfoProvider.MappingInformation

Field Summary

protected IRenderObjectInfo.RenderObjectCategory	category
protected IParameterName	classkey
protected String	configclass
protected String	configplugin
static String	CONFIGURATION_FORMAT_LIST
static String	CONFIGURATION_FORMAT_TABLE
static String	CONFIGURATION_FORMAT_TABLE_NO_HEADER
protected String	default_config
protected String	default508_config
protected String	default508class
protected String	defaultclass
protected String	descriptiveName

Constructor Summary

AbstractFactory()

Method Summary

void	configEvent(ConfigEvent event) Description of the Method
String	getConfigListenerId() Gets the configListenerId attribute of the UICommandFactory object
protected String	getConfiguration(String format) returns a formatted list of all configured ILayoutObjects and their supported parameters and default values
long	getLastReloadTime()
protected ILayoutObject	getLayoutObject(IProxy proxy, IResource outerResource, IResource resource, Hashtable table, IFlavor flavor, boolean requires508) This method is used by the classes that extend the AbstractFactory.
protected ILayoutObject	getLayoutObject(IProxy proxy, ITypedResourceList resourcelist, Hashtable table, IFlavor flavor, boolean requires508)
List	getMappings(Locale locale)
Status	getStatus()
protected void	initialize() This method is called when the class, that extends AbstractFactory, is instantiated for the first time.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sapportals.wcm.rendering.base.IFactoryInfoProvider

getFactoryName

Field Detail

CONFIGURATION_FORMAT_TABLE

public static final String CONFIGURATION_FORMAT_TABLE

See Also:

Constant Field Values

CONFIGURATION_FORMAT_TABLE_NO_HEADER

public static final String CONFIGURATION_FORMAT_TABLE_NO_HEADER

See Also:

Constant Field Values

CONFIGURATION_FORMAT_LIST

public static final String CONFIGURATION_FORMAT_LIST

See Also:

Constant Field Values

category

protected IRenderObjectInfo.RenderObjectCategory category

configplugin

protected String configplugin

configclass

protected String configclass

defaultclass

protected String defaultclass

default508class

protected String default508class

default_config

protected String default_config

default508_config

protected String default508_config

classkey

protected IParameterName classkey

descriptiveName

protected String descriptiveName

Constructor Detail

AbstractFactory

public AbstractFactory()

Method Detail

getLayoutObject

protected ILayoutObject getLayoutObject(IProxy proxy,
                                        IResource outerResource,
                                        IResource resource,
                                        Hashtable table,
                                        IFlavor flavor,
                                        boolean requires508)
                                 throws WcmException

This method is used by the classes that extend the AbstractFactory. This class holds a map of ILayoutObject. It uses the ICustomizingController to retrieve the best match for the given parameters. The ICustomizingController returns the best fitting result or - if none could be found - the default value, that was supplied. This returned value is just the alias for the needed ILayoutController. The ILayoutObject that is mapped on this alias will be returned. If the value returned by the ICustomizingController is not known to the AbstractFactory or the class that is mapped on this alias cannot be instantiated an error is logged and the default ILayoutObject is returned.

Parameters:

resource - the resource that the ILayoutObject is needed for

table - the parameters coming from the URL, including the iView settings

flavor - if several ILayoutObject are available for this resource,

requires508 - flag, if the ILayoutObject returned must support 508-conform rendering. the flavor specifies which one to take.

Returns:

ILayoutObject a new instance of the ILayoutObject that best matches the given parameters. If 508-conform rendering is required and the ILayoutObject retrieved by the above described procedure does not support this, the default 508-renderer specified will be returned instead.

Throws:

WcmException

getLayoutObject

protected ILayoutObject getLayoutObject(IProxy proxy,
                                        ITypedResourceList resourcelist,
                                        Hashtable table,
                                        IFlavor flavor,
                                        boolean requires508)
                                 throws WcmException

Throws:

WcmException

initialize

protected void initialize()
                   throws WcmException

This method is called when the class, that extends AbstractFactory, is instantiated for the first time. It uses the ConfigurationFramework to retrieve the ILayoutObjects and their settings from the present configuration. When this method is called at a later point of time (e.g. when an update-event from the configuration framework is fired, the existing ILayoutObjects and settings are deleted and reloaded from the configuration. When reloading, the old configuration will be kept until the complete reloading has been finished. At that time, the new configuration will replace the existing one. If exceptions or errors occured when reloading the configuration, the old configuration will be removed anyways and only the default classes will be available.

Throws:

WcmException - thrown when the configuration-framework throws any kind of exception. If this happens, all classes, mapping etc. that have been read out are reset again. Only the default ILayoutObject and the default ILayoutObject for 508-rendering that are set in the class that extends this AbstractFactory are available. This information is logged with attribute . If classes specified in the IConfigurable returned from the Configuration Framework do not exist or do not implement the ILayoutObject interface, the exception is caught and the information is logged with attribute .

getConfiguration

protected String getConfiguration(String format)

returns a formatted list of all configured ILayoutObjects and their supported parameters and default values

getConfigListenerId

public String getConfigListenerId()

Gets the configListenerId attribute of the UICommandFactory object

Returns:

The configListenerId value

configEvent

public void configEvent(ConfigEvent event)

Description of the Method

getMappings

public List getMappings(Locale locale)

Specified by:

getMappings in interface IFactoryInfoProvider

Parameters:

locale - defines the language to use, if the factory offers translated information, must not be null

Returns:

a list that must only contain IFactoryInfoProvider.MappingInformation, must not be null

getStatus

public Status getStatus()

Specified by:

getStatus in interface IFactoryInfoProvider

Returns:

the aggregated status of the factory. If, e.g., there have been errors creating a class defined in the config, the factory should return Status.ERROR

getLastReloadTime

public long getLastReloadTime()

Specified by:

getLastReloadTime in interface IFactoryInfoProvider

Returns:

the time of the last reload of the config by this factory. Expects a format such as returned by System.currentTimeMillis(). An implementing class might also return -1 to indicate, that no information is available.