第十三章 BIRT報表引擎API及報表API

13.1報表引擎詳解，API結構

BIRT包含幾個引擎。一個引擎是一個提供一個特定領域的功能的一套Java API。例如，數據引擎包含管理數據的API，圖表引擎包含生成一個圖表的API。一般而言，BIRT包含四個引擎，報表設計引擎（design Engine），報表引擎(report engine)，圖表引擎(chat engine)，數據引擎(data engine)。

a) 關於報表設計引擎

報表設計引擎包含驗證一個報表設計文件的有效性和生成一個報表設計文件的API。報表設計引擎被BIRT Report Designer和任何定製的生成一個BIRT報表設計的Java應用程序所使用。生成引擎在創建一個報表文檔時也使用報表設計引擎。報表設計引擎包含使用ROM技術規範來驗證設計文件的元素和結構的有效性的API。

b) 關於報表引擎

報表引擎包含兩部分：生成引擎和展示引擎。BIRT Report Viewer和定製的Java應用程序使用報表引擎來處理一個報表設計並按照設計中指定的格式生成報表。生成引擎包含讀取和解釋一個報表設計的API。生成引擎使用數據引擎來讀取和轉換來自由報表設計標識的數據源。生成引擎的輸出是一個報表文檔，這是一個報表產品中的一箇中間文檔。展示引擎處理由生成引擎創建的報表文檔並按設計中指定的格式產生報表。和生成引擎一樣，展示引擎也使用數據引擎。但是，在展示階段，數據引擎從報表文件而不是數據源中獲取數據。展示引擎它需要的任何一個報表發射器按照設計中指定的格式生成一個報表。BIRT有兩個標準的發射器，HTML和PDF。BIRT也支持不是HTML和PDF格式的定製的發射器。圖表報表項和定製的報表項擴展展示引擎來提供這些報表項的展示功能。

c) 關於圖表引擎

圖標引擎包含生成圖表及將圖表與來自數據源的數據關聯起來的API。圖表引擎的使用不僅限於BIRT應用程序。任何Java程序都可以使用圖表引擎來創建和現實一個圖表。BIRT Report Viewer 解釋報表設計中的圖標設計信息並使用圖表引擎來生成圖表。

d) 關於數據引擎

數據引擎包含獲取和轉換數據的API。當被生成引擎使用時，數據引擎直接從數據源中獲取數據。當被展示引擎使用時，數據引擎從報表文檔中獲取數據。

1） 關於數據引擎組件

數據引擎包含兩個主要組件：數據訪問組件和數據轉換組件。數據訪問組件與ODA框架通信來獲取數據。數據引擎的數據轉換組件執行像排序、分組、累計和過濾來自數據訪問組件的數據的操作。

2） 關於ODA框架

ODA框架管理ODA和本地驅動、裝載驅動、打開連接並管理數據請求。ODA框架使用Eclipse Data Tools Platform項目來管理連接。ODA框架包含擴展點，籍此可以添加一個定製的ODA驅動。數據引擎擴展用於數據源的連接方法和驅動。如果有一個BIRT不支持的數據源就需要一個定製的ODA驅動。創建一個定製的ODA驅動時可能不僅需要擴展數據引擎而且還需要擴展BIRT Report Designer。如果數據源需要一個GUI組件來制定數據集，那麼還需要一個BIRT Report Designer擴展。

 

應用開發者只需要瞭解公用的API，這些API包含在以下的幾個包內：

a) org.eclipse.birt.report.model.api：這個包內包含了93個class，兩個接口和一個exception，這個包是爲那些想要定製report designer的開發者使用的,報表設計引擎包含這個包

b) org.eclipse.birt.report.engine.api：這個包包含了一個類，17個接口和四個exception，是給那些想要定製一個report generator的開發者使用的，報表引擎包含這個包

c) org.eclipse.birt.charthierarchy：這個包是給想定製一個chartgenerator的開發者使用的，圖表引擎包含這個包

BIRT報表引擎（BIRT report engine）在幾個環境提供了報表生成和翻譯服務，包含在以下組件中：

a) Stand-alone engine：這個engine可以讓開發者使用一個命令行程序來從一個report design文件(.rptdesign)中得到Html或PDF格式的report

b) BIRT report viewer：BIRT Report Designer使用它來預覽report。這個程序是一個web程序，它運行在一個Eclipse內嵌的Tomcat中，這個Tomcat中有一個內嵌的report engine

c) Custom report designer with an embedded engine：一個定製的桌面報表應用集成BIRT report engine來預覽報表

d) Web application that embeds the engine：一個類似於BIRT report viewer的Web程序，可以產生基於web的報表。

 

如下圖所示：

另外，用戶還能定製報表引擎，除了通常是集成到一個Web應用或者一個獨立的Java應用程序外，定製的Java報表生成器質性和BIRT報表生成器相同的功能。和BIRT 報表瀏覽器Web應用一樣，定製的Java報表生成器使用報表引擎的API來讀取報表設計文件並生成一個報表。一個定製的業務邏輯來管理安全事宜、控制目錄和確定輸出的格式。

 

Report engine的核心engine運行並實施報表，而將其他的環境相關的任務留給運行該引擎的應用程序，比如：URLconstruction, image storage, and design file caching

BIRT report engine的API可以做以下幾件事情：

a) 發現一組爲報表定義的參數（包括動態參數和級聯參數）

b) 獲得參數的默認值

c) 產生任務（task）實施操作的應用

d）包含1到2個操作階段（(RunTask 然後 Render Task 或者RunAndRenderTask)

d) 爲報表產生圖片或chart

e) 產生報表文檔

f) 運行報表產生HTML或PDF格式的輸出

EngineConfig –設置報表引擎可選的參數.

ReportEngine – 用於運行一到多個報表任務

IReportRunnable –用於打開報表設計文檔，並把句柄傳給報表任務

IReportDocument – 用於打開報表文檔，並把句柄傳給報表任務，同時包含很多方法用於獲TOC,數據等等

HTMLRenderContext – 定義展示HTML的環境，例如設置HTML圖片地址，事件處理

PDFRenderContext – 定義展示PDF的環境，例如設置字體的地址，事件處理

HTMLRenderOption – 用於設置html的可選選項，比如導出時的路徑

報表設計引擎（Design Engine）需要完成的事情：

1、用於產生或者修改報表設計文檔，報表模板文檔，報表庫文檔

2、有時候報表引擎需要修改報表設計文檔，這個時候就需要調用報表設計引擎

3、如果報表引擎在運行時，事件機制和腳本機制中本身就包含修改報表設計的代碼，這個時候也要調用報表設計引擎

4、用於獲取和設置報表參數

5、可以用於獲取報表設計的種種屬性和參數

用戶還能定製報表設計器，一個定製的報表設計器是一個由Java開發人員創建的用來基於特定的需求生成一個格式良好的報表設計文件Java應用程序。定製的報表設計器不需要包含用戶界面。定製的報表設計起的一個典型的例子是一個動態確定一個報表的目錄、結構或者數據元的Java應用程序。定製的報表設計器使用和BIRTReport Designer相同的設計引擎API。

圖表引擎用於產生圖表，展示圖表，修改圖表，是一個比較獨立的引擎。通常包含兩個API包：

org.eclipse.birt.chart.model.*，org.eclipse.birt.chart.*

一般報表設計器在產生一份包含圖表的設計文檔的時候，都要調用圖表的設計和展示引擎，但圖表引擎不僅僅包含在報表設計器的類庫中，報表在展示階段如果包含圖表，或者需要修改圖表的時候，也會調用圖表的引擎。

事實上，birt提供的開源產品Report Designer，Example Viewer都包含這三個引擎（報表設計引擎，報表引擎，圖表引擎），所以用戶在自定義設計器，自定義web展示器，自定義獨立運行的展示器的時候，最好也要包含這三類引擎。

構建一個報表的必須工作：

創建和配置報表引擎
單個報表引擎可以通過創建多個設計器來生成多個報表。通過Platform.createFactoryObject()方法創建一個ReportEngine對象。設置BIRT目錄，指向需要的plug-in和庫。

打開報表文檔（*.rptdesign 或 *.rptdocument）
通過ReportEngine對象的openReportDesign( )打開一個報表設計模版，參數是文件路徑名或InputStream，返回一個IReportRunnable對象。
通過ReportEngine對象的openReportDocument( )打開一個報表文檔，參數是文件路徑名，返回一個IReportDocument對象。

連接數據源
通過創建數據連接或使用應用程序提供的連接爲數據集提供數據源。

報表生成的準備工作
用一個IRenderOption對象設置輸出格式，輸出文件名，輸出流或輸出位置，和一些特定格式設置。HTMLRenderOption支持HTML格式的輸出，輸出PDF格式使用RenderOption

生成報表
使用IRunAndRenderTask對象生成IReportRunnable類型的報表，使用IRenderTask對象創建IReportDocument類型的報表。
也可以訪問部署在應用程序服務器上的report viewer servlet來生成報表。

銷燬引擎
當我們不再需要使用報表引擎時將它銷燬。

可選的任務：

獲取參數
如果報表中設置了參數，引擎要使用傳入的參數生成報表，如果沒有傳入參數則使用默認值。

創建報表文檔文件（*.rptdocument）
報表文檔文件已二進制的形式存儲的，如果應用程序使用報表設計文件，要通過IRunTask對象生成一個IReportDocument對象的報表文檔。

從報表文檔導出數據。
使用IDataExtractionTask對象在報表文檔中導出一項或多項的值。


開發環境要求
把需要的類庫都引入classpath或開發工具中。配置BIRT目錄，目錄中包含了從報表設計文件生成報表所需要的plug-in和類庫。 BIRT的報表引擎包在他的ReportEngine子目錄裏提供了完整的BIRT home。如果你想動手修改BIRT源碼的話，一定要保證源碼的版本與BIRT home中的plug-in和類庫的版本是一致的。

類庫和plug-in
BIRT home的ReportEngine\lib子目錄和ReportEngine\plugins中包含了報表應用程序需要的用到的類庫和plug-in，你可以根據自己項目的情況刪除掉不用的包。

jdbc驅動
BIRT home的plugins/org.eclipse.birt.report.data.oda.jdbc_...文件夾用於存放連接數據庫所需要的驅動程序，你可以把需要的驅動程序包放到該目錄下（引入classpath中好像是不起作用的…）

通過api修改報表設計模版
報表應用程序在生成報表前可以修改報表設計模版。如：添加刪除數據項，更深入的定製報表等。DesignEngine API提供了修改設計模版（包括修改腳本）DesignEngine的主要接口在org.eclipse.birt.model.api包中。

下面給出一個簡單的例子：

該報表的設計如下：

數據集上有事件處理綁定：

需要在報表的資源中導入事件處理包：

預覽如下：

報表引擎的源碼如下：

package REAPI;
import java.util.logging.Level;
import org.eclipse.birt.core.framework.Platform;
import org.eclipse.birt.report.engine.api.EXCELRenderOption;
import org.eclipse.birt.report.engine.api.EngineConfig;
import org.eclipse.birt.report.engine.api.EngineConstants;
import org.eclipse.birt.report.engine.api.EngineException;
import org.eclipse.birt.report.engine.api.HTMLRenderOption;
import org.eclipse.birt.report.engine.api.IReportEngine;
import org.eclipse.birt.report.engine.api.IReportEngineFactory;
import org.eclipse.birt.report.engine.api.IReportRunnable;
import org.eclipse.birt.report.engine.api.IRunAndRenderTask;
import org.eclipse.birt.report.engine.api.PDFRenderOption;


public class RunAndRenderTask {

