Class ReportGenerator


  • public class ReportGenerator
    extends Object
    The report generator service.
    • Constructor Detail

      • ReportGenerator

        public ReportGenerator()
    • Method Detail

      • generate

        public void generate​(OutputStream output,
                             String designName,
                             String format,
                             Map<String,​Object> params)
                      throws IOException,
                             org.eclipse.birt.core.exception.BirtException
        Generate a report for the given report design.
        Parameters:
        output - the report output stream
        designName - report design
        format - output format (e.g. pdf, html etc)
        params - report parameters
        Throws:
        IOException - if an I/O exception occurs
        org.eclipse.birt.core.exception.BirtException - if rendering fails
      • generate

        public void generate​(OutputStream output,
                             String designName,
                             String format,
                             Map<String,​Object> params,
                             Locale locale)
                      throws IOException,
                             org.eclipse.birt.core.exception.BirtException
        Generate a report for the given report design.
        Parameters:
        output - the report output stream
        designName - report design
        format - output format (e.g. pdf, html etc)
        params - report parameters
        locale - report output locale
        Throws:
        IOException - if an I/O exception occurs
        org.eclipse.birt.core.exception.BirtException - if rendering fails
      • generate

        public File generate​(String designName,
                             String format,
                             Map<String,​Object> params)
                      throws IOException,
                             org.eclipse.birt.core.exception.BirtException
        Generate a report to a temporary file and return path to the generated file.
        Parameters:
        designName - report design name
        format - output format
        params - report parameters
        Returns:
        Path to the generated file
        Throws:
        IOException - if an I/O exception occurs
        org.eclipse.birt.core.exception.BirtException - if rendering fails
      • generate

        public File generate​(String designName,
                             String format,
                             Map<String,​Object> params,
                             Locale locale)
                      throws IOException,
                             org.eclipse.birt.core.exception.BirtException
        Generate a report to a temporary file and return path to the generated file.
        Parameters:
        designName - report design name
        format - output format
        params - report parameters
        locale - report output language
        Returns:
        Path to the generated file
        Throws:
        IOException - if an I/O exception occurs
        org.eclipse.birt.core.exception.BirtException - if rendering fails