net.sf.jasperreports.jsf.context
Class JRFacesContext

java.lang.Object
  net.sf.jasperreports.jsf.context.JRFacesContext

Direct Known Subclasses:

JRFacesContextWrapper

public abstract class JRFacesContext
extends Object

The specific plugin's faces' context.

Author:

A. Alonso Dominguez

Field Summary

protected static String

INSTANCE_KEY Singleton instance key.

Constructor Summary

JRFacesContext()

Method Summary

abstract ReportConverter	createReportConverter(javax.faces.context.FacesContext context, UIReport component)
abstract Resource	createResource(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String name) Creates a new report instance.
abstract SourceConverter	createSourceConverter(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Instantiates a source converter appropiate for the given component.
abstract Collection<String>	getAvailableExportFormats() Collection of availbale export formats.
abstract Collection<String>	getAvailableSourceTypes() Collection of available source types.
abstract Exporter	getExporter(javax.faces.context.FacesContext context, UIReport component) Obtains the report's exporter instance.
abstract ExternalContextHelper	getExternalContextHelper(javax.faces.context.FacesContext context) Obtains the external context helper instance.
abstract Filler	getFiller(javax.faces.context.FacesContext context, UIReport component) Obtains the report's filler instance.
static JRFacesContext	getInstance(javax.faces.context.FacesContext context) Obtains a singleton context instance.
abstract Collection<ContentType>	getSupportedContentTypes()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE_KEY

protected static final String INSTANCE_KEY

Singleton instance key.

Constructor Detail

JRFacesContext

public JRFacesContext()

Method Detail

getInstance

public static JRFacesContext getInstance(javax.faces.context.FacesContext context)

Obtains a singleton context instance.

Parameters:

context - current faces' context.

Returns:

the singleton instance.

getAvailableSourceTypes

public abstract Collection<String> getAvailableSourceTypes()

Collection of available source types.

Returns:

collection of available source types.

getAvailableExportFormats

public abstract Collection<String> getAvailableExportFormats()

Collection of availbale export formats.

Returns:

collection of available export formats.

getSupportedContentTypes

public abstract Collection<ContentType> getSupportedContentTypes()

getExternalContextHelper

public abstract ExternalContextHelper getExternalContextHelper(javax.faces.context.FacesContext context)

Obtains the external context helper instance.

Parameters:

context - current faces' context.

Returns:

the external context helper.

createSourceConverter

public abstract SourceConverter createSourceConverter(javax.faces.context.FacesContext context,
                                                      javax.faces.component.UIComponent component)

Instantiates a source converter appropiate for the given component.

Parameters:

context - current faces' context.

component - the component which is asking the source converter.

Returns:

a source converter instance.

createReportConverter

public abstract ReportConverter createReportConverter(javax.faces.context.FacesContext context,
                                                      UIReport component)

createResource

public abstract Resource createResource(javax.faces.context.FacesContext context,
                                        javax.faces.component.UIComponent component,
                                        String name)

Creates a new report instance.

Parameters:

context - current faces' context.

component - a report component.

name - resource name.

Returns:

a resource instance.

getFiller

public abstract Filler getFiller(javax.faces.context.FacesContext context,
                                 UIReport component)

Obtains the report's filler instance.

Parameters:

context - current faces' context.

component - the report component.

Returns:

a filler instance.

getExporter

public abstract Exporter getExporter(javax.faces.context.FacesContext context,
                                     UIReport component)

Obtains the report's exporter instance.

Parameters:

context - current faces' context.

component - the report component

Returns:

an exporter instance.