    public void runReport() throws EngineException
    {

        IRunAndRenderTask task=null;
        IReportEngine engine=null;
        EngineConfig config = null;

        try{
            //System.setProperty("java.io.tmpdir", "c:/temp/test/testsampledb");
            config = new EngineConfig( );
            config.setLogConfig("d:\\dwn.txt", Level.INFO);
            config.getAppContext().put(EngineConstants.APPCONTEXT_CLASSLOADER_KEY, this.getClass().getClassLoader());
            config.getAppContext().put(EngineConstants.WEBAPP_CLASSPATH_KEY, "d:\\eventjar.jar");
            config.setBIRTHome("E:\\birt漢化包\\birt-runtime-3_7_2\\ReportEngine");
            //config.setLogConfig(null, Level.FINEST);
            Platform.startup( config );

            IReportEngineFactory factory = (IReportEngineFactory) Platform
            .createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
            engine = factory.createReportEngine( config );


        IReportRunnable design = null;
        //Open the report design

        design = engine.openReportDesign("d:\\dataseteventhandler.rptdesign");
        task = engine.createRunAndRenderTask(design);
        //task.setParameterValue("Top Count", (new Integer(5)));
        task.validateParameters();


        HTMLRenderOption options = new HTMLRenderOption();
        options.setImageDirectory("d:\\");
        options.setOutputFileName("d:\\eventhandlerjar.html");
        options.setOutputFormat("html");

        //PDFRenderOption options = new PDFRenderOption();
        //options.setOutputFileName("d:\\topn.pdf");
        //options.setSupportedImageFormats("PNG;GIF;JPG;BMP;SWF;SVG");
        //options.setOutputFormat("pdf");

        //EXCELRenderOption options = new EXCELRenderOption();
        //options.setOutputFormat("xls");
        //options.setOutputFileName("d:\\customers.xls");
        //options.setWrappingText(true);

        task.setRenderOption(options);
        task.run();
        task.close();
        engine.destroy();
        }catch( Exception ex){
            ex.printStackTrace();
        }
        finally
        {
            if ( !task.getErrors( ).isEmpty( ) )

            {

                for ( Object e : task.getErrors( ) )

                {

                    ( (Exception) e ).printStackTrace( );

                }

            }
            Platform.shutdown( );
            System.out.println("Finished");
        }

    }


    /**
     * @param args
     */
    public static void main(String[] args) {
        try
        {

            RunAndRenderTask ex = new RunAndRenderTask( );
            ex.runReport();

        }
        catch ( Exception e )
        {
            e.printStackTrace();
        }
    }
}

運行，會看到D盤產生eventhandlerjar.html文檔，查看如下：

下面詳細介紹如何構建一個報表應用程序

org.eclipse.birt.report.engine.api包含了用來生成報表的類和接口，其中主要的類和接口有 ReportEngine, EngineConfig, IReportRunnable, IRenderOption以及它的子類，IEngineTask以及它的子類。
在Eclipse提供的Birt集成開發工具的幫助文檔裏有詳細的api參考，不過有點簡略。

一、創建報表引擎

報表引擎是ReportEngine類的一個實例，是任何報表應用程序的關鍵部分。首先用EngineConfig對象來爲ReportEngine準備參數，然後用BIRT報表引擎工廠來創建引擎。創建一個配置對象：
EngineConfig config = new EngineConfig();

設置BIRT home
BIRT home就是BIRT plug-ins和類庫的路徑，它是報表引擎的關鍵參數。
你可以用下面的方式進行BIRT home設置：
■對於獨立的應用程序可以吐過下面的方式設置：
config.setBIRTHome ( "C:/birt-runtime-<version>/ReportEngine" );
■也可以再你自己的環境變量中設置：
set BIRT_HOME="C:\birt-runtime-<version>\ReportEngine"
SET CLASSPATH=%BIRT_HOME%\<required library 1>;
■ 在Web應用程序裏要首先取得絕對路徑讓後設置到config
config.setBIRTHome( servletContext.getRealPath( "/WEB-INF" ) );
■在WAR 文件的Web應用程序中可以使用PlatformServletContext.
config.setBIRTHome( "" );
■ 在Eclipse中,通過VM運行參數設置
-DBIRT_HOME="C:\birt-runtime-<version>\ReportEngine"

設置引擎的其他參數
通過配置對象進行配置的參數還有日誌，OSGI(Open Services Gateway Initiative)，平臺上下文，資源文件，臨時資源文件，腳本等，這些都是可選的參數，詳細信息可以參考EngineConfig的API。

不同運行環境的差異
應用程序是獨立運行的還是以web形式運行的決定了平臺上下文和HTML發射器（emitter，不知道是不是生成器更合適一點）的配置的不同。 平臺上下文提供了報表引擎連接plug-in的機制，默認使用獨立運行的方式。HTML發射器提供了處理圖片和處理超鏈接和標籤事件的功能。

設置上下文
BIRT是一個基於Eclipse的應用程序，因此它使用OSGI平臺來啓動插件來產生報表和設計引擎。BIRT需要的plug-in存儲在 BIRT主目錄下，通過platform context進行配置，它實現了接口org.eclipse.birt.core.framework.IPlatformContext。 context作爲EngineConfig的一個參數通過setEngineContext( )進行設置。
BIRT中提供了兩個IPlatformContext的實現：
PlatformFileContext通過文件系統目錄配置context，用於獨立運行的應用程序和web應用程序中部署的基於系統文件目錄的BIRT應用程序。
IPlatformContext context = new PlatformFileContext( );
config.setEngineContext( context );
對於web應用上部署的BIRT應用程序，使用PlatformServletContext。它使用基於資源連接的J2EE ServletContext來定位BIRT plug-in。它默認使用“/WEB-INF/platform/”
IPlatformContext context =
new PlatformServletContext(request.getSession().getServletContext());
config.setPlatformContext(context);
如果默認的BIRT提供的實現不能滿足你的要求，可以定義自己的實現。

設置HTML emitter
當使用HTML格式生成一個報表，引擎通過一個HTMLRenderOption對象來定義如何處理HTML emitter使用的資源（圖像濾鏡，圖像元素，圖表，書籤等）。桌面應用程序和web應用程序用來處理圖像的方法是不同的。使用HTML emitter首先要創建HTMLRenderOption，使用方法：
HTMLRenderOption ho = new HTMLRenderOption( );
ho.setImageHandler( new HTMLCompleteImageHandler( ));
config.setEmitterConfiguration( RenderOptionBase.OUTPUT_FORMAT_HTML, ho );
創建引擎時可以不必設置HTML emitter，你可以需要生成HTML報表時再去進行配置。
IHTMLImageHandler是用來處理圖像的接口，BIRT提供了兩個IHTMLImageHandler的實現：
HTMLCompleteImageHander可以將圖像保存到文件目錄。它首先使用HTMLRenderOption設置的圖像目錄，如果沒 有則使用EngineConfig.setTempDir( )設置的臨時文件目錄，如果還沒有則使用java.io.tmpdir定義的系統臨時文件目錄。生成的HTML中引用的圖像也是引擎創建的。
HTMLServerImageHandler應用在web應用程序中，它將圖像文件保存在HTMLRenderOption設置的圖像文目錄 中。HTML的圖像的src指向生成的圖像文件的路徑也是在HTMLRenderOption中配置的。這樣報表引擎就可以在本地文件中創建圖像文件，並 且通過URL共享。
ho.setImageDirectory("output/image");
ho.setBaseImageURL("http://myhost/prependme?image=");
如果IHTMLImageHandler得實現不能滿足你的要求，你可以開發自己的實現。或者繼承並重寫已有的image handler。HTMLCompleteImageHander已經提供了足夠的圖像文件接口因此一般情況下不需要我們進行擴展。

啓動平臺
設置完成平臺上下文環境，你可以通過org.eclipse.birt.core.framework.Platform類啓動一個平臺。 Platform是一個Eclipse OSGI平臺的包裝類，提供一個同步的靜態方法startup( )用來啓動平臺，該操作的開銷比較大，因此你的應用程序最好只調用一次。平臺使用結束後調用Platform.shutdown( )關閉。如果你是在Web應用程序裏使用報表引擎，請在servlet的init方法中調用startup方法或者在第一次處理用到平臺的請求時。最好啓 動平臺的代碼封裝爲一個單例。如果你使用Birt提供的Web Viewer或使用基於Eclipse的富客戶端程序（RCP），你就不需要啓動平臺，因爲應用程序已經自己啓動了OSGi。

Platform Class的作用

用於啓動所需要的插件

使用 OSGi.

DE API, CE API and the RE API都需要啓動平臺

使用 PlatformConfig 類去配置startup.

DesignConfig and EngineConfig 是擴展自 PlatformConfig.

PlatformContext 類決定了插件（Plugins）的地址

創建Factory用於產生DesignEngine或者ReportEngine

創建報表引擎
BIRT提供一個工廠服務用於創建ReportEngine對象。Platform.createFactoryObject( )創建一個實現了org.eclipse.birt.report.engine.api.IReportEngineFactory接口的工廠對象。該 方法需要一個PlatformConfig對象。因爲EngineConfig是繼承自PlatformConfig，你可以使用 EngineConfig來創建一個工廠。最後通過IReportEngineFactory.createReportEngine( )方法和剛纔使用的EngineConfig對象創建報表引擎。

實例
在獨立運行的應用程序中創建一個報表引擎，如下：

