com.sapportals.wcm.rendering.collection

Class CollectionRendererFactory

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

All Implemented Interfaces:

IFactoryInfoProvider

public final class CollectionRendererFactory

extends AbstractFactory

This class is a singleton factory, creating new instances of ICollectionRenderer. These instances are ready-to-use, as the factory takes care of the initialization. This includes the setting of the member variables of the renderer. See ICollectionRenderer for details. The factory reads out mapping information from the configuration framework. It uses the mapping entries in the configuration to create in internal HashMap that holds an instance of each ICollectionRenderer specified in the configuration. The alias-attribute of the mapping is used as the key for the HashMap entries. The factory reacts on events from the config. If an event is received, the HashMap is cleared and all instances are newly created. If an exception occurs while filling the map, the map is cleared again and only the default-renderer specified in this factory will be usable.

Nested Class Summary

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

IFactoryInfoProvider.MappingInformation

Field Summary

Fields inherited from class com.sapportals.wcm.rendering.base.AbstractFactory

category, classkey, configclass, configplugin, CONFIGURATION_FORMAT_LIST, CONFIGURATION_FORMAT_TABLE, CONFIGURATION_FORMAT_TABLE_NO_HEADER, default_config, default508_config, default508class, defaultclass, descriptiveName

Method Summary

ICollectionRenderer	getCollectionRenderer(IProxy proxy, ICollection currentFolder, ICollection customizingCollection, IFlavor flavor)
ICollectionRenderer	getCollectionRenderer(IProxy proxy, ICollection collection, IFlavor flavor)
ICollectionRenderer	getCollectionRenderer(IProxy proxy, ITypedResourceList resourcelist, IFlavor flavor)
String	getCollectionRendererConfiguration(String format) returns a formatted list including all configured ICollectionRenderer with their attributes and settings.
String	getFactoryName()
static CollectionRendererFactory	getInstance()

Methods inherited from class com.sapportals.wcm.rendering.base.AbstractFactory

configEvent, getConfigListenerId, getConfiguration, getLastReloadTime, getLayoutObject, getLayoutObject, getMappings, getStatus, initialize

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static CollectionRendererFactory getInstance()

Returns:

the singleton instance of the CollectionRendererFactory. When this method is first called, the singleton instance reads out the configuration and fills its internal HashMap of ICollectionRenderer

getCollectionRendererConfiguration

public String getCollectionRendererConfiguration(String format)

returns a formatted list including all configured ICollectionRenderer with their attributes and settings. This is only used for documentation purposes.

Parameters:

format - the format requested. See AbstractFactory for supported formats

Returns:

the formatted list

getCollectionRenderer

public ICollectionRenderer getCollectionRenderer(IProxy proxy,
                                                 ICollection collection,
                                                 IFlavor flavor)
                                          throws WcmException

Parameters:

proxy - the IProxy that acts as the outer container for the rendering

collection - the collection that needs a renderer

flavor - description, what kind of ICollectionRenderer is wanted, e.g. "Taxonomy" or "ImageMap"

Returns:

ICollectionRenderer - a new instance that is ready to use by the calling class: The parameters, the resource and the proxy and context are set. This call is threadsafe, for every call (even with the same parameters) a new instance of the ICollectionRenderer is returned

Throws:

WcmException

getCollectionRenderer

public ICollectionRenderer getCollectionRenderer(IProxy proxy,
                                                 ICollection currentFolder,
                                                 ICollection customizingCollection,
                                                 IFlavor flavor)
                                          throws WcmException

Parameters:

proxy - the IProxy that acts as the outer container for the rendering

currentFolder - the collection that needs a renderer

customizingCollection - the collection that is used to retrieve additional configuration

flavor - description, what kind of ICollectionRenderer is wanted, e.g. "Taxonomy" or "ImageMap"

Returns:

ICollectionRenderer - a new instance that is ready to use by the calling class: The parameters, the resource and the proxy and context are set. This call is threadsafe, for every call (even with the same parameters) a new instance of the ICollectionRenderer is returned

Throws:

WcmException

getCollectionRenderer

public ICollectionRenderer getCollectionRenderer(IProxy proxy,
                                                 ITypedResourceList resourcelist,
                                                 IFlavor flavor)
                                          throws WcmException

Parameters:

proxy - the IProxy that acts as the outer container for the rendering

resourcelist - the resourcelist that needs a renderer

flavor - description, what kind of ICollectionRenderer is wanted, e.g. "Taxonomy" or "ImageMap"

Returns:

ICollectionRenderer - a new instance that is ready to use by the calling class: The parameters, the resource and the proxy and context are set. This call is threadsafe, for every call (even with the same parameters) a new instance of the ICollectionRenderer is returned

Throws:

WcmException

getFactoryName

public String getFactoryName()

Returns:

a human-readable name of the factory, must not be null