net.sf.jasperreports.engine.export

Class GenericElementHandlerEnviroment

java.lang.Object

net.sf.jasperreports.engine.export.GenericElementHandlerEnviroment

public final class GenericElementHandlerEnviroment
extends Object

A class that provides access to generic element handlers.

Generic element handler bundles are registered as JasperReports extensions of type GenericElementHandlerBundle via the central extension framework (see ExtensionsEnvironment).

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCEPTION_MESSAGE_KEY_HANDLERS_NOT_FOUND_FOR_NAMESPACE

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,GenericElementHandlerBundle>	getBundles()
GenericElementHandler	getElementHandler(JRGenericElementType type, String exporterKey) Returns a handler for a generic print element type and an exporter key.
static GenericElementHandlerEnviroment	getInstance(JasperReportsContext jasperReportsContext)
protected Map<String,GenericElementHandlerBundle>	loadBundles()

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTION_MESSAGE_KEY_HANDLERS_NOT_FOUND_FOR_NAMESPACE

public static final String EXCEPTION_MESSAGE_KEY_HANDLERS_NOT_FOUND_FOR_NAMESPACE

See Also:

Constant Field Values

Method Detail

getInstance

public static GenericElementHandlerEnviroment getInstance(JasperReportsContext jasperReportsContext)

getElementHandler

public GenericElementHandler getElementHandler(JRGenericElementType type,
                                      String exporterKey)

Returns a handler for a generic print element type and an exporter key.

The method first locates a handler bundle that matches the type namespace, and then uses GenericElementHandlerBundle.getHandler(String, String) to resolve an export handler.

Parameters:

type - the generic element type

exporterKey - the exporter key

Returns:

a generic print element handler

Throws:

JRRuntimeException - if a handler does not exist for the combination of element type and exporter key

getBundles

protected Map<String,GenericElementHandlerBundle> getBundles()

loadBundles

protected Map<String,GenericElementHandlerBundle> loadBundles()