com.elixirtech.report2.runtime
Interface IReportEngine

public interface IReportEngine

IReportEngine provides reporting functionality.

Method Summary

IJobInfo	generateData(java.lang.String dataSource, java.io.OutputStream outputStream, java.util.Map<java.lang.String,java.lang.String> props) Triggers a datasource to generate it's tabular data.
IJobInfo	generateData(java.lang.String dataSource, java.io.OutputStream outputStream, java.util.Properties props) Deprecated. Use the Map version instead of Properties
IJobInfo	generateData(java.lang.String dataSource, java.lang.String dataStore, java.util.Map<java.lang.String,java.lang.String> props) Triggers a composite datasource to generate data to one of it's datastores.
IJobInfo	generateData(java.lang.String dataSource, java.lang.String dataStore, java.util.Properties props) Deprecated. Use the Map version instead of Properties
IFileSystem	getFileSystem(java.lang.String name) Get a list of filesystem.
java.lang.String[]	getFileSystems() Get a list of filesystems.
com.elixirtech.report2.raw.model.RawReport	getRawReport(java.lang.String reportName) Allows direct manipulation of the template parameters at run-time
IJobInfo	renderReport(com.elixirtech.report2.raw.model.RawReport rawReport, java.lang.String mimeType, java.io.OutputStream outputStream, java.util.Map<java.lang.String,java.lang.String> props) Renders the required .rml from the repository in the required mime type to the provided output stream
IJobInfo	renderReport(com.elixirtech.report2.raw.model.RawReport rawReport, java.lang.String mimeType, java.io.OutputStream outputStream, java.util.Properties props) Deprecated. Use the Map version instead of Properties

Method Detail

getFileSystems

java.lang.String[] getFileSystems()

Get a list of filesystems.

getFileSystem

IFileSystem getFileSystem(java.lang.String name)

Get a list of filesystem.

getRawReport

com.elixirtech.report2.raw.model.RawReport getRawReport(java.lang.String reportName)
                                                        throws java.io.IOException

Allows direct manipulation of the template parameters at run-time

Parameters:

reportName - .rml file with its full path relative to the repository root

Returns:

RawReport

Throws:

java.io.IOException

renderReport

@Deprecated
IJobInfo renderReport(com.elixirtech.report2.raw.model.RawReport rawReport,
                                 java.lang.String mimeType,
                                 java.io.OutputStream outputStream,
                                 java.util.Properties props)
                      throws com.elixirtech.data2.DataException,
                             com.elixirtech.report2.RenderException

Deprecated. Use the Map version instead of Properties

Renders the required .rml from the repository in the required mime type to the provided output stream

Parameters:

rawReport -

mimeType -

outputStream - to which the report will be rendered

props - set of Properties that may contain dynamic parameters.

Returns:

JobInfo Information of the result of report generated

Throws:

com.elixirtech.data2.DataException

com.elixirtech.report2.RenderException

renderReport

IJobInfo renderReport(com.elixirtech.report2.raw.model.RawReport rawReport,
                      java.lang.String mimeType,
                      java.io.OutputStream outputStream,
                      java.util.Map<java.lang.String,java.lang.String> props)
                      throws com.elixirtech.data2.DataException,
                             com.elixirtech.report2.RenderException

Renders the required .rml from the repository in the required mime type to the provided output stream

Parameters:

rawReport -

mimeType -

outputStream - to which the report will be rendered

props - map that contains any dynamic parameters.

Returns:

JobInfo Information of the result of report generated

Throws:

com.elixirtech.data2.DataException

com.elixirtech.report2.RenderException

generateData

@Deprecated
IJobInfo generateData(java.lang.String dataSource,
                                 java.lang.String dataStore,
                                 java.util.Properties props)
                      throws com.elixirtech.data2.DataException

Deprecated. Use the Map version instead of Properties

Triggers a composite datasource to generate data to one of it's datastores.

Parameters:

dataSource - The full path of the composite datasource in the repository

dataStore - The name of the dataStore in the composite to generate into

props - Any parameters required by the datasource

Returns:

JobInfo Information of the result of report generated

Throws:

com.elixirtech.data2.DataException

generateData

IJobInfo generateData(java.lang.String dataSource,
                      java.lang.String dataStore,
                      java.util.Map<java.lang.String,java.lang.String> props)
                      throws com.elixirtech.data2.DataException

Triggers a composite datasource to generate data to one of it's datastores.

Parameters:

dataSource - The full path of the composite datasource in the repository

dataStore - The name of the dataStore in the composite to generate into

props - Any parameters required by the datasource

Returns:

JobInfo Information of the result of report generated

Throws:

com.elixirtech.data2.DataException

generateData

@Deprecated
IJobInfo generateData(java.lang.String dataSource,
                                 java.io.OutputStream outputStream,
                                 java.util.Properties props)
                      throws com.elixirtech.data2.DataException

Deprecated. Use the Map version instead of Properties

Triggers a datasource to generate it's tabular data. In the case of a composite datasource this will be the Result output.

Parameters:

dataSource - The full path of the composite datasource in the repository

outputStream - The tabular data will be written here (XML)

props - Any parameters required by the datasource

Returns:

JobInfo Information of the result of report generated

Throws:

com.elixirtech.data2.DataException

generateData

IJobInfo generateData(java.lang.String dataSource,
                      java.io.OutputStream outputStream,
                      java.util.Map<java.lang.String,java.lang.String> props)
                      throws com.elixirtech.data2.DataException

Triggers a datasource to generate it's tabular data. In the case of a composite datasource this will be the Result output.

Parameters:

dataSource - The full path of the composite datasource in the repository

outputStream - The tabular data will be written here (XML)

props - Any parameters required by the datasource

Returns:

JobInfo Information of the result of report generated

Throws:

com.elixirtech.data2.DataException