com.communote.server.widgets

Class SimpleWidgetFactory

java.lang.Object

com.communote.server.widgets.SimpleWidgetFactory

All Implemented Interfaces:

WidgetFactory

Direct Known Subclasses:

ExtendableWidgetFactory

public class SimpleWidgetFactory
extends Object
implements WidgetFactory

Factory that uses reflection to create widget instances. The FQN of the class of the widget is derived from group and widget name by interpreting the group as a package name and the widget type name as the class name. Any slashes in the group name will be replaced with dots. The class is than loaded with the current class loader.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
SimpleWidgetFactory()

Method Summary

Modifier and Type	Method and Description
Widget	createWidget(String widgetGroupName, String widgetName, Map<String,String[]> requestParameters) Create a new widget instance that should handle the current widget request.
void	setWidgetPackagePrefix(String widgetPackagePrefix) Set an optional package prefix to interpret the widget group as a relative package and thus only resolve widgets which are in a sub-package of that package.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleWidgetFactory

public SimpleWidgetFactory()

Method Detail

createWidget

public Widget createWidget(String widgetGroupName,
                           String widgetName,
                           Map<String,String[]> requestParameters)
                    throws WidgetCreationException

Description copied from interface: WidgetFactory

Create a new widget instance that should handle the current widget request.

Specified by:

createWidget in interface WidgetFactory

Parameters:

widgetGroupName - the group of the widget

widgetName - the name of the widget

requestParameters - the request parameters of the current request

Returns:

the new widget instance

Throws:

WidgetCreationException - in case the widget cannot be created

setWidgetPackagePrefix

public void setWidgetPackagePrefix(String widgetPackagePrefix)

Set an optional package prefix to interpret the widget group as a relative package and thus only resolve widgets which are in a sub-package of that package.

Parameters:

widgetPackagePrefix - the package prefix used by this instance to resolve the widget classes