About required JDBC drivers
BIRT applications load JDBC drivers from the BIRT home directory
plugins/org.eclipse.birt.report.data.oda.jdbc_<version>/drivers. Place the driver classes or Java archive (.jar) files that you require to access JDBC data sources in this location.
Setting up the build path and accessing Javadoc
To access the BIRT APIs during application development using the Java perspective in the Eclipse Workbench, add API JAR files to the build path. The org.eclipse.birt.chart.doc.isv and org.eclipse.birt.doc.isv plug-ins provide the Javadoc for the public BIRT APIs. Extract the plug-ins’ JAR files to a convenient location, for example in your workspace or a resource folder. Then, use the Java Build Path settings in Eclipse to set the Javadoc location for each public API JAR file.
Table 12-2 lists the source plug-in and the extracted location of the Javadoc.
Table 12-2 Javadoc locations for BIRT API libraries
API library | Javadoc source plug-in | Javadoc folder |
chartengineapi.jar | org.eclipse.birt.chart.doc.isv | chart/api |
coreapi.jar | org.eclipse.birt.doc.isv | core/api |
dteapi.jar | org.eclipse.birt.doc.isv | data/api |
engineapi.jar | org.eclipse.birt.doc.isv | engine/api |
modelapi.jar | org.eclipse.birt.doc.isv | model/api |
scriptapi.jar | org.eclipse.birt.doc.isv | enginescript/api |
How to add BIRT libraries and API Javadoc to a Java application’s build path
Use the Java perspective in the Eclipse Workbench to perform these steps on an existing Java project.
1 Install the BIRT Engine package to create a BIRT home.
2 To make the BIRT Javadoc files accessible to the Eclipse Java perspective, navigate to the eclipse\plugins directory. Extract the org.eclipse.birt.chart
.doc.isv and org.eclipse.birt.doc.isv plug-in JAR files to a workspace or resource directory.
3 In Package Explorer, right-click the Java project. Choose Build Path➛
Configure Build Path.
4 In Properties for <project name>—Java Build Path, select Libraries. To add a JAR file to the build path, choose Add External JARs.
5 In JAR Selection, navigate to the BIRT home lib directory. Select a required JAR file. Choose Open. The JAR file appears in JARs and class folders on the build path.
6 To associate the Javadoc with the class files in a BIRT API library, perform the following steps:
1 Expand the API JAR file in JARs and class folders on the build path. Select Javadoc location: (None). Choose Edit.
2 In Javadoc for <JAR file name>, type or browse to the directory that contains the Javadoc extracted in step
2. Type or browse to the subdirectory specified in
Table 12-2.
3 Choose Validate. Validating Javadoc Location displays a message about whether the specified directory contains Javadoc. Choose OK.
4 If necessary, correct the path to the Javadoc. In Javadoc for <JAR file name>, choose OK.
7 Repeat steps
4 through
6 for each required BIRT JAR file.