// Create an EngineConfig object.
EngineConfig config = new EngineConfig( );
// Set up the path to your BIRT home directory.
config.setBIRTHome("E:\\birt漢化包\\birt-runtime-3_7_2\\ReportEngine");
// Explicitly set up the stand-alone application
IPlatformContext context = new PlatformFileContext( );
config.setEngineContext( context );
// Start the platform for a non-RCP application.
Platform.startup( config );
IReportEngineFactory factory = ( IReportEngineFactory ) Platform.createFactoryObject
( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
// Set up writing images or charts embedded in HTML output.
HTMLRenderOption ho = new HTMLRenderOption( );
ho.setImageHandler( new HTMLCompleteImageHandler( ));
config.setEmitterConfiguration( RenderOptionBase.OUTPUT_FORMAT_HTML, ho );
// Create the engine.
IReportEngine engine = factory.createReportEngine( config );

說明：上面一個在windows系統上的獨立運行的應用程序，它使用BIRT run-time提供的BIRT home，報表輸出格式是HTML。

在<span style="font-family:Calibri;">Web</span><span style="font-family:宋體;">應用程序上創建一個報表引擎，如下：</span>

// Example class to create the report engine
public class BirtEngine {
private static IReportEngine birtEngine = null;
public static synchronized IReportEngine getBirtEngine( ServletContext sc ) {
if (birtEngine == null) {
EngineConfig config = new EngineConfig( );
config.setBIRTHome( "" );
IPlatformContext context = new PlatformServletContext( sc );
config.setPlatformContext( context );
try{
Platform.startup( config );
IReportEngineFactory factory = ( IReportEngineFactory )
Platform.createFactoryObject(
IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
birtEngine = factory.createReportEngine( config );
}catch ( Exception e ) { e.printStackTrace( ); }
}
return birtEngine;
}
}

說明：上面的代碼是一個用單例模式實現的報表引擎的創建的類，EngineConfig配置了兩個參數 BIRTHome和PlatformContext。

在上面例子的基礎上進行更多的配置

// In a different class, get the report engine
reportEngine = BirtEngine.getBirtEngine( request.getSession( ).getServletContext( ));
// Set up the engine
EngineConfig config = reportEngine.getConfig( );
HTMLRenderOption ho = new HTMLRenderOption( );
ho.setImageHandler( new HTMLServerImageHandler( ));
ho.setImageDirectory("output/image");
ho.setBaseImageURL("http://myhost/prependme?image=");
config.setEmitterConfiguration( RenderOptionBase.OUTPUT_FORMAT_HTML, ho );

使用日誌環境調試應用程序
BIRT報表引擎使用java.util.logging的Logger和Level類來處理引擎平臺的日誌信息。你在Eclipse中運行一個 應用程序運行信息默認的是顯示在控制檯上的。在非Eclipse環境中運行信息的輸出就要有運行環境決定了。默認的日誌級別是Level.INFO，你可 以通過改變日誌級別來減少系統內部的日誌信息。
使用EngineConfig.setLogConfig( )可以讓日誌輸出到磁盤文件中。該方法需要兩個參數，第一個參數是日誌輸出的目錄，BIRT 引擎會在指定目錄中創建一個名稱格式爲ReportEngine
_YYYY_MM_DD_hh_mm_ss.log的日誌文件。第二個參數是日誌信息的最低級別，級別越高輸出的日誌信息越少。ReportEngine.changeLogLevel( )方法可以讓你修改日誌級別。

如何使用BIRT日誌 如下：

// Set up the location and level of the logging output.
config.setLogConfig( "C:/Temp", Level.ERROR );
engine.changeLogLevel( Level.INFO );

二、打開報表資源文件

BIRT引擎可以通過報表設計文件和報表文檔兩種方式生成報表，引擎還可以從報表設計文件生成報表文檔。
你可以通過openReportDesign( )方法打開一個報表設計文件文件，他實例化一個IReportRunnable對象，支持文件路徑或一個輸入流。
你可以通過openReportDocument( )方法打開一個報表設計文件文件，他實例化一個IReportDocument對象，也支持文件路徑或一個輸入流。
使用這些方法要處理EngineException。

理解IReportRunnable對象
IReportRunnable對象提供到報表設計的基本屬性的直接接口。報表設計屬性的屬性名是靜態字符串變量，如：IReportRunnable.AUTHOR。可以通過getProperty( )方法去訪問這些屬性。下面的代碼展示瞭如何連接到報表設計文件：

String designName = "./SimpleReport.rptdesign";
IReportRunnable runnable = null;
try {
runnable = engine.openReportDesign( designName );
}catch ( EngineException e ) {
System.err.println( "Design " + designName + " not found!" );
engine.destroy( );
System.exit( -1 );
}
// Get the value of a simple property.
String author = ( String ) runnable.getProperty( IReportRunnable.AUTHOR );

理解IReportDocument對象
IReportDocument對象提供了訪問報表數據和報表結構的接口，它提供了方法來訪問表格內容，書籤，頁面信息等。
使用findTOC( )訪問表格內容，該方法使用TOCNode參數返回一個TOCNode對象。使用null參數就可以訪問根表格。
調用getTOCTree( )返回一個ITOCTree對象獲取更詳細的Table信息。調用TOCNode.getChildren( )方法獲取table的子節點，返回值是一個TOCNode對象列表。
通過TOCNode對象你可以得到表格中的內容和書籤。你可以使用書籤對象作爲參數調用getPageNumber( )方法獲取書籤連接的頁面的頁數。通過這些信息你可以在以格式化的報表中顯示特定的頁面。
下面的代碼展示瞭如何打開一個報表文檔，並在頁面上查找元素：

String dName = "./SimpleReport.rptdocument";
IReportDocument doc = null;
try {
doc = engine.openReportDocument( dName );
} catch ( EngineException e ) {
System.err.println( "Document " + dName + " not found!" );
engine.destroy( );
System.exit( -1 );
}
// Get the root of the table of contents.
TOCNode td = doc.findTOC( null );
java.util.List children = td.getChildren( );
long pNumber;
// Loop through the top level table of contents entries.
if ( children != null && children.size( ) > 0 ) {
for ( int i = 0; i < children.size( ); i++ ) {
// Find the required table of contents entry.
TOCNode child = ( TOCNode ) children.get( i );
if ( child.getDisplayString( ).equals( "103" ) ) {
// Get the number of the page that contains the data.
pNumber = doc.getPageNumber( child.getBookmark( ) );
System.out.println( "Page to print is " + pNumber );
}
}
}

三、用程序處理報表參數

參數是報表生成之前想報表設計文件輸入的報表元素。報表的應用程序可以訪問報表的參數的屬性，最常用的屬性是name和value，你可以使用參數名或通用編碼來獲取參數。

爲報表設計創建一個參數定義任務
一個IGetParameterDefinitionTask對象提供鏈接到報表設計所有參數的接口。通過調用 ReportEngine.createGetParameterDefinitionTask( )創建一個參數定義對象，使用結束後調用他的close方法關閉。

測試報表設計是否有參數
IGetParameterDefinitionTask.getParameterDefns( )可以測試報表設計是否有參數，它返回一個參數集合，調用集合的isEmpty( )方法可以測試集合中是否有元素。

獲取報表設計的參數
通過IGetParameterDefinitionTask.getParameterDefn( )方法獲取一個已知名字的參數，它返回一個IParameterDefnBase類型對象，也可以調用getParameterDefns( )方法返回一個參數集合。
getParameterDefns( )需要一個boolean參數，如果爲false返回一個未分組的參數集合，如果爲true返回報表設計中定義的參數組。
調用IParameterDefnBase.getParameterType( )可以檢驗參數是否是一個組。如果是一個組則返回IParameterDefnBase.PARAMETER_GROUP，如果是一個級聯參數組則返回 IParameterDefnBase.CASCADING_PARAMETER_GROUP。爲獲取一組報表參數，使用方法 IParameterGroupDefn.getContents( )，它返回一個數據類型是IScalarParameterDefn的ArrayList對象。

獲取報表參數的默認值
這個任務是可選的。調用IGetParameterDefinitionTask.getDefaultValue( )獲取一個已知參數的默認值，它返回的是一個Object。可以通過調用IScalarParameterDefn.getDataType( )來獲取Object的有效類型，它返回一個IScalarParameterDefn定義的int類型的靜態變量。調用 IGetParameterDefinitionTask.getDefaultValues( )來獲取報表設計的所有參數的默認值，它返回一個HashMap對象存儲了從參數名到默認值的映射。

使用常量列表提供的效值
許多報表參數只接受常量列表的值，這些值可能是靜態常量，也可能是數據庫裏查出來的數據list。使用 IGetParameterDefinitionTask.getSelectionList( )可以返回參數所能接受的參數（IParameterSelectionChoice）的集合，如果集合爲null，則可以接受任何值。 IParameterSelectionChoice的getLabel( )方法返回現實的文本，getValue( )返回值。

獲取每個報表參數的屬性
這個任務是可選的。使用IScalarParameterDefn的方法可以獲取表參數的屬性。應用程序使用屬性生成用戶自定義接口。例如，獲取參數的數據類型使用getDataType( )方法。

爲參數設置值
調用IGetParameterDefinitionTask.setParameterValue( )爲參數設置值。如果你是通過應用程爲日期數值等參數返回一個字符串，要把他們轉化成和本地無關的格式。調用方法 ReportParameterConverter.parse( )方法可以完成這項工作。getParameterValues( )方法返回一個HashMap包含了已經設置的所有參數。

實例
下面的代碼展示瞭如何設置一個已知參數名的參數值：

// Create a parameter definition task.
IGetParameterDefinitionTask task = engine.createGetParameterDefinitionTask( runnable );
// Instantiate a scalar parameter.
IScalarParameterDefn param = (IScalarParameterDefn)
task.getParameterDefn( "customerID" );
// Get the default value of the parameter. In this case,
// the data type of the parameter, customerID, is Double.
int customerID = ((Double) task.getDefaultValue( param )).intValue( );
// Get a value for the parameter. This example assumes that
// this step creates a correctly typed object, inputValue.
// Set the value of the parameter.
task.setParameterValue( "customerID", inputValue );
// Get the values set by the application for all parameters.
HashMap parameterValues = task.getParameterValues( );
// Close the parameter definition task.
task.close( );

下面的代碼展示瞭如何使用報表參數集合，例子中使用ReportParameterConverter將字符串轉化成用戶接口接受的參數格式。

// Create a parameter definition task.
IGetParameterDefinitionTask task = engine.createGetParameterDefinitionTask( runnable );
// Create a collection of the parameters in the report design.
Collection params = task.getParameterDefns( false );
// Get the default values of the parameters.
HashMap parameterValues = task.getDefaultValues( );
// Get values for the parameters. Later code in this example
// assumes that this step creates a HashMap object,
// inputValues. The keys in the HashMap are the parameter
// names and the values are those that the user provided.
// Iterate through the report parameters, setting the values
// in standard locale-independent format.
Iterator iterOuter = params.iterator( );
ReportParameterConverter cfgConverter =
new ReportParameterConverter( "", Locale.getDefault() );
while ( iterOuter.hasNext( ) ) {
IParameterDefnBase param = (IParameterDefnBase) iterOuter.next( );
String value = (String) inputValues.get( param.getName( ));
if ( value != null ) {
parameterValues.put( param.getName( ),
cfgConverter.parse( value, param.getDataType( ) ) );
}
}
// Close the parameter definition task.
task.close( );

使用級聯參數
級聯參數參數是一組可供用戶選擇的參數值的集合。第一個參數的選擇會影響到第二個參數中的值。參數使用一個或多個查詢來從數據集把數據展示給用戶。參數定義任務根據前面的選擇以行爲單位過濾參數組中的數據。
使用報表引擎實現級聯參數，要進行如下工作：
■使用IGetParameterDefinitionTask.evaluateQuery( )方法爲級聯參數準備數據，它需要參數group的名字作爲參數。
■調用IGetParameterDefinitionTask.getSelectionListForCascadingGroup( )獲取參數組的第一個參數的值，它需要兩個參數，參數名和對象數組，對第一個參數來說這個數組是空的。該方法返回一個 IParameterSelectionChoice集合。
■ 再次調用getSelectionListForCascadingGroup( )方法獲取後面的參數，這次Object[ ]中放的是前面獲取的參數值。

下面的代碼展示瞭如何通過查詢實現級聯參數：

// Create a grouped collection of the design’s parameters.
Collection params = task.getParameterDefns( true );
// Iterate through the parameters to find the cascading group.
Iterator iter = params.iterator( );
while ( iter.hasNext( ) ) {
IParameterDefnBase param = (IParameterDefnBase) iter.next();
if ( param.getParameterType() ==
IParameterDefnBase.CASCADING_PARAMETER_GROUP ) {
ICascadingParameterGroup group = (ICascadingParameterGroup) param;
Iterator i2 = group.getContents( ).iterator( );
// Run the query for the cascading parameters.
task.evaluateQuery( group.getName() );
Object[ ] userValues = new Object[group.getContents( ).size( )];
// Get the report parameters in the cascading group.
int i = 0;
while ( i2.hasNext( ) ) {
IScalarParameterDefn member = (IScalarParameterDefn) i2.next( );
// Get the values for the parameter.
Object[ ] setValues = new Object[i];
if ( i > 0 ) System.arraycopy( userValues, 0, setValues, 0, i );
Collection c = task.getSelectionListForCascadingGroup(
group.getName(),setValues );
// Iterate through the values for the parameter.
Iterator i3 = c.iterator();
while ( i3.hasNext( ) ) {
IParameterSelectionChoice s =
( IParameterSelectionChoice ) i3.next( );
String choiceValue = s.getValue( );
String choiceLabel = s.getLabel( );
}
// Get the value for the parameter from the list of
// choices. This example does not provide the code for
// this task.
userValues[i] = inputChoiceValue;
i++;
}
}
}

四、報表生成的準備工作

BIRT支持HTML, Adobe PDF, Adobe PostScript (PS), Microsoft Excel (XLS), Microsoft PowerPoint (PPT)和 Microsoft Word (DOC) 格式的報表生成器。你也可以通過擴展支持自定義的格式。

有三個task類用來支持從源文件生成報表，就是：

■ IRunAndRenderTask. 通過運行報表設計文件直接生成目標格式的報表。調用方法ReportEngine.createRunAndRenderTask( )可以創建這個對象。

■ IRunTask. 通過報表設計文件生成報表文檔，ReportEngine.createRunTask( )方法可以創建這個對象。

■ IRenderTask. 通過對報表文檔中的內容進行格式化生成一個完整的報表或一個頁面集。ReportEngine. createRenderTask( )方法返回該對象的一個實例。
每一個任務都可以使用多個報表文件，任務結束後都要調用close方法關閉。

爲運行報表設計文件準備參數
IRunAndRenderTask 和 IRunTask對象允許設置報表參數。調用setParameterValues( )方法，通過傳入一個參數的HashMap設置所有的參數，設置單個參數可以使用setParameterValue( )方法。

添加到報表引擎的類路徑
一些報表設計需要擴展的java類，BIRT報表引擎通過使用環境變量信息定位類。通過動態設置應用程序上下文信息或引擎配置對象也可以配置java類的位置。使用EngineConstants中的常量來配置這些參數。

使用EngineTask對象和EngineConfig對象可以設置應用程序上下文，如下：

configOrTask.getAppContext( ).put(EngineConstants.APPCONTEXT_CLASSLOADER_KEY,MyClass.class.getClassLoader( ));

使用EngineConfig對象設置CLASSPATH，如下：
Java代碼 

config.setProperty( EngineConstants.WEBAPP_CLASSPATH_KEY, "c:/myjars/jar1.jar;c:/myclasses" );

使用Java System類設置CLASSPATH，如下：

System.setProperty(EngineConstants.WEBAPP_CLASSPATH_KEY, "c:/myjars/jar1.jar;c:/myclasses" );

BIRT按下面的順序來查找擴展類：
■ 報表引擎plug-in的CLASSPATH
■ 上下文環境中定義的EngineConstants.APPCONTEXT_CLASSLOADER_KEY
■Java System 類或EngineConfig 中定義的EngineConstants.WEBAPP_CLASSPATH_KEY.
■Java System 類或EngineConfig 中定義的EngineConstants. PROJECT _CLASSPATH_KEY.
■Java System 類或EngineConfig 中定義的
EngineConstants. WORKSPACE _CLASSPATH_KEY.
■ 報表設計中引入的JAR文件

爲報表設計提供外部對象
BIRT支持把以前實例化的對象拿過來重用。調用報表引擎前你要在應用程序中持有這個已經在內存中存在的對象。如果在腳本環境中使用，你傳遞對象給引擎後，腳本可以通過對象名在必要的是後獲取對象。
可以通過EngineConfig或task得上下文環境爲引擎提供對象。如下：

MyObject mo = new MyObject( );
config = new EngineConfig( );
// Get the application context from the config or the task
HashMap hm = config.getAppContext( );
//HashMap hm = task.getAppContext( );
hm.put( "MyCreatedObject", mo );
config.setAppContext( hm );
// To refer to this object in a BIRT script
// or expression, use MyCreatedObject.myMethod()

設置rendering選項
按指定格式輸出報表前要先設置報表輸出選項。必須設置一個文件名或輸出流用來輸出報表，其他的設置都是可選的如是否創建一個可嵌入的HTML。 BIRT支持可嵌入和非可嵌入兩種HTML，可嵌入HTML可以被嵌入其他的web頁面，不包含頭信息<body> 和<html>表籤。

應用程序通過rendering options對象設置輸出選項，指定格式的rendering options類實現了IRenderOption接口，並且繼承了RenderOption類。HTMLRenderOption用來設置HTML輸出 選項，PDFRenderOption用來設置PDF格式輸出選項。其他的格式都使用RenderOption。

常用的設置有超連接的ＵＲＬ，事件處理器，圖像處理器，輸出格式，支持的圖片輸出格式，還可以設置輸出到數據流還是文件。

設置HTML rendering選項
生成一個使用了圖片的HTML報表，必須進行更多的配置。HTMLRenderOption提供了許多方式去自定義HTML的生產。下面是一些常用的選項：
■ 圖像路徑，生成HTML需要的圖像（圖片，動態生成的圖表等）的路徑通過調用方法HTMLRenderOption.setImageDirectory( )進行設置。
■ 基本圖像URL，在Web應用程序開發時，瀏覽器要引用到圖像所要使用的URL路徑前綴。通過HTMLRenderOption.setBaseImageURL( )進行設置。
■ 圖像處理器，使用HTMLRenderOption.setImageHandler( ) 進行設置
■ 可嵌入的HTML，調用HTMLRenderOption.setEmbeddable( )。
■ 從左到右的生成方式，調用HTMLRenderOption.setHtmlRtLFlag( )設置。
■ 標題標籤，調用HTMLRenderOption.setHtmlTitle( )設置，該標籤將顯示在瀏覽器的標籤頁上。
■ 主頁面內容，通過主頁面可以設置頁面大小、頁眉、頁腳等。如果不想讓主頁面的設置影響HTML的生成，可以調用HTMLRenderOption.setMasterPageContent( )設置。
■ 浮動的頁腳，主頁面的頁腳默認直接顯示在內容的下方。傳一個boolean值false給方法 HTMLRenderOption.setPageFooterFloatFlag( )，強制頁腳在頁面底部的固定位置顯示。這個設置將在生成的HTML中添加一個固定高度的DIV。
■主頁的頁邊距，HTMLRenderOption.setOutputMasterPageMargins( )設置主頁的頁邊距是否影響到HTML頁面。
■ HTML分頁，生成HTML時也支持分頁。設置HTMLRenderOption.setHtmlPagination( )可以讓HTML頁面支持分頁。
下面的實例展示了在IRunAndRenderTask對象上使用rendering選項：

// Create a run and render task object.
IRunAndRenderTask task = engine.createRunAndRenderTask( runnable );
// Set values for all parameters in a HashMap, parameterValues
task.setParameterValues( parameterValues );
// Validate parameter values.
boolean parametersAreGood = task.validateParameters( );
// Set the name of an output file.
HTMLRenderOption options = new HTMLRenderOption( );
String output = name.replaceFirst( ".rptdesign", ".html" );
options.setOutputFileName( output );
options.setImageDirectory( "image" );
options.setHtmlRtLFlag( true );
options.setEmbeddable( false );
// Apply the rendering options to the task.
task.setRenderOption( options );
// Run and close the task
task.run();
task.close();

設置PDF rendering選項
生成PDF格式的報表需要在報表中嵌入字體，或者使用非標準路徑的字體，應用程序支持PDF rendering以下設置：
■ 字體路徑，如果使用自定義路徑下的字體，使用setFontDirectory( )進行設置。
■ 嵌入的字體，調用PDFRenderOption.setEmbededFont( )可以使用嵌入字體。

五、生成報表

IRunAndRenderTask和IRunTask對象的run方法可以生成報表，同時要處理run方法拋出的EngineException異常。
下面的代碼展示瞭如何生成一個報表：

try {
task.run( );
System.out.println( "Created Report " + output + "." );
}catch ( EngineException e1 ) {
System.err.println( "Report " + name + " run failed." );
System.err.println( e1.toString( ) );
}
engine.destroy( );

六、取消報表運行任務

BIRT報表引擎支持檢查引擎任務的狀態，並取消這個任務。通常使用不同的進程來執行這些操作。
使用EngineTask.getStatus( )方法可以檢查報表的運行狀態，返回值有下面這些：
■ IEngineTask.STATUS_NOT_STARTED. 任務沒有啓動
■ IEngineTask.STATUS_RUNNING. 任務正在運行中
■ IEngineTask.STATUS_SUCCEEDED. 任務正常結束
■ IEngineTask.STATUS_FAILED. 任務沒有正常執行
■ IEngineTask.STATUS_CANCELLED. 任務被取消
調用IEngineTask.cancel( )方法可以取消任務。如果一個正在運行的任務被取消了，它將停止生成報表，如果任務正在查詢數據庫，則數據庫要繼續執行完查詢任務。
下面就是一個取消任務的例子：

private class CancelReport extends Thread
{
private IEngineTask eTask;
public CancelReport( String myName, IEngineTask task ) {
super( myName );
eTask = task;
}
public void cancel( ) {
try {
Thread.currentThread( ).sleep( 100 );
eTask.cancel( );
System.out.println( "#### Report cancelled #####" );
}catch( Exception e )
{
e.printStackTrace();
}
}
}
CancelReport cancelThread = new CancelReport( "cancelReport", task);
cancelThread.cancel( );

下面我給出幾個比較完整的例子來講解報表引擎的工作。

下面是一個運行並導出部分列數據的代碼：

package REAPI;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.logging.Level;

import org.eclipse.birt.core.framework.Platform;
import org.eclipse.birt.data.engine.api.IConditionalExpression;
import org.eclipse.birt.data.engine.api.IFilterDefinition;
import org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression;
import org.eclipse.birt.data.engine.api.querydefn.FilterDefinition;
import org.eclipse.birt.data.engine.core.DataException;
import org.eclipse.birt.report.engine.api.EngineConfig;
import org.eclipse.birt.report.engine.api.EngineException;
import org.eclipse.birt.report.engine.api.IDataExtractionTask;
import org.eclipse.birt.report.engine.api.IDataIterator;
import org.eclipse.birt.report.engine.api.IExtractionResults;
import org.eclipse.birt.report.engine.api.IReportDocument;
import org.eclipse.birt.report.engine.api.IReportEngine;
import org.eclipse.birt.report.engine.api.IReportEngineFactory;
import org.eclipse.birt.report.engine.api.IResultMetaData;
import org.eclipse.birt.report.engine.api.IResultSetItem;

public class DataExtract {

    static void readReport() throws EngineException
    {
        IReportEngine engine=null;
        EngineConfig config = null;

        try{

            config = new EngineConfig( );
            config.setBIRTHome("E:\\birt漢化包\\birt-runtime-3_7_2\\ReportEngine");
            config.setLogConfig(null, Level.OFF);
            Platform.startup( config );
            IReportEngineFactory factory = (IReportEngineFactory) Platform
            .createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
            engine = factory.createReportEngine( config );
        }catch( Exception ex){
            ex.printStackTrace();
        }

        IReportDocument iReportDocument = engine.openReportDocument("d:\\customers.rptdocument");

        //Setup data extraction task
        IDataExtractionTask task = engine.createDataExtractionTask(iReportDocument);

        /**
         * returns the metadata corresponding to the data stored in the report
         * document.  Could specify a component.
         */

        ArrayList resultSetList = (ArrayList)task.getResultSetList( );

        IResultSetItem resultItem = null;
        Iterator it = resultSetList.iterator();
        while (it.hasNext()) {
            resultItem = (IResultSetItem)it.next();
            System.out.println("ResultSetName ====> " + resultItem.getResultSetName( ));
        }

        resultItem = (IResultSetItem)resultSetList.get( 0 );
        String dispName = resultItem.getResultSetName( );
        //Name Tables for ease
        task.selectResultSet( dispName );

        //Return Only customers between 201-300
        IFilterDefinition[] FilterExpression = new IFilterDefinition[2];
        FilterExpression[0] = new FilterDefinition( new ConditionalExpression( "row[\"CUSTOMERNUMBER\"]",
        IConditionalExpression.OP_GE, "201", null ) );
        FilterExpression[1] = new FilterDefinition( new ConditionalExpression( "row[\"CUSTOMERNUMBER\"]",
        IConditionalExpression.OP_LT, "300", null ) );
        task.setFilters( FilterExpression );

        IExtractionResults iExtractResults = task.extract();

        IDataIterator iData = null;
        try{
            if ( iExtractResults != null )
            {

                iData = iExtractResults.nextResultIterator( );
                //Get metadata on retrieved results
                IResultMetaData irmd = iData.getResultMetaData();
                if ( iData != null  ){
                    int colCount = irmd.getColumnCount();
                    System.out.println("Cloumn Count =" + colCount );
                    for( int j=0; j< colCount; j++){
                        System.out.println("Cloumn Name =" + irmd.getColumnName(j) );
                        System.out.println("Cloumn Type =" + irmd.getColumnTypeName(j) );

                    }

                    while ( iData.next( ) )
                    {
                        //Just disply the first two columns
                        Object objColumn1;
                        Object objColumn2;
                        try{
                            objColumn1 = iData.getValue(4);
                        }catch(DataException e){
                            objColumn1 = new String("");
                        }
                        try{
                            objColumn2 = iData.getValue(12);
                        }catch(DataException e){
                            objColumn2 = new String("");
                        }
                            System.out.println( objColumn1 + " , " + objColumn2 );
                    }
                    iData.close();
                }
            }
        }
        catch( Exception e){
            e.printStackTrace();
        }

        task.close();
        engine.destroy();
        Platform.shutdown();
        System.out.println("Finished");
        System.exit(0);
    }
    /**
     * @param args
     */
    public static void main(String[] args) {
        try
        {
            readReport( );
        }
        catch ( Exception e )
        {
            e.printStackTrace();
        }
    }

}

其中customers.rptdesign的設計如下：

預覽如下：

該源碼打印了結果集中的所有表名，從第一個表中獲取了結果集列屬性信息，導出了客戶號在201到300之間客戶第4列和第12列信息

運行結果如下：

ResultSetName ====> MyCustomerTable
ResultSetName ====> innertable
ResultSetName ====> innertable_1
ResultSetName ====> innertable_2
ResultSetName ====> innertable_3
ResultSetName ====> innertable_4
ResultSetName ====> innertable_5
ResultSetName ====> innertable_6
ResultSetName ====> innertable_7
ResultSetName ====> innertable_8
ResultSetName ====> innertable_9
ResultSetName ====> innertable_10
ResultSetName ====> innertable_11
ResultSetName ====> innertable_12
ResultSetName ====> innertable_13
ResultSetName ====> innertable_14
ResultSetName ====> innertable_15
ResultSetName ====> innertable_16
ResultSetName ====> innertable_17
ResultSetName ====> innertable_18
ResultSetName ====> innertable_19
ResultSetName ====> innertable_20
ResultSetName ====> innertable_21
ResultSetName ====> innertable_22
ResultSetName ====> innertable_23
ResultSetName ====> innertable_24
ResultSetName ====> innertable_25
ResultSetName ====> innertable_26
ResultSetName ====> innertable_27
ResultSetName ====> innertable_28
ResultSetName ====> innertable_29
ResultSetName ====> innertable_30
ResultSetName ====> innertable_31
ResultSetName ====> innertable_32
ResultSetName ====> innertable_33
ResultSetName ====> innertable_34
ResultSetName ====> innertable_35
ResultSetName ====> innertable_36
ResultSetName ====> innertable_37
ResultSetName ====> innertable_38
ResultSetName ====> innertable_39
ResultSetName ====> innertable_40
ResultSetName ====> innertable_41
ResultSetName ====> innertable_42
ResultSetName ====> innertable_43
ResultSetName ====> innertable_44
ResultSetName ====> innertable_45
ResultSetName ====> innertable_46
ResultSetName ====> innertable_47
ResultSetName ====> innertable_48
ResultSetName ====> innertable_49
ResultSetName ====> innertable_50
ResultSetName ====> innertable_51
ResultSetName ====> innertable_52
ResultSetName ====> innertable_53
ResultSetName ====> innertable_54
ResultSetName ====> innertable_55
ResultSetName ====> innertable_56
ResultSetName ====> innertable_57
ResultSetName ====> innertable_58
ResultSetName ====> innertable_59
ResultSetName ====> innertable_60
ResultSetName ====> innertable_61
ResultSetName ====> innertable_62
ResultSetName ====> innertable_63
ResultSetName ====> innertable_64
ResultSetName ====> innertable_65
ResultSetName ====> innertable_66
ResultSetName ====> innertable_67
ResultSetName ====> innertable_68
ResultSetName ====> innertable_69
ResultSetName ====> innertable_70
ResultSetName ====> innertable_71
ResultSetName ====> innertable_72
ResultSetName ====> innertable_73
ResultSetName ====> innertable_74
ResultSetName ====> innertable_75
ResultSetName ====> innertable_76
ResultSetName ====> innertable_77
ResultSetName ====> innertable_78
ResultSetName ====> innertable_79
ResultSetName ====> innertable_80
ResultSetName ====> innertable_81
ResultSetName ====> innertable_82
ResultSetName ====> innertable_83
ResultSetName ====> innertable_84
ResultSetName ====> innertable_85
ResultSetName ====> innertable_86
ResultSetName ====> innertable_87
ResultSetName ====> innertable_88
ResultSetName ====> innertable_89
ResultSetName ====> innertable_90
ResultSetName ====> innertable_91
ResultSetName ====> innertable_92
ResultSetName ====> innertable_93
ResultSetName ====> innertable_94
ResultSetName ====> innertable_95
ResultSetName ====> innertable_96
ResultSetName ====> innertable_97
ResultSetName ====> innertable_98
ResultSetName ====> innertable_99
ResultSetName ====> innertable_100
ResultSetName ====> innertable_101
ResultSetName ====> innertable_102
ResultSetName ====> innertable_103
ResultSetName ====> innertable_104
ResultSetName ====> innertable_105
ResultSetName ====> innertable_106
ResultSetName ====> innertable_107
ResultSetName ====> innertable_108
ResultSetName ====> innertable_109
ResultSetName ====> innertable_110
ResultSetName ====> innertable_111
ResultSetName ====> innertable_112
ResultSetName ====> innertable_113
ResultSetName ====> innertable_114
ResultSetName ====> innertable_115
ResultSetName ====> innertable_116
ResultSetName ====> innertable_117
ResultSetName ====> innertable_118
ResultSetName ====> innertable_119
ResultSetName ====> innertable_120
ResultSetName ====> innertable_121
Cloumn Count =13
Cloumn Name =CUSTOMERNUMBER
Cloumn Type =Integer
Cloumn Name =CUSTOMERNAME
Cloumn Type =String
Cloumn Name =CONTACTLASTNAME
Cloumn Type =String
Cloumn Name =CONTACTFIRSTNAME
Cloumn Type =String
Cloumn Name =PHONE
Cloumn Type =String
Cloumn Name =ADDRESSLINE1
Cloumn Type =String
Cloumn Name =ADDRESSLINE2
Cloumn Type =String
Cloumn Name =CITY
Cloumn Type =String
Cloumn Name =STATE
Cloumn Type =String
Cloumn Name =POSTALCODE
Cloumn Type =String
Cloumn Name =COUNTRY
Cloumn Type =String
Cloumn Name =SALESREPEMPLOYEENUMBER
Cloumn Type =Integer
Cloumn Name =CREDITLIMIT
Cloumn Type =Float
02 9936 8555 , 107800.0
[phone] , 93300.0
[phone] , 90300.0
[phone] , 48700.0
[phone] , 89600.0
86 21 3555 , 120800.0
88.60.1555 , 53800.0
61.77.6555 , 61100.0
[phone] , 68100.0
30.59.8555 , 77900.0
0372-555188 , 0.0
069-0555984 , 0.0
0221-5554327 , 120400.0
089-0877555 , 0.0
[phone] , 58600.0
011-4988555 , 113000.0
035-640555 , 119600.0
[phone] , 95100.0
[phone] , 0.0
(93) 203 4555 , 60300.0
(91) 745 6555 , 0.0
[phone] , 0.0
0897-034555 , 141300.0
[phone] , 92700.0
[phone] , 93900.0
6175557555 , 68700.0
6265557265 , 90700.0
3105552373 , 11000.0
7605558146 , 105000.0
6175558555 , 123700.0
Finished

下面這個案例運行報表，並導出html文件：

package REAPI;

import java.util.logging.Level;
import org.eclipse.birt.core.framework.Platform;
import org.eclipse.birt.report.engine.api.EXCELRenderOption;
import org.eclipse.birt.report.engine.api.EngineConfig;
import org.eclipse.birt.report.engine.api.EngineException;
import org.eclipse.birt.report.engine.api.HTMLRenderOption;
import org.eclipse.birt.report.engine.api.IPDFRenderOption;
import org.eclipse.birt.report.engine.api.IRenderOption;
import org.eclipse.birt.report.engine.api.IRenderTask;
import org.eclipse.birt.report.engine.api.IReportDocument;
import org.eclipse.birt.report.engine.api.IReportEngine;
import org.eclipse.birt.report.engine.api.IReportEngineFactory;
import org.eclipse.birt.report.engine.api.PDFRenderOption;
import org.eclipse.birt.report.engine.api.RenderOption;


public class RenderTask {

    public void runReport() throws EngineException
    {

        IReportEngine engine=null;
        EngineConfig config = null;

        try{

            config = new EngineConfig( );
            config.setBIRTHome("E:\\birt漢化包\\birt-runtime-3_7_2\\ReportEngine");
            config.setLogConfig(null, Level.FINE);
            Platform.startup( config );
            IReportEngineFactory factory = (IReportEngineFactory) Platform.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
            engine = factory.createReportEngine( config );
        }catch( Exception ex){
            ex.printStackTrace();
        }

        IReportDocument document = null;
        //Open the report design
        document = engine.openReportDocument("d:\\ps.rptdocument");
        IRenderOption options = new RenderOption();
        options.setOutputFormat("html");
        options.setOutputFileName("d:\\ps.html");
        options.setOption( IRenderOption.HTML_PAGINATION,
                Boolean.TRUE );
//
//      if( options.getOutputFormat().equalsIgnoreCase("html")){
//          HTMLRenderOption htmlOptions = new HTMLRenderOption( options);
//          htmlOptions.setImageDirectory("output/image");
//          //set this if you want your image source url to be altered
//          //htmlOptions.setBaseImageURL("http://myhos/prependme?image=");
//          htmlOptions.setHtmlRtLFlag(false);
//          htmlOptions.setEmbeddable(false);
//      }else if( options.getOutputFormat().equalsIgnoreCase("pdf") ){
//
//          PDFRenderOption pdfOptions = new PDFRenderOption( options );
//          /*  CLIP_CONTENT:             clip the content
//           *  FIT_TO_PAGE_SIZE:         scale the content to fit into the page
//           *  OUTPUT_TO_MULTIPLE_PAGES: divided the content into multiple pages
//           *  ENLARGE_PAGE_SIZE:        enlarge the page size to contain all the content.
//           */
//          pdfOptions.setOption( IPDFRenderOption.PAGE_OVERFLOW, Integer.valueOf( PDFRenderOption.FIT_TO_PAGE_SIZE ) );
//
//      }

        IRenderTask task = engine.createRenderTask(document);
        task.setRenderOption(options);
        //task.setPageRange("1-3");
        //task.setPageNumber(0);
        //task.setReportlet("chart3");
        task.render();
        task.close();
        document.close();
        engine.destroy();
        Platform.shutdown();
        System.out.println("Finished");
    }


    /**
     * @param args
     */
    public static void main(String[] args) {
        try
        {

            RenderTask ex = new RenderTask( );
            ex.runReport();

        }
        catch ( Exception e )
        {
            e.printStackTrace();
        }
        System.exit(0);
    }

}

報表的設計如下：

運行源碼，可以看到D盤導出的文件：

而下面的這段源碼，打印了報表的所有參數：

package REAPI;

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.logging.Level;

import org.eclipse.birt.core.framework.Platform;
import org.eclipse.birt.report.engine.api.EngineConfig;
import org.eclipse.birt.report.engine.api.EngineException;
import org.eclipse.birt.report.engine.api.IGetParameterDefinitionTask;
import org.eclipse.birt.report.engine.api.IParameterDefnBase;
import org.eclipse.birt.report.engine.api.IParameterGroupDefn;
import org.eclipse.birt.report.engine.api.IParameterSelectionChoice;
import org.eclipse.birt.report.engine.api.IReportEngine;
import org.eclipse.birt.report.engine.api.IReportEngineFactory;
import org.eclipse.birt.report.engine.api.IReportRunnable;
import org.eclipse.birt.report.engine.api.IScalarParameterDefn;
import org.eclipse.birt.report.model.api.CascadingParameterGroupHandle;
import org.eclipse.birt.report.model.api.ScalarParameterHandle;

public class ReportParameters {

    @SuppressWarnings("unchecked")
    static void executeReport() throws EngineException
    {
        HashMap parmDetails = new HashMap();
        IReportEngine engine=null;
        EngineConfig config = null;
        try{

            config = new EngineConfig( );
            config.setBIRTHome("E:\\birt漢化包\\birt-runtime-3_7_2\\ReportEngine");
            config.setLogConfig(null, Level.OFF);
            Platform.startup( config );
            IReportEngineFactory factory = (IReportEngineFactory) Platform
            .createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
            engine = factory.createReportEngine( config );
        }catch( Exception ex){
            ex.printStackTrace();
        }


        //Open a report design
        IReportRunnable design = engine.openReportDesign("d:\\parameters.rptdesign");

        IGetParameterDefinitionTask task = engine.createGetParameterDefinitionTask( design );
        Collection params = task.getParameterDefns( true );


        //task.getSelectionListForCascadingGroup();
        Iterator iter = params.iterator( );
        while ( iter.hasNext( ) )
        {
            IParameterDefnBase param = (IParameterDefnBase) iter.next( );

            if ( param instanceof IParameterGroupDefn )
            {
                IParameterGroupDefn group = (IParameterGroupDefn) param;
                System.out.println( "Parameter Group: " + group.getName( ) );


                // Do something with the parameter group.
                // Iterate over group contents.

                Iterator i2 = group.getContents( ).iterator( );
                while ( i2.hasNext( ) )
                {
                    IScalarParameterDefn scalar = (IScalarParameterDefn) i2.next( );
                    //System.out.println("\t" + scalar.getName());
                    parmDetails.put( scalar.getName(), loadParameterDetails( task, scalar, design, group));
                }

            }
            else
            {

                IScalarParameterDefn scalar = (IScalarParameterDefn) param;
                //System.out.println(param.getName());
                parmDetails.put( scalar.getName(),loadParameterDetails( task, scalar, design, null));


            }
        }

        task.close();
        engine.destroy();
        Platform.shutdown();
        System.out.println("Finished");
    }

    private static HashMap loadParameterDetails(IGetParameterDefinitionTask task, IScalarParameterDefn scalar, IReportRunnable report, IParameterGroupDefn group){



        HashMap parameter = new HashMap();

        if( group == null){
            parameter.put("Parameter Group", "Default");
        }else{
            parameter.put("Parameter Group", group.getName());
        }
        parameter.put("Name", scalar.getName());
        parameter.put("Help Text", scalar.getHelpText());
        parameter.put("Display Name", scalar.getDisplayName());
        //this is a format code such as  > for UPPERCASE
        parameter.put("Display Format", scalar.getDisplayFormat());

        if( scalar.isHidden() ){
            parameter.put("Hidden", "Yes");
        }else{
            parameter.put("Hidden", "No");
        }
        if( scalar.isHidden() ){
            parameter.put("Hidden", "Yes");
        }else{
            parameter.put("Hidded", "No");
        }
        if( scalar.isRequired() ){
            parameter.put("Is Required", "Yes");
        }else{
            parameter.put("Is Required", "No");
        }
        if( scalar.isValueConcealed() ){
            parameter.put("Conceal Entry", "Yes");  //ie passwords etc
        }else{
            parameter.put("Conceal Entry", "No");
        }


        switch (scalar.getControlType()) {
        case IScalarParameterDefn.TEXT_BOX:  parameter.put("Type", "Text Box"); break;
        case IScalarParameterDefn.LIST_BOX:  parameter.put("Type", "List Box"); break;
        case IScalarParameterDefn.RADIO_BUTTON:  parameter.put("Type", "List Box"); break;
        case IScalarParameterDefn.CHECK_BOX:  parameter.put("Type", "List Box"); break;
        default: parameter.put("Type", "Text Box");break;
        }


        switch (scalar.getDataType()) {
        case IScalarParameterDefn.TYPE_STRING:  parameter.put("Data Type", "String"); break;
        case IScalarParameterDefn.TYPE_FLOAT:  parameter.put("Data Type", "Float"); break;
        case IScalarParameterDefn.TYPE_DECIMAL:  parameter.put("Data Type", "Decimal"); break;
        case IScalarParameterDefn.TYPE_DATE_TIME:  parameter.put("Data Type", "Date Time"); break;
        case IScalarParameterDefn.TYPE_BOOLEAN:  parameter.put("Data Type", "Boolean"); break;
        default:  parameter.put("Data Type", "Any"); break;
        }


        ScalarParameterHandle parameterHandle = ( ScalarParameterHandle ) scalar.getHandle();

        parameter.put("Default Value", scalar.getDefaultValue());
        parameter.put("Prompt Text", scalar.getPromptText());
        parameter.put("Data Set Expression", parameterHandle.getValueExpr());

        if(scalar.getControlType() !=  IScalarParameterDefn.TEXT_BOX)
        {
            //System.out.println("dynamic parameter");

            if ( parameterHandle.getContainer( ) instanceof CascadingParameterGroupHandle ){
                Collection sList = Collections.EMPTY_LIST;
                if ( parameterHandle.getContainer( ) instanceof CascadingParameterGroupHandle )
                {

                    String groupName = parameterHandle.getContainer( ).getName( );
                    //used for Cascading parms see IGetParameterDefinitionTask.java code for comments
                    //task.evaluateQuery( groupName );

                    //Need to load this for calls to get next level.
                    //This just gets the first level
                    Object [] keyValueTmp = new Object[1];
                    sList = task.getSelectionListForCascadingGroup( groupName, keyValueTmp );


                    for ( Iterator sl = sList.iterator( ); sl.hasNext( ); )
                    {
                        IParameterSelectionChoice sI = (IParameterSelectionChoice) sl.next( );


                        Object value = sI.getValue( );
                        Object label = sI.getLabel( );
                        System.out.println( label + "--" + value);

                    }

                }
            }else{
                Collection selectionList = task.getSelectionList( scalar.getName() );

                if ( selectionList != null )
                {
                    HashMap dynamicList = new HashMap();

                    for ( Iterator sliter = selectionList.iterator( ); sliter.hasNext( ); )
                    {
                        IParameterSelectionChoice selectionItem = (IParameterSelectionChoice) sliter.next( );

                        Object value = selectionItem.getValue( );
                        String label = selectionItem.getLabel( );

                        //System.out.println( label + "--" + value);
                        //Display label unless null then display value.  Value is the what should get passed to the report.
                        dynamicList.put(value,label);

                    }
                    parameter.put("Selection List", dynamicList);
                }
            }

        }


        Iterator iter = parameter.keySet().iterator();
        System.out.println("======================Parameter =" + scalar.getName());
        while (iter.hasNext()) {
            String name = (String) iter.next();
            if( name.equals("Selection List")){
                HashMap selList = (HashMap)parameter.get(name);
                Iterator selIter = selList.keySet().iterator();
                while (selIter.hasNext()) {
                    Object lbl = selIter.next();
                    System.out.println( "Selection List Entry ===== Key = " + lbl + " Value = " + selList.get(lbl));
                }

            }else{
                System.out.println( name + " = " + parameter.get(name));
            }
        }
        return parameter;

    }

    /**
     * @param args
     */
    public static void main(String[] args) {
        try
        {
            executeReport( );
        }
        catch ( Exception e )
        {
            e.printStackTrace();
        }
    }

}

運行結果如下：

======================Parameter =parameter1
Hidded = No
Default Value = 1
Type = Text Box
Conceal Entry = No
Hidden = No
Data Set Expression = null
Name = parameter1
Is Required = Yes
Help Text = null
Parameter Group = Default
Display Name = null
Display Format = #,##0.00%
Data Type = Decimal
Prompt Text = "This i prompt text"
Parameter Group: ParmGroup1
======================Parameter =Parameter2
Hidded = No
Default Value = parm2
Type = Text Box
Conceal Entry = No
Hidden = No
Data Set Expression = null
Name = Parameter2
Is Required = No
Help Text = null
Parameter Group = ParmGroup1
Display Name = null
Display Format = Unformatted
Data Type = String
Prompt Text = null
======================Parameter =Parameter3
Hidded = No
Default Value = 10101
Type = List Box
Conceal Entry = No
Hidden = No
Selection List Entry ===== Key = 10346 Value = 10346
Selection List Entry ===== Key = 10207 Value = 10207
Selection List Entry ===== Key = 10347 Value = 10347
Selection List Entry ===== Key = 10208 Value = 10208
Selection List Entry ===== Key = 10344 Value = 10344
Selection List Entry ===== Key = 10205 Value = 10205
Selection List Entry ===== Key = 10345 Value = 10345
Selection List Entry ===== Key = 10206 Value = 10206
Selection List Entry ===== Key = 10342 Value = 10342
Selection List Entry ===== Key = 10343 Value = 10343
Selection List Entry ===== Key = 10340 Value = 10340
Selection List Entry ===== Key = 10209 Value = 10209
Selection List Entry ===== Key = 10341 Value = 10341
Selection List Entry ===== Key = 10200 Value = 10200
Selection List Entry ===== Key = 10203 Value = 10203
Selection List Entry ===== Key = 10204 Value = 10204
Selection List Entry ===== Key = 10348 Value = 10348
Selection List Entry ===== Key = 10201 Value = 10201
Selection List Entry ===== Key = 10349 Value = 10349
Selection List Entry ===== Key = 10202 Value = 10202
Selection List Entry ===== Key = 10333 Value = 10333
Selection List Entry ===== Key = 10334 Value = 10334
Selection List Entry ===== Key = 10335 Value = 10335
Selection List Entry ===== Key = 10336 Value = 10336
Selection List Entry ===== Key = 10330 Value = 10330
Selection List Entry ===== Key = 10331 Value = 10331
Selection List Entry ===== Key = 10332 Value = 10332
Selection List Entry ===== Key = 10337 Value = 10337
Selection List Entry ===== Key = 10338 Value = 10338
Selection List Entry ===== Key = 10339 Value = 10339
Selection List Entry ===== Key = 10320 Value = 10320
Selection List Entry ===== Key = 10321 Value = 10321
Selection List Entry ===== Key = 10324 Value = 10324
Selection List Entry ===== Key = 10229 Value = 10229
Selection List Entry ===== Key = 10325 Value = 10325
Selection List Entry ===== Key = 10322 Value = 10322
Selection List Entry ===== Key = 10227 Value = 10227
Selection List Entry ===== Key = 10323 Value = 10323
Selection List Entry ===== Key = 10228 Value = 10228
Selection List Entry ===== Key = 10328 Value = 10328
Selection List Entry ===== Key = 10225 Value = 10225
Selection List Entry ===== Key = 10329 Value = 10329
Selection List Entry ===== Key = 10226 Value = 10226
Selection List Entry ===== Key = 10326 Value = 10326
Selection List Entry ===== Key = 10223 Value = 10223
Selection List Entry ===== Key = 10327 Value = 10327
Selection List Entry ===== Key = 10224 Value = 10224
Selection List Entry ===== Key = 10221 Value = 10221
Selection List Entry ===== Key = 10222 Value = 10222
Selection List Entry ===== Key = 10220 Value = 10220
Selection List Entry ===== Key = 10310 Value = 10310
Selection List Entry ===== Key = 10311 Value = 10311
Selection List Entry ===== Key = 10216 Value = 10216
Selection List Entry ===== Key = 10312 Value = 10312
Selection List Entry ===== Key = 10217 Value = 10217
Selection List Entry ===== Key = 10313 Value = 10313
Selection List Entry ===== Key = 10218 Value = 10218
Selection List Entry ===== Key = 10314 Value = 10314
Selection List Entry ===== Key = 10219 Value = 10219
Selection List Entry ===== Key = 10315 Value = 10315
Selection List Entry ===== Key = 10212 Value = 10212
Selection List Entry ===== Key = 10316 Value = 10316
Selection List Entry ===== Key = 10213 Value = 10213
Selection List Entry ===== Key = 10317 Value = 10317
Selection List Entry ===== Key = 10214 Value = 10214
Selection List Entry ===== Key = 10318 Value = 10318
Selection List Entry ===== Key = 10215 Value = 10215
Selection List Entry ===== Key = 10319 Value = 10319
Selection List Entry ===== Key = 10210 Value = 10210
Selection List Entry ===== Key = 10211 Value = 10211
Selection List Entry ===== Key = 10244 Value = 10244
Selection List Entry ===== Key = 10243 Value = 10243
Selection List Entry ===== Key = 10242 Value = 10242
Selection List Entry ===== Key = 10241 Value = 10241
Selection List Entry ===== Key = 10248 Value = 10248
Selection List Entry ===== Key = 10247 Value = 10247
Selection List Entry ===== Key = 10246 Value = 10246
Selection List Entry ===== Key = 10245 Value = 10245
Selection List Entry ===== Key = 10389 Value = 10389
Selection List Entry ===== Key = 10388 Value = 10388
Selection List Entry ===== Key = 10249 Value = 10249
Selection List Entry ===== Key = 10387 Value = 10387
Selection List Entry ===== Key = 10386 Value = 10386
Selection List Entry ===== Key = 10385 Value = 10385
Selection List Entry ===== Key = 10384 Value = 10384
Selection List Entry ===== Key = 10382 Value = 10382
Selection List Entry ===== Key = 10383 Value = 10383
Selection List Entry ===== Key = 10380 Value = 10380
Selection List Entry ===== Key = 10381 Value = 10381
Selection List Entry ===== Key = 10240 Value = 10240
Selection List Entry ===== Key = 10231 Value = 10231
Selection List Entry ===== Key = 10230 Value = 10230
Selection List Entry ===== Key = 10233 Value = 10233
Selection List Entry ===== Key = 10232 Value = 10232
Selection List Entry ===== Key = 10235 Value = 10235
Selection List Entry ===== Key = 10234 Value = 10234
Selection List Entry ===== Key = 10237 Value = 10237
Selection List Entry ===== Key = 10236 Value = 10236
Selection List Entry ===== Key = 10378 Value = 10378
Selection List Entry ===== Key = 10239 Value = 10239
Selection List Entry ===== Key = 10377 Value = 10377
Selection List Entry ===== Key = 10238 Value = 10238
Selection List Entry ===== Key = 10379 Value = 10379
Selection List Entry ===== Key = 10374 Value = 10374
Selection List Entry ===== Key = 10373 Value = 10373
Selection List Entry ===== Key = 10376 Value = 10376
Selection List Entry ===== Key = 10375 Value = 10375
Selection List Entry ===== Key = 10370 Value = 10370
Selection List Entry ===== Key = 10371 Value = 10371
Selection List Entry ===== Key = 10372 Value = 10372
Selection List Entry ===== Key = 10269 Value = 10269
Selection List Entry ===== Key = 10268 Value = 10268
Selection List Entry ===== Key = 10267 Value = 10267
Selection List Entry ===== Key = 10266 Value = 10266
Selection List Entry ===== Key = 10265 Value = 10265
Selection List Entry ===== Key = 10264 Value = 10264
Selection List Entry ===== Key = 10263 Value = 10263
Selection List Entry ===== Key = 10365 Value = 10365
Selection List Entry ===== Key = 10364 Value = 10364
Selection List Entry ===== Key = 10363 Value = 10363
Selection List Entry ===== Key = 10362 Value = 10362
Selection List Entry ===== Key = 10369 Value = 10369
Selection List Entry ===== Key = 10368 Value = 10368
Selection List Entry ===== Key = 10367 Value = 10367
Selection List Entry ===== Key = 10366 Value = 10366
Selection List Entry ===== Key = 10360 Value = 10360
Selection List Entry ===== Key = 10361 Value = 10361
Selection List Entry ===== Key = 10261 Value = 10261
Selection List Entry ===== Key = 10262 Value = 10262
Selection List Entry ===== Key = 10260 Value = 10260
Selection List Entry ===== Key = 10257 Value = 10257
Selection List Entry ===== Key = 10359 Value = 10359
Selection List Entry ===== Key = 10256 Value = 10256
Selection List Entry ===== Key = 10259 Value = 10259
Selection List Entry ===== Key = 10258 Value = 10258
Selection List Entry ===== Key = 10253 Value = 10253
Selection List Entry ===== Key = 10252 Value = 10252
Selection List Entry ===== Key = 10255 Value = 10255
Selection List Entry ===== Key = 10254 Value = 10254
Selection List Entry ===== Key = 10352 Value = 10352
Selection List Entry ===== Key = 10351 Value = 10351
Selection List Entry ===== Key = 10354 Value = 10354
Selection List Entry ===== Key = 10353 Value = 10353
Selection List Entry ===== Key = 10356 Value = 10356
Selection List Entry ===== Key = 10355 Value = 10355
Selection List Entry ===== Key = 10358 Value = 10358
Selection List Entry ===== Key = 10357 Value = 10357
Selection List Entry ===== Key = 10350 Value = 10350
Selection List Entry ===== Key = 10250 Value = 10250
Selection List Entry ===== Key = 10251 Value = 10251
Selection List Entry ===== Key = 10152 Value = 10152
Selection List Entry ===== Key = 10151 Value = 10151
Selection List Entry ===== Key = 10150 Value = 10150
Selection List Entry ===== Key = 10130 Value = 10130
Selection List Entry ===== Key = 10400 Value = 10400
Selection List Entry ===== Key = 10402 Value = 10402
Selection List Entry ===== Key = 10401 Value = 10401
Selection List Entry ===== Key = 10404 Value = 10404
Selection List Entry ===== Key = 10291 Value = 10291
Selection List Entry ===== Key = 10403 Value = 10403
Selection List Entry ===== Key = 10290 Value = 10290
Selection List Entry ===== Key = 10406 Value = 10406
Selection List Entry ===== Key = 10405 Value = 10405
Selection List Entry ===== Key = 10408 Value = 10408
Selection List Entry ===== Key = 10295 Value = 10295
Selection List Entry ===== Key = 10407 Value = 10407
Selection List Entry ===== Key = 10294 Value = 10294
Selection List Entry ===== Key = 10293 Value = 10293
Selection List Entry ===== Key = 10409 Value = 10409
Selection List Entry ===== Key = 10292 Value = 10292
Selection List Entry ===== Key = 10298 Value = 10298
Selection List Entry ===== Key = 10299 Value = 10299
Selection List Entry ===== Key = 10296 Value = 10296
Selection List Entry ===== Key = 10297 Value = 10297
Selection List Entry ===== Key = 10139 Value = 10139
Selection List Entry ===== Key = 10159 Value = 10159
Selection List Entry ===== Key = 10135 Value = 10135
Selection List Entry ===== Key = 10136 Value = 10136
Selection List Entry ===== Key = 10157 Value = 10157
Selection List Entry ===== Key = 10137 Value = 10137
Selection List Entry ===== Key = 10158 Value = 10158
Selection List Entry ===== Key = 10138 Value = 10138
Selection List Entry ===== Key = 10155 Value = 10155
Selection List Entry ===== Key = 10131 Value = 10131
Selection List Entry ===== Key = 10156 Value = 10156
Selection List Entry ===== Key = 10132 Value = 10132
Selection List Entry ===== Key = 10153 Value = 10153
Selection List Entry ===== Key = 10133 Value = 10133
Selection List Entry ===== Key = 10154 Value = 10154
Selection List Entry ===== Key = 10134 Value = 10134
Selection List Entry ===== Key = 10161 Value = 10161
Selection List Entry ===== Key = 10141 Value = 10141
Selection List Entry ===== Key = 10160 Value = 10160
Selection List Entry ===== Key = 10140 Value = 10140
Selection List Entry ===== Key = 10163 Value = 10163
Selection List Entry ===== Key = 10162 Value = 10162
Selection List Entry ===== Key = 10168 Value = 10168
Selection List Entry ===== Key = 10148 Value = 10148
Selection List Entry ===== Key = 10169 Value = 10169
Selection List Entry ===== Key = 10149 Value = 10149
Selection List Entry ===== Key = 10146 Value = 10146
Selection List Entry ===== Key = 10147 Value = 10147
Selection List Entry ===== Key = 10164 Value = 10164
Selection List Entry ===== Key = 10144 Value = 10144
Selection List Entry ===== Key = 10165 Value = 10165
Selection List Entry ===== Key = 10145 Value = 10145
Selection List Entry ===== Key = 10166 Value = 10166
Selection List Entry ===== Key = 10142 Value = 10142
Selection List Entry ===== Key = 10167 Value = 10167
Selection List Entry ===== Key = 10143 Value = 10143
Selection List Entry ===== Key = 10422 Value = 10422
Selection List Entry ===== Key = 10170 Value = 10170
Selection List Entry ===== Key = 10421 Value = 10421
Selection List Entry ===== Key = 10424 Value = 10424
Selection List Entry ===== Key = 10423 Value = 10423
Selection List Entry ===== Key = 10174 Value = 10174
Selection List Entry ===== Key = 10173 Value = 10173
Selection List Entry ===== Key = 10420 Value = 10420
Selection List Entry ===== Key = 10172 Value = 10172
Selection List Entry ===== Key = 10171 Value = 10171
Selection List Entry ===== Key = 10273 Value = 10273
Selection List Entry ===== Key = 10272 Value = 10272
Selection List Entry ===== Key = 10271 Value = 10271
Selection List Entry ===== Key = 10270 Value = 10270
Selection List Entry ===== Key = 10425 Value = 10425
Selection List Entry ===== Key = 10117 Value = 10117
Selection List Entry ===== Key = 10118 Value = 10118
Selection List Entry ===== Key = 10119 Value = 10119
Selection List Entry ===== Key = 10278 Value = 10278
Selection List Entry ===== Key = 10279 Value = 10279
Selection List Entry ===== Key = 10276 Value = 10276
Selection List Entry ===== Key = 10277 Value = 10277
Selection List Entry ===== Key = 10274 Value = 10274
Selection List Entry ===== Key = 10275 Value = 10275
Selection List Entry ===== Key = 10177 Value = 10177
Selection List Entry ===== Key = 10178 Value = 10178
Selection List Entry ===== Key = 10110 Value = 10110
Selection List Entry ===== Key = 10175 Value = 10175
Selection List Entry ===== Key = 10111 Value = 10111
Selection List Entry ===== Key = 10176 Value = 10176
Selection List Entry ===== Key = 10112 Value = 10112
Selection List Entry ===== Key = 10113 Value = 10113
Selection List Entry ===== Key = 10114 Value = 10114
Selection List Entry ===== Key = 10179 Value = 10179
Selection List Entry ===== Key = 10115 Value = 10115
Selection List Entry ===== Key = 10116 Value = 10116
Selection List Entry ===== Key = 10413 Value = 10413
Selection List Entry ===== Key = 10412 Value = 10412
Selection List Entry ===== Key = 10411 Value = 10411
Selection List Entry ===== Key = 10181 Value = 10181
Selection List Entry ===== Key = 10410 Value = 10410
Selection List Entry ===== Key = 10180 Value = 10180
Selection List Entry ===== Key = 10183 Value = 10183
Selection List Entry ===== Key = 10182 Value = 10182
Selection List Entry ===== Key = 10185 Value = 10185
Selection List Entry ===== Key = 10184 Value = 10184
Selection List Entry ===== Key = 10282 Value = 10282
Selection List Entry ===== Key = 10281 Value = 10281
Selection List Entry ===== Key = 10419 Value = 10419
Selection List Entry ===== Key = 10284 Value = 10284
Selection List Entry ===== Key = 10418 Value = 10418
Selection List Entry ===== Key = 10283 Value = 10283
Selection List Entry ===== Key = 10417 Value = 10417
Selection List Entry ===== Key = 10416 Value = 10416
Selection List Entry ===== Key = 10415 Value = 10415
Selection List Entry ===== Key = 10280 Value = 10280
Selection List Entry ===== Key = 10414 Value = 10414
Selection List Entry ===== Key = 10289 Value = 10289
Selection List Entry ===== Key = 10128 Value = 10128
Selection List Entry ===== Key = 10129 Value = 10129
Selection List Entry ===== Key = 10285 Value = 10285
Selection List Entry ===== Key = 10286 Value = 10286
Selection List Entry ===== Key = 10287 Value = 10287
Selection List Entry ===== Key = 10288 Value = 10288
Selection List Entry ===== Key = 10186 Value = 10186
Selection List Entry ===== Key = 10122 Value = 10122
Selection List Entry ===== Key = 10187 Value = 10187
Selection List Entry ===== Key = 10123 Value = 10123
Selection List Entry ===== Key = 10188 Value = 10188
Selection List Entry ===== Key = 10120 Value = 10120
Selection List Entry ===== Key = 10189 Value = 10189
Selection List Entry ===== Key = 10121 Value = 10121
Selection List Entry ===== Key = 10126 Value = 10126
Selection List Entry ===== Key = 10127 Value = 10127
Selection List Entry ===== Key = 10124 Value = 10124
Selection List Entry ===== Key = 10125 Value = 10125
Selection List Entry ===== Key = 10195 Value = 10195
Selection List Entry ===== Key = 10196 Value = 10196
Selection List Entry ===== Key = 10399 Value = 10399
Selection List Entry ===== Key = 10193 Value = 10193
Selection List Entry ===== Key = 10194 Value = 10194
Selection List Entry ===== Key = 10397 Value = 10397
Selection List Entry ===== Key = 10191 Value = 10191
Selection List Entry ===== Key = 10398 Value = 10398
Selection List Entry ===== Key = 10192 Value = 10192
Selection List Entry ===== Key = 10395 Value = 10395
Selection List Entry ===== Key = 10396 Value = 10396
Selection List Entry ===== Key = 10190 Value = 10190
Selection List Entry ===== Key = 10394 Value = 10394
Selection List Entry ===== Key = 10309 Value = 10309
Selection List Entry ===== Key = 10393 Value = 10393
Selection List Entry ===== Key = 10308 Value = 10308
Selection List Entry ===== Key = 10392 Value = 10392
Selection List Entry ===== Key = 10391 Value = 10391
Selection List Entry ===== Key = 10390 Value = 10390
Selection List Entry ===== Key = 10305 Value = 10305
Selection List Entry ===== Key = 10304 Value = 10304
Selection List Entry ===== Key = 10199 Value = 10199
Selection List Entry ===== Key = 10307 Value = 10307
Selection List Entry ===== Key = 10198 Value = 10198
Selection List Entry ===== Key = 10306 Value = 10306
Selection List Entry ===== Key = 10197 Value = 10197
Selection List Entry ===== Key = 10301 Value = 10301
Selection List Entry ===== Key = 10300 Value = 10300
Selection List Entry ===== Key = 10303 Value = 10303
Selection List Entry ===== Key = 10302 Value = 10302
Selection List Entry ===== Key = 10105 Value = 10105
Selection List Entry ===== Key = 10104 Value = 10104
Selection List Entry ===== Key = 10103 Value = 10103
Selection List Entry ===== Key = 10102 Value = 10102
Selection List Entry ===== Key = 10101 Value = 10101
Selection List Entry ===== Key = 10100 Value = 10100
Selection List Entry ===== Key = 10109 Value = 10109
Selection List Entry ===== Key = 10108 Value = 10108
Selection List Entry ===== Key = 10107 Value = 10107
Selection List Entry ===== Key = 10106 Value = 10106
Data Set Expression = row["ORDERNUMBER"]
Name = Parameter3
Is Required = Yes
Help Text = null
Parameter Group = Default
Display Name = null
Display Format = >
Data Type = String
Prompt Text = null
======================Parameter =comboparm
Hidded = No
Default Value = val2
Type = List Box
Conceal Entry = No
Hidden = No
Selection List Entry ===== Key = val1 Value = displaytext1
Selection List Entry ===== Key = val2 Value = displaytestval2
Data Set Expression = null
Name = comboparm
Is Required = No
Help Text = null
Parameter Group = Default
Display Name = null
Display Format = Unformatted
Data Type = String
Prompt Text = null
======================Parameter =radioparm
Hidded = No
Default Value = radio1
Type = List Box
Conceal Entry = No
Hidden = No
Selection List Entry ===== Key = radio1 Value = radio1
Selection List Entry ===== Key = radio2 Value = displaytextcombo2
Data Set Expression = null
Name = radioparm
Is Required = No
Help Text = radiohelp
Parameter Group = Default
Display Name = null
Display Format = Unformatted
Data Type = String
Prompt Text = null
======================Parameter =staticlistbox
Hidded = No
Default Value = null
Type = List Box
Conceal Entry = No
Hidden = No
Selection List Entry ===== Key = listboxstatic1 Value = listboxstatic1
Selection List Entry ===== Key = listboxstatic2 Value = displaytextlistbox2
Data Set Expression = null
Name = staticlistbox
Is Required = No
Help Text = null
Parameter Group = Default
Display Name = null
Display Format = Unformatted
Data Type = String
Prompt Text = null
Parameter Group: iii
======================Parameter =customernumber
Hidded = No
Default Value = defaultvalue
Type = List Box
Conceal Entry = No
Hidden = No
Data Set Expression = row["CUSTOMERNUMBER"]
Name = customernumber
Is Required = No
Help Text = helptext
Parameter Group = iii
Display Name = null
Display Format = Unformatted
Data Type = String
Prompt Text = enter customer number
======================Parameter =OrderNumber
Hidded = No
Default Value = null
Type = List Box
Conceal Entry = No
Hidden = No
Data Set Expression = row["ORDERNUMBER"]
Name = OrderNumber
Is Required = No
Help Text = null
Parameter Group = iii
Display Name = null
Display Format = Unformatted
Data Type = String
Prompt Text = null
======================Parameter =parameter6
Hidded = No
Default Value = test
Type = Text Box
Conceal Entry = No
Hidden = No
Data Set Expression = null
Name = parameter6
Is Required = No
Help Text = null
Parameter Group = Default
Display Name = null
Display Format = <
Data Type = String
Prompt Text = null
======================Parameter =parameter7
Hidded = No
Default Value = 2
Type = List Box
Conceal Entry = No
Hidden = No
Selection List Entry ===== Key = 3 Value = 3
Selection List Entry ===== Key = 2 Value = 2
Selection List Entry ===== Key = 1 Value = 1
Data Set Expression = null
Name = parameter7
Is Required = Yes
Help Text = null
Parameter Group = Default
Display Name = null
Display Format = Unformatted
Data Type = Decimal
Prompt Text = null
======================Parameter =DateParameter
Hidded = No
Default Value = 12/12/2006
Type = Text Box
Conceal Entry = No
Hidden = No
Data Set Expression = null
Name = DateParameter
Is Required = Yes
Help Text = null
Parameter Group = Default
Display Name = null
Display Format = Unformatted
Data Type = Date Time
Prompt Text = null
Finished

下面的例子在控制檯打印了TOC信息：

package REAPI;

import java.util.logging.Level;

import org.eclipse.birt.core.framework.Platform;
import org.eclipse.birt.report.engine.api.EngineConfig;
import org.eclipse.birt.report.engine.api.EngineException;
import org.eclipse.birt.report.engine.api.IReportDocument;
import org.eclipse.birt.report.engine.api.IReportEngine;
import org.eclipse.birt.report.engine.api.IReportEngineFactory;
import org.eclipse.birt.report.engine.api.TOCNode;


public class Toc {

    public void runReport() throws EngineException
    {

        IReportEngine engine=null;
        EngineConfig config = null;

        try{

            config = new EngineConfig( );
            config.setBIRTHome("E:\\birt漢化包\\birt-runtime-3_7_2\\ReportEngine");
            config.setLogConfig(null, Level.FINE);
            Platform.startup( config );
            IReportEngineFactory factory = (IReportEngineFactory) Platform.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
            engine = factory.createReportEngine( config );
        }catch( Exception ex){
            ex.printStackTrace();
        }

        IReportDocument document = null;
        //Open the report design
        document = engine.openReportDocument("d:\\customers.rptdocument");


        // Get the root of the table of contents.
        TOCNode td = document.findTOC( null );
        java.util.List children = td.getChildren( );
        long pNumber;
        // Loop through the top level table of contents entries.
        if ( children != null && children.size( ) > 0 ) {
            for ( int i = 0; i < children.size( ); i++ )     {
                // Find the required table of contents entry.
                TOCNode child = ( TOCNode ) children.get( i );
                //if ( child.getDisplayString( ).equals( "103" ) )      {
                // Get the number of the page that contains the data.
                pNumber = document.getPageNumber( child.getBookmark( ) );
                System.out.println( child.getDisplayString( ) + " Page to print is " + pNumber );
                //}
            }
        }

        document.close();
        engine.destroy();
        Platform.shutdown();
        System.out.println("Finished");
    }


    /**
     * @param args
     */
    public static void main(String[] args) {
        try
        {

            Toc ex = new Toc( );
            ex.runReport();

        }
        catch ( Exception e )
        {
            e.printStackTrace();
        }
    }


}

報表的預覽如下：

運行結果如下：

Australia Page to print is 1

Austria Page to print is 2

Belgium Page to print is 3

Canada Page to print is 4

Denmark Page to print is 5

Finland Page to print is 6

France Page to print is 7

Germany Page to print is 8

Hong Kong Page to print is 9

Ireland Page to print is 10

Israel Page to print is 11

Italy Page to print is 12

Japan Page to print is 13

Netherlands Page to print is 14

New Zealand Page to print is 15

Norway Page to print is 16

Philippines Page to print is 17

Poland Page to print is 18

Portugal Page to print is 19

Russia Page to print is 20

Singapore Page to print is 21

South Africa Page to print is 22

Spain Page to print is 23

Sweden Page to print is 24

Switzerland Page to print is 25

UK Page to print is 26

USA Page to print is 27

Finished

關於報表設計引擎API的結構和使用方法，以及如何在報表引擎中調用報表設計引擎來修改報表，將在下一節詳細講解。