org.nuxeo.ecm.platform.reporting.api

Class BirtReportInstance

java.lang.Object

org.nuxeo.ecm.platform.reporting.api.BaseBirtReportAdapter

org.nuxeo.ecm.platform.reporting.api.BirtReportInstance

All Implemented Interfaces:

ReportInstance

public class BirtReportInstance
extends BaseBirtReportAdapter
implements ReportInstance

This is the implementation of the ReportInstance adapter. Holds most of the rendering logic.

Author:

Tiry (tdelprat@nuxeo.com)

Constructor Summary

Constructors

Constructor and Description
BirtReportInstance(DocumentModel doc)

Method Summary

Methods

Modifier and Type	Method and Description
ReportModel	getModel() Return the associated ReportModel
String	getReportKey() Get the key used to uniquely identify the report instance This key is used in REST urls.
List<ReportParameter>	getReportParameters() Get All reports parameters : merging model parameters with instance parameters
List<ReportParameter>	getReportUserParameters() Get report parameters that can be entered by the user.
Map<String,String>	getStoredParameters() Get parameters as storef in thi resport instance
void	initParameterList() Initialize the parameters from the associated model
void	render(org.eclipse.birt.report.engine.api.IRenderOption options, Map<String,Object> userParameters) Starts the rendering of the report according to IRenderOption
void	setReportKey(String key) Sets the report key (used from a Core Listener)

Methods inherited from class org.nuxeo.ecm.platform.reporting.api.BaseBirtReportAdapter

getDoc, setParameter, setParameter, setParameter, setParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.reporting.api.ReportInstance

getDoc, setParameter, setParameter

Constructor Detail

BirtReportInstance

public BirtReportInstance(DocumentModel doc)

Method Detail

getModel

public ReportModel getModel()
                     throws ClientException

Description copied from interface: ReportInstance

Return the associated ReportModel

Specified by:

getModel in interface ReportInstance

Returns:

Throws:

ClientException

getStoredParameters

public Map<String,String> getStoredParameters()
                                       throws ClientException

Description copied from interface: ReportInstance

Get parameters as storef in thi resport instance

Specified by:

getStoredParameters in interface ReportInstance

Returns:

Throws:

ClientException

getReportParameters

public List<ReportParameter> getReportParameters()
                                          throws IOException

Description copied from interface: ReportInstance

Get All reports parameters : merging model parameters with instance parameters

Specified by:

getReportParameters in interface ReportInstance

Specified by:

getReportParameters in class BaseBirtReportAdapter

Returns:

Throws:

IOException

getReportUserParameters

public List<ReportParameter> getReportUserParameters()
                                              throws IOException

Description copied from interface: ReportInstance

Get report parameters that can be entered by the user. This is used to generate the parameter form at rendering time.

Specified by:

getReportUserParameters in interface ReportInstance

Returns:

Throws:

IOException

initParameterList

public void initParameterList()
                       throws IOException

Description copied from interface: ReportInstance

Initialize the parameters from the associated model

Specified by:

initParameterList in interface ReportInstance

Throws:

IOException

render

public void render(org.eclipse.birt.report.engine.api.IRenderOption options,
          Map<String,Object> userParameters)
            throws IOException

Description copied from interface: ReportInstance

Starts the rendering of the report according to IRenderOption

Specified by:

render in interface ReportInstance

Throws:

IOException

getReportKey

public String getReportKey()

Description copied from interface: ReportInstance

Get the key used to uniquely identify the report instance This key is used in REST urls.

Specified by:

getReportKey in interface ReportInstance

Returns:

setReportKey

public void setReportKey(String key)
                  throws ClientException

Description copied from interface: ReportInstance

Sets the report key (used from a Core Listener)

Specified by:

setReportKey in interface ReportInstance

Throws:

ClientException