org.nuxeo.ecm.platform.reporting.engine

Class ReportComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.reporting.engine.ReportComponent

All Implemented Interfaces:

ReportService, Adaptable, Component, Extensible, TimestampedService

public class ReportComponent
extends DefaultComponent
implements ReportService

Component Implementation of the ReportService interface. Mainly encapsulate NXQL queries.

Author:

Tiry (tdelprat@nuxeo.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIRT_REPORTS_CONTAINER_PATH

Constructor Summary

Constructors

Constructor and Description
ReportComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	deactivate(ComponentContext context) Deactivates the component.
List<ReportModel>	getReportAvailableModels(CoreSession session)
ReportInstance	getReportInstanceByKey(CoreSession session, String key)
List<ReportInstance>	getReportInstanceByModelName(CoreSession session, String reportModelName)
ReportModel	getReportModelByName(CoreSession session, String reportModelName)
String	getReportModelsContainer()

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerContribution, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

BIRT_REPORTS_CONTAINER_PATH

public static final String BIRT_REPORTS_CONTAINER_PATH

See Also:

Constant Field Values

Constructor Detail

ReportComponent

public ReportComponent()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

getReportInstanceByModelName

public List<ReportInstance> getReportInstanceByModelName(CoreSession session,
                                                String reportModelName)
                                                  throws ClientException

Specified by:

getReportInstanceByModelName in interface ReportService

Throws:

ClientException

getReportInstanceByKey

public ReportInstance getReportInstanceByKey(CoreSession session,
                                    String key)
                                      throws ClientException

Specified by:

getReportInstanceByKey in interface ReportService

Throws:

ClientException

getReportModelsContainer

public String getReportModelsContainer()

Specified by:

getReportModelsContainer in interface ReportService

getReportModelByName

public ReportModel getReportModelByName(CoreSession session,
                               String reportModelName)
                                 throws ClientException

Specified by:

getReportModelByName in interface ReportService

Throws:

ClientException

getReportAvailableModels

public List<ReportModel> getReportAvailableModels(CoreSession session)
                                           throws ClientException

Specified by:

getReportAvailableModels in interface ReportService

Throws:

ClientException