birt-print-2.book Page 525 Friday, October 20, 2006 5:44...

525

I n d e x

Symbols" (double quotation mark) character

command line arguments and, 28JavaScript code and, 225

, (comma) character, 347\ (backslash) character, 225… button, 484

Aabsolute paths, 36, 38, 42abstract base class, 465Access databases, 26, 89accessing

BIRT Report Designer, 15charts, 37, 222component libraries, 55custom data sources, 131, 366data sets, 53, 214data structures, 211demo database, 25, 26design model objects, 153Eclipse PDE, 275Export Wizard, 292external data sources, 68, 366formatted output, 203images, 37, 89, 201installation demo, 5Java classes, 108, 109, 116Java objects, 131, 139metadata, 150Navigator, 104ODA data sources, 366, 371report components, 155, 156report designs, 154, 181, 204, 206

report elements, 181, 204report items, 181, 204, 207, 209, 210report properties, 155report viewer, 34, 36reports, 36, 40, 203resource files, 187, 206script editor, 91source code, 4, 267

Acrobat Reader, 203action handler, 188, 189, 201Active Server Pages. See ASPsadapter classes, 112, 117, 118, 339Add CVS Repository dialog, 257, 258Add Entry dialog, 288Add External JARS button, 355Add Folder button, 289Add Library button, 288adding

charts to designs, 232, 246, 250custom drivers, 53data sources, 390lists, 67ODA drivers, 366ODA user interfaces, 366, 367report items, 67, 213, 299, 301, 318scripted data sets, 131, 134scripted data sources, 133tables, 67update sites, 294

addScriptableJavaObject method, 187Adobe Acrobat Reader. See Acrobat ReaderafterClose events, 82, 120, 121afterClose method, 120, 121afterDataSetFilled method, 83afterDrawAxisLabel method, 83

birt-print-2.book Page 525 Friday, October 20, 2006 5:44 PM

526 I n d e x

afterDrawAxisTitle method, 83afterDrawBlock method, 83afterDrawDataPoint method, 83afterDrawDataPointLabel method, 83afterDrawFittingCurve method, 84afterDrawLegendEntry method, 84afterDrawMarkerLine method, 84afterDrawMarkerRange method, 84afterDrawSeries method, 84afterDrawSeriesTitle method, 84afterFactory events, 83, 123afterFactory method, 102, 103, 123afterGeneration method, 84afterOpen events, 82, 120, 121afterOpen method, 76, 120, 121afterRender events, 75, 83, 123afterRender method, 123afterRendering method, 84aggregate data. See aggregate valuesaggregate expressions, 465aggregate functions, 465aggregate package, 164, 165aggregate values, 466aggregating data, 53aliases, 99, 128, 466All Extensions section (Extensions), 284alternate names. See aliases; display namesancestor classes, 466

See also superclassesannotation element, 268annotations, 268, 285Ant scripts, 290Apache Derby databases, 8, 25Apache Tomcat manager accounts, 39Apache Tomcat servers, 33, 34api extension package, 318API Javadoc, 146api packages, 145, 181APIs. See application programming

interfacesAPPCONTEXT_HTML_RENDER_

CONTEXT constant, 201APPCONTEXT_PDF_RENDER_CONTEXT

constant, 201appinfo attribute, 268applets, 466application context, 94, 187, 200application context objects, 36, 126

application programming interfaces (APIs)BIRT engines and, 52BIRT extensions and, 267charts and, 219, 239custom data sources and, 366custom report designers and, 56custom report generators and, 56defined, 467report designs and, 185report engine and, 147, 148report items extensions and, 301report rendering extensions and, 329reporting applications and, 145, 181, 182,

183application servers, 26, 33, 40, 147applications

See also multithreaded applicationsaccessing report designs for, 154, 181, 204,

206accessing report items for, 204accessing report viewer for, 36configuring engine home for, 186connecting to external sources and, 202,

366, 380creating stand-alone, 56, 185customizing, 56debugging, 190defined, 466deploying, 36, 183developing, 145, 181, 183, 267generating charts from, 23, 163, 219, 239generating reports from, 181, 182, 185,

203, 204getting context for, 94, 126, 200installing plug-ins for, 184, 271integrating with Eclipse, 47rendering environments for, 181running reports and, 147, 148validating report designs for, 52

application-wide scriptable objects, 148archive files

See also jar files; war filesBIRT packages in, 3, 23BIRT Samples and, 28, 29BIRT Test Suite and, 29chart engine and, 24demo database and, 25downloading, 14, 15, 17


I n d e x 527

archive files (continued)report engine and, 27unpacking, 5, 14

arguments, 119, 467See also functions; parameters

array properties, 99arrays

column values and, 99connection properties and, 101defined, 467executable expressions and, 60images and, 89ODA result sets and, 386row objects and, 99scripted data sets and, 141, 142user-defined properties and, 60

ASCII files. See text filesASPs, 465assignment statements, 467attribute package, 165, 170, 172attributes

See also elements; propertiescomplex properties and, 210plug-in extension points and, 286, 299report item extensions and, 268, 284report parameters and, 195ROM elements and, 62, 63XML schemas and, 268, 283

AutoDataBinding charting example, 247AutoDataBindingViewer class, 247axes properties (charts), 223, 228axes values, 228, 229, 230

See also chartsaxis.jar, 34axis-ant.jar, 34

Bbackground colors, 96backslash (\) character, 225BEA WebLogic servers, 33beforeClose events, 82, 120, 121beforeClose method, 120, 121beforeDataSetFilled method, 84beforeDrawAxisLabel method, 84beforeDrawAxisTitle method, 84beforeDrawBlock method, 84beforeDrawDataPoint method, 84beforeDrawDataPointLabel method, 84

beforeDrawFittingCurve method, 84beforeDrawLegendEntry method, 84beforeDrawMarkerLine method, 84beforeDrawMarkerRange method, 84beforeDrawSeries method, 85beforeDrawSeriesTitle method, 85beforeFactory events, 83, 123beforeFactory method, 76, 123beforeGeneration method, 85beforeOpen events, 82, 101, 120, 121beforeOpen method, 76, 101, 120, 121beforeRender events, 75, 83, 123beforeRender method, 76, 123beforeRendering method, 85Binary Build section, 288, 290binary files, 55, 181binding data sets to charts, 232binding data sets to report items, 216BIRT, xx, 468BIRT API Test Reference.doc, 29BIRT applications, 47, 48, 51

See also applicationsBIRT Chart Engine, 7, 23, 468

See also chart engine; chart engine APIBIRT Chart Engine package, 14BIRT components, 47BIRT Demo Database, 8, 469

See also Classic Models sample databaseBIRT Demo Database package, 14, 25birt directory, 42BIRT documentation, xix, xx, xxi, 146BIRT engines, 48, 52

See also specific engineBIRT extensions, 469

See also extensionsBIRT model API, 205BIRT open source projects, xvii

See also projectsBIRT RCP Report Designer

See also BIRT Report Designer; rich client platforms

accessing sample database for, 8, 25compared to BIRT Report Designer, 51defined, 470downloading packages for, 3, 23installing, 3, 16–18removing cached pages for, 18software requirements for, 5


528 I n d e x

BIRT RCP Report Designer (continued)starting, 19testing installations for, 18updating, 31, 32

BIRT Report DesignerSee also designsaccessing sample database for, 8, 25adding charting functionality for, 24compared to BIRT RCP Designer, 51compatibility with Eclipse, 6, 7configuring, 7defined, 469downloading packages for, 3, 23extending functionality of, 54, 267installing, 4, 14–15installing auxiliary files for, 14integrating report engine with, 147integrating with ODA drivers, 53, 366overview, 51removing cached pages for, 18scripting and, 73, 91, 111, 132software requirements for, 6–7starting, 15, 19testing installations for, 15tracking method execution with, 102, 103,

104updating, 31

BIRT Report Designer Full Eclipse Install, 5, 15–16

BIRT Report Designer perspective, 15BIRT Report Designer tools, 49BIRT Report Engine, 9, 26, 469

See also report engine; report engine APIBIRT Report Engine package, 14BIRT report object model, 59

See also ROMBIRT reporting platform, xixBIRT Samples archive, 28BIRT Samples package, 9, 14, 28, 470BIRT source code. See source codeBIRT technology, 47, 470BIRT Test Suite, 470BIRT Test Suite package, 9, 29BIRT web site, xviiBIRT.exe, 18birt.war, 34BIRT_FONT_PATH variable, 40BIRT_HOME variable, 27, 148, 186

BIRT_VIEWER_IMAGE_DIR parameter, 37BIRT_VIEWER_LOG_DIR parameter, 37BIRT_VIEWER_LOG_LEVEL parameter, 37BIRT_VIEWER_SCRIPTLIB_DIR

parameter, 37BIRT_VIEWER_WORKING_FOLDER

parameter, 36, 37, 42blank strings, 43bookmarks, 192, 467Boolean class, 109BOOLEAN data type, 100Boolean expressions, 467break reports. See grouped reportsbreakpoints, 468bridge class, 468bridge driver, 26browsers. See web browsersbuffered emitters, 340bug reports, 11Bugzilla, xviiBuild All command, 290Build Automatically command, 290Build Configuration page, 288Build page (PDE Manifest Editor), 279, 287build settings, 279build.properties file, 268, 279build.properties page (PDE Manifest

Editor), 279building

BIRT open source projects, 253–256design tools, 153Hibernate driver plug-in, 439Hibernate ODA UI plug-in, 458ODA extensions, 368plug-in extensions, 287–290report design tools, 154report viewer, 262reports, 76, 78rotated label report item extension, 301update sites, 294user interfaces, 320, 321web viewer, 262

builds, 10, 14, 16, 17BuildViewer.xml, 263BundleActivator interface, 272Business Intelligence and Reporting

Tools, 47, 468See also BIRT


I n d e x 529

byte arrays, 89

Ccache, 271cache conflicts, 18, 24cached pages, 18, 24calculated columns. See computed fieldscanInherit attribute, 372canInherit property, 309canLeave method, 456capitalization. See case sensitivitycaptions (charts), 86, 164carriage return characters, 347cascading parameter groups, 193, 196cascading parameters, 193, 196, 197, 198, 471cascading style sheets, 62, 184, 185, 471CASCADING_PARAMETER_GROUP

value, 194case sensitivity, 472category, 472category axes. See axes valuescategory series, 228, 230

See also data seriescategory values, 472

See also chartscell elements. See cellscell interfaces, 124, 125cell items. See cellsCell objects, 124, 125CellHandle class, 157cells

adding grid elements and, 67adding list elements and, 78building programmatically, 124, 125, 339defined, 472determining contents of, 208labels in, 213writing to CSV files and, 345, 347

CGI (defined), 475changeLogLevel method, 190changing

charts, 86, 222connection properties, 101data set bindings, 216data sources, 215locales, 21plug-in project settings, 278, 279queries, 101

report designs, 185, 204, 206, 211report elements, 205report item properties, 211, 212report items, 211URL context roots, 36

character patterns, 509character sets, 472character strings. See stringscharacters

CSV output files and, 347defined, 472JavaScript code and, 99, 225trimming, 381

chart areas, 223chart builder, 54, 249chart classes, 163, 226chart components. See chart itemschart elements, 473

See also chartschart engine

avoiding caching conflicts for, 24defined, 468installing, 23–24overview, 53software requirements for, 7

chart engine API, 145, 163, 164chart engine API library, 184Chart Engine archive, 24chart engine classes, 164chart engine documentation, 24chart engine package, 14chart event handler methods, 83, 85chart events, 83, 87chart examples plug-in, 246chart generator, 145chart instance objects. See chart objectsChart interface, 164chart item extensions, 52chart items

See also chartsdefined, 54developing, 231displaying, 52setting dimensions of, 232setting properties for, 231

chart model implementation classes, 163chart model packages, 163, 165

birt-print-2.book 29 Friday, October 20, 2006 5:44 PM

530 I n d e x

chart objectsSee also chartsaccessing, 85, 86getting, 222instantiating, 164, 226, 231modifying, 163

chart package, 24, 145, 163chart properties

changing, 222chart instance objects and, 227–228chart items and, 231charting applications and, 222–224getting, 86setting, 87, 164

chart reportitem plug-in, 301chart script context objects, 83, 85chart scripting, 224, 225chart subtypes, 86, 87chart types, 86, 87, 164, 227chart wizard. See chart builderChart3DViewer application, 248chartengineapi.jar, 184charting APIs, 219, 222, 225, 239charting application sample plug-ins, 470charting applications, 219, 221, 233charting examples, 219, 246, 301charting extensions, 301, 473charting library. See chart engineChartModels class, 247, 250charts

See also chart elements; chart itemsaccessing, 37, 222adding interactive features to, 87, 247adding series to, 224, 228–230adding to designs, 232, 246, 250applying styles to, 248, 250binding data sets to, 232changing, 86, 222creating, 54, 164, 225, 231, 239defined, 472defining event handlers for, 83–89, 224–

225, 248defining sample data for, 87, 226, 231exporting to CSV files and, 337generating, 53, 221, 247getting data sets for, 232getting primary base axis for, 228getting type, 86

outlining areas in, 227rendering as images, 201scripting for, 83, 85, 88setting properties for. See chart propertiesspecifying type, 87, 227

ChartScriptContext objects, 83, 85ChartWithAxes interface, 164ChartWithAxes type, 223ChartWithoutAxes interface, 164ChartWizardLauncher charting

example, 249ChartWizardLauncher class, 249cheat sheets, 56checking out source code, 256, 259choice definitions, 63ChoiceType element, 63class attributes, 286class definitions, 63Class element, 63class element, 309class files, 110, 116, 286class hierarchy, 473class loaders, 371class method definitions, 64class names, 109, 118, 269, 473class property, 308, 335class variables, 474

See also instance variables; variablesclasses

accessing, 109accessing report parameters and, 193associating with report elements, 116building report designs and, 153, 154, 157changing chart objects and, 163compiling rotated label plug-in and, 302,

308, 309creating, 63, 111, 112customizing ODA drivers and, 365, 368,

426defined, 473deploying applications and, 183deploying Java, 141developing with, 145, 181extending adapter, 339generating CSV output and, 338, 339, 355generating reports and, 148, 151, 186hierarchical diagrams for, 146loading, 371


I n d e x 531

classes (continued)naming conventions for, 117referencing, 109, 139registering, 225running plug-in instances and, 272scripting and, 108, 109, 139, 140setting attributes for, 286setting properties for, 287

classes directory, 110Classic Models sample database

See also demo databaseaccessing, 25, 26installing, 8, 25testing installation for, 25writing event handlers for, 104

Classic Search page (PDE Manifest Editor), 283

ClassicModels directory, 25ClassLoader objects, 436classpaths

charting applications and, 221CSV ODA driver extensions and, 370CSV rendering extension and, 334Hibernate ODA drivers and, 420, 436Java event handler classes and, 112, 116Java packages and, 108, 109plug-in extensions and, 278scripted data sources and, 140

–clean option, 18clean-up code, 78, 102, 103, 140clean-up processing phase (events), 78CLI library, 184close events, 82close method

generating reports and, 200Hibernate drivers and, 430, 434report designs and, 217report items and, 103scripted data sets and, 122, 140scripted data sources and, 121, 132

closeTag method, 341, 348closing

connections, 380, 381, 434cursors, 380data sets, 82, 121, 122, 140data sources, 82, 120, 121, 132, 135output files, 344report engine objects, 183

codeaccessing data sources and, 131accessing Java source, 4, 267accessing sample, 297adding event handlers and, 74, 81, 91changing run-time connections and, 101checking for errors in, 105checking out, 256, 259compiling, 254, 290creating Eclipse projects and, 256customizing, 73defining executable, 67deploying applications and, 183developing applications and, 145, 182,

183developing Hibernate drivers and, 420developing ODA extensions and, 367downloading, 302editing, 470executing reports and, 93extracting URL parameters and, 95generating CSV files and, 329, 330, 359initializing report designs and, 83loading, 271, 497specifying repository location for, 257tracking method execution in, 102, 103

Code page. See script editorcode points, 474codec library, 184collectCustomProperties method

CSVFilePropertyPage, 406CSVFileSelectionPageHelper, 407CSVFileSelectionWizardPage, 409HibernateDataSourceWizard, 452HibernatePageHelper, 449, 451HibernatePropertyPage, 452

collectDataSetDesign method, 458collections, 61, 194, 195, 196color settings, 60, 96, 230column aliases, 99, 128column bindings, 216, 475column headings, 99, 128column names

accessing CSV data and, 367defining, 122getting, 99, 128, 387retrieving values and, 99

columnar layouts, 67


532 I n d e x

columnBindingsIterator method, 216columnNumbers variable, 345columns

See also fields; computed fieldsaccessing, 99, 128, 215adding to designs, 137counting, 86, 87, 99, 128defined, 474defining output, 135dynamically generating, 82getting information about, 99getting type, 100, 128getting values in, 99, 380iterating through, 100naming. See column headings; column

namescomma (,) character, 347comma tag, 348command line applications, 147command line arguments, 28comma-separated values. See CSV formatscomma-separated values rendering

extension. See CSV report rendering extension

commit method, 430commit operations, 380, 430Common Gateway Interface, 475CommonConstant class, 382, 389, 427communications protocol, 508compiler preferences, 254compiling, 116, 254, 289, 290complex properties, 209, 211, 212compliance settings, 255component hierarchy (BIRT), 47component libraries, 51, 55component package, 165, 173component palettes. See Palette viewcomponents

See also report elements; report itemsaccessing, 155, 156adding report items and, 53, 67extending functionality of, 54saving, 51setting properties for, 67

computed columns. See computed fieldscomputed data. See computed valuescomputed fields, 100, 128, 138, 475computed values, 138, 475

concatenation, 225Concurrent Versions System repository. See

CVS repositoryconditional expressions. See Boolean

expressionsconfig variable, 94configuration files, 36, 37, 38, 450, 475Configuration Markup section, 284configuration objects, 148, 187configuring

Eclipse workspace, 254engine home, 186extension points, 284Hibernate drivers, 420, 427, 438, 439, 450report engine, 148, 187, 188report viewer for alternate locations, 36

Connection class, 381, 426, 428Connection objects

defined, 476ODA drivers and, 380, 381, 426report engine and, 182

connection properties, 101connection wizards, 404connectionProfile extension point, 404, 442connections

BIRT drivers and, 203external data sources and, 68, 202getting, 388, 428Hibernate data sources and, 428, 429, 434JDBC data sources and, 101ODA data sources and, 53, 101, 380, 381ODA drivers and, 380, 381, 382, 428report engine and, 182

constants, 108, 405, 476Constants class, 405constructor code, 476constructSessionFactory method, 428, 436,

438container elements, 67containers, 476containment, 476containment hierarchy, 476content. See structured contentcontent objects, 344content package, 339, 340ContentEmitterAdapter class, 338ContentEmitterVisitor objects, 342ContentType property, 340


I n d e x 533

context mapping, 36context objects, 94, 126, 200context parameters, 36, 38context root, 36context-param element, 38contributors, 29, 253converters, 476copying .jar files, 38core API library, 184core plug-ins, 267coreapi.jar, 184counters, 104, 106Create Ant Build File command, 290Create Java Project dialog, 354create method, 164create_classicmodels.sql, 26createAndInitCustomControl method, 406,

449, 451, 452createCustomControl method, 407, 449createGetParameterDefinitionTask

method, 193createPageControl method, 409, 453createPageCustomControl method, 408, 449,

451, 452createRenderTask method, 200createRotatedText method, 321createRunAndRenderTask method, 199createRunTask method, 199creating

BIRT projects, 253–256charting applications, 220, 221, 233charts, 54, 164, 225, 231, 239Eclipse projects, xvii, 256–261event handler class, 111, 112event handlers, 73, 74, 91, 112, 118

tutorial for, 104–108Hibernate driver plus-ins, 420Java applications, 56, 147Java classes, 63, 111, 112, 355lists, 67ODA driver extensions, 366, 379ODA driver plug-ins, 368, 379ODA drivers, 365, 367, 419plug-in extensions, 279–287queries. See queriesreport designs, 55, 153, 205, 217report elements, 124, 125, 213report engine, 148

report item extensions, 299, 312report items, 54, 213, 299, 300, 318reporting applications, xix, 181, 182, 183,

185, 204reports, 154, 182ROM elements, 64scripted data sets, 131, 134scripted data sources, 131, 132, 133stand-alone applications, 56, 185tables, 67update sites, 294

criteria. See parameterscross tabs, 476cross tabulation. See cross tabs; cross-tab

reportscross-tab reports, 476CSS files, 184, 185, 471

See also cascading style sheetsCSV data structures, 367CSV files

accessing data in, 367, 381connecting to, 381creating designs for, 359developing ODA extensions for, 365, 379initializing output streams for, 342printing, 341rendering options for, 349structuring, 341viewing content of, 357writing to, 329, 339, 341, 346, 357

CSV formats, 337, 339, 349, 357CSV ODA driver extension examples, 297,

367, 381CSV ODA driver extensions

compiling and debugging, 368creating, 366, 379downloading plug-ins for, 367implementing, 371setting dependencies for, 370specifying run-time settings for, 370

CSV ODA driver interfaces, 379CSV ODA driver plug-in project, 365, 368,

390CSV ODA driver plug-ins, 368, 414CSV ODA drivers, 367, 371CSV ODA extensions, 367CSV ODA interfaces, 381CSV ODA plug-ins, 367


534 I n d e x

CSV ODA UI extension, 368, 390–403CSV ODA UI plug-in, 393, 403csv package, 341, 381csv plug-in, 350, 367CSV report rendering extension

changing report engine API and, 348creating projects for, 331, 353developing, 330downloading required plug-ins for, 330implementing content interfaces for, 339,

340launching, 353, 354overview, 337running, 341, 356setting dependencies for, 334testing, 350viewing output for, 357

CSV report rendering plug-inbuilding, 350launching, 353, 354testing, 350

csv ui plug-in, 367, 368, 390csv ui wizards plug-in, 405CSV writer, 341, 342, 343CSVBufferReader class, 381, 385CSVFileDriver class, 381, 382CSVFilePropertyPage class, 405, 406CSVFileQuery class, 381, 382CSVFileSelectionPageHelper class, 405, 406CSVFileSelectionWizardPage class, 405, 408csvODA.jar, 370CSVPlugin class, 341CSVRenderOption class, 348, 349CSVReportEmitter class, 341, 344CSVReportEmitter method, 342CSVTags class, 341, 348csvTest.reportdesign, 359CSVWriter class, 341, 348current release, 267currentSession method, 439cursors, 380, 386CurveFittingViewer application, 248custom chart generator, 145custom data sources, 366

See also ODA data sourcescustom Java classes, 140custom report design tool, 154custom report designer, 56, 62, 147

custom report generators, 56, 145custom status handlers, 187customizing

applications, 56BIRT packages, 29colors, 60ODA drivers, 53, 57, 366output formats, 199, 300, 330report emitters, 57report engine, 147report items, 54, 57, 301reports, 185source code, 73user interfaces, 195XML elements, 60

CVS perspective, 257CVS repository, 256, 257, 267, 302CVS Repository Exploring command, 257

Ddata

See also data elements; valuesdefined, 477exporting, 183, 337extracting, 150, 183, 337filtering, 53, 56, 193generating sample, 87, 226, 231retrieving, 53, 131, 139, 196

data access components, 53data adapter API library, 184data adapters. See adapter classesdata components. See data elementsdata drivers, 148data elements, 68, 477

See also datadata engine, 53, 366data engine extension, 53Data Explorer, 477data extension names, 128data filters, 488data package, 165, 174data points, 478

See also chartsdata rows, 478

See also rowsdata series

See also chartsadding, 224, 228–230


I n d e x 535

data series (continued)building queries for, 229, 230changing properties for, 224defined, 515getting properties for, 86setting properties for, 87, 230setting type, 164

data set classes, 215data set elements, 68, 82, 120, 372

See also data setsdata set extension properties, 128data set fields. See columnsdata set instance interface, 128data set objects, 128

See also data setsdata set page (Hibernate UI plug-in), 420,

449data set page (ODA UI plug-in), 367data set parameters, 478

See also parametersdata set types, 380data sets

See also data set elements; data set objectsaccessing, 53, 214accessing columns in, 99, 128binding to charts, 232binding to report items, 216building programmatically, 128changing data sources for, 215changing properties for, 215changing queries for, 101closing, 82, 121, 122, 140creating scripted, 131, 134customizing drivers for, 53defined, 478defining event handlers for, 82, 91, 120,

122, 128developing ODA extensions for, 366, 380,

382, 390, 420fetching, 129, 138, 140filtering data in, 193getting data sources for, 128getting metadata for, 128getting names, 129getting number of columns in, 99, 128getting properties for, 215getting query strings for, 100, 129getting type, 129

opening, 82, 121, 122, 139setting properties for, 215setting query strings for, 129

data source classes, 214data source connection wizards, 404data source drivers. See driversdata source elements, 68, 82, 120, 371, 372

See also data sourcesdata source extension points, 367, 404, 441data source objects, 478

See also data sourcesdata source page (Hibernate UI plug-

in), 419, 449data source page (ODA UI plug-in), 367data source plug-ins, 366, 371data sources

See also specific data source typeaccessing, 68, 131, 214, 366adding, 390changing, 215changing properties for, 101closing, 82, 120, 121, 132, 135connecting to. See connectionscreating scripted, 131, 132, 133defined, 478defining event handlers for, 82, 91, 120developing ODA extensions for, 366, 419getting, 128opening, 82, 120, 121, 135retrieving data from, 53unsupported, 53

data structures, 211Data Tools platform (Eclipse), 53, 257, 365,

366data transform components, 53data type mappings, 372, 378data types

columns and, 100, 128CSV files and, 382defined, 479Hibernate data sources and, 425ODA drivers and, 382, 388ODA result sets and, 386report parameters and, 195ROM metadata structures as, 65XML schemas and, 268, 299

dataadapterapi.jar, 184database drivers. See JDBC drivers


536 I n d e x

database management systems, 479database platforms, 8database schemas, 514databases, 365DataCharts charting example, 246DataChartsViewer application, 246datafeed package, 164, 165DataSet element, 68, 82, 120, 372dataSet objects, 128

See also data setsDataSetAdapter class, 120DataSetHandle class, 214, 215DataSetMetaData class, 382, 388, 427, 430dataSetPage element, 395dataSetUI page wizard, 449dataSetWizard attribute, 395DataSetWizardPage class, 404, 452DataSource element, 68, 82, 120, 371, 372dataSource extension point, 367, 404, 441dataSource plug-in, 366, 371DataSource property, 101dataSource.exsd, 366, 374DataSourceAdapter class, 120DataSourceEditorPage class, 404DataSourceHandle class, 157, 214DataSourceWizardPage class, 404datatools directory, 367Datatools repository. See Data Tools platformdataTypeMapping element, 378, 425dataTypeMapping type, 372DataTypes class, 382, 388, 427date values, 479date-and-time data type, 479DATETIME data type, 100DBMS (defined), 479Debug mode, 353debugger, 74debugging

applications, 190defined, 479ODA driver extensions, 368

DECIMAL data type, 100declarations, 479default engine configuration, 148default values, 154, 194DefaultDataServiceProviderImpl class, 249defaultDisplayName attribute, 371, 372defaultDisplayName property, 309defaultStyle property, 308

defaultValue attribute, 372defaultValue property, 309definitions, 465deleteGlobalVariable method, 94, 126deletePersistentGlobalVariable method, 94,

126deleting

cached information, 18, 24global variables, 94, 126temporary files, 148

demo database, 469See also Classic Models sample database

demo database package, 14, 25dependencies (plug-ins), 279, 305, 392Dependencies option (PDE Editor), 279Dependencies page (PDE Editor), 278, 305deploying

applications, 36, 183Hibernate ODA UI plug-in, 458Java classes, 141plug-in extensions, 268, 291–296report designs, 204report item extensions, 302, 324report viewer, 33, 51reports, 33, 110, 112

Derby databases, 8, 25derived classes. See descendant classesdescendant classes, 480describe events, 82describe method, 122design elements, 66, 82, 122design engine, 52, 54, 204design engine API, 145, 153, 154, 157, 181

See also report model APIdesign engine class, 154design environments. See BIRT; Eclipsedesign files

accessing report items in, 222associating with reports, 42defined, 509generating, 52, 56, 154generating reports from, 147, 182, 190,

200, 206installing report viewer and, 35, 36loading, 149naming, 326opening, 62, 182, 190, 206

examples for, 104, 191overview, 55


I n d e x 537

design files (continued)referencing in URLs, 37, 41, 42renaming, 232running, 150, 200specifying paths for, 37validating, 52

design interfaces, 124design model objects, 153design perspective, 14design properties, 66design tools, 51, 153, 154DesignChoiceConstants interface, 209, 211DesignConfig objects, 206DesignElement element, 66DesignElementHandle class, 156, 210, 317DesignEngine class, 154, 206, 317DesignEngine objects, 206designer packages, 4, 13, 31designer ui extensions package, 316designers, 13, 51, 56, 147

See also BIRT Report Designer; BIRT RCP Report Designer

designing reports, 56See also designs

designsSee also page layoutsaccessing, 154, 181, 204, 206accessing Hibernate data sources for, 441accessing items in, 204accessing properties for, 155accessing ROM schema for, 62adding charts to, 232, 246, 250adding data sources to, 390adding report items to, 67, 207, 213, 301changing, 185, 204, 206, 211connecting to external sources and, 202creating, 55, 153, 205, 217defined, 480defining event handlers for, 74, 75, 82, 91,

122deploying, 204developing, 204extending functionality of, 57generating CSV files and, 359getting parameters in, 194initializing, 76, 83, 102, 123retrieving data for, 366reusing, 51

saving, 204, 217, 232setting location of, 36, 37, 42setting properties for, 191testing for parameters in, 194validating, 52, 62, 65viewing report items in, 77

desktop applications. See Java appletsdesktop reporting application, 147destroy method, 148detail processing phase (events), 80detail reports. See subreportsdetail rows, 80detailType property, 309developing

applications, 145, 181, 183, 267Hibernate ODA UI extensions, 441, 448ODA extensions, 365, 366, 419plug-ins, 268, 275rendering extensions, 329, 330, 337report designs, 153, 204reports, 13, 73

development environments, 74development languages, 494

See also scripting languagesdevelopment tools, 267device package, 164, 166DHTML (defined), 481DialChart interface, 164DialChartViewer application, 248Dimension attribute (charts), 87directories

accessing fonts and, 201accessing Java classes and, 110, 140accessing report designs and, 36, 37, 42creating event handlers and, 38creating images and, 37, 201deploying applications and, 183, 186displaying reports and, 34installing language packs and, 20installing plug-ins and, 267, 268, 271installing report viewer and, 36saving temporary files and, 187unpacking program archives and, 5updating designer applications and, 32

disk writes, 147display names, 371, 372, 480displaying

charts, 52


538 I n d e x

displaying (continued)error messages, 105, 108extension point descriptions, 283, 284HTML pages, 41PDF files, 41PDF reports, 203project settings, 278property annotations, 285reports, 40, 51, 52

displayNameID property, 309displayText property, 309, 320distributing reports. See deploying reports__document parameter, 41, 42document files

accessing data in, 150creating, 183, 199defined, 510generating reports from, 181, 182, 190,

192opening, 149, 182, 191overview, 55referencing in URLs, 41setting location of, 42writing to disk, 150

document object model. See DOMdocument type definitions, 480documentation, xix, xx, xxi, 24, 146documentation attribute, 269documents, 181, 192, 203, 337

See also reportsDOM (defined), 480domain names, 481double quotation mark (") character

command line arguments and, 28JavaScript code and, 225

download sites, 14downloadable archives, 5downloading

Apache Tomcat servers, 34BIRT Report Designer packages, 23BIRT Samples package, 28BIRT Test Suite, 29chart engine archive, 24demo database, 25Eclipse Modeling Framework, 7Eclipse SDK software, 6extension examples, 297Graphics Editor Framework, 7

iText PDF library, 15, 16, 17JDK software, 5, 6language packs, 20program archives, 14, 15, 17report engine archive, 27sample database, 9source code, 302

driver classes, 101driverClass attribute, 371drivers

See also specific typeaccessing external sources and, 366connecting to, 202, 203creating ODA, 53, 365, 367, 419customizing, 57defined, 481installing, 35registering, 436required, 185setting location of, 148specifying interfaces for, 379

drivers directory, 35, 436drivers subdirectory, 185DTD (defined), 480dteapi.jar, 184DTP ODA classes, 365, 366DTP ODA extension points, 366DTP ODA framework, 404DTP ODA interfaces, 365, 366, 379dynamic data. See datadynamic hypertext markup language. See

DHTMLdynamic images, 89dynamic text elements, 481dynamic variables, 481

Ee.reports. See reportsEclipse compiler, 254Eclipse Data Tools Platform, 53, 257, 365, 366Eclipse desktop development environment.

See Eclipse WorkbenchEclipse environments, 74, 482Eclipse frameworks, 48Eclipse Modeling Framework, 7, 482Eclipse perspective, 482Eclipse platform, 6, 48, 267, 483

See also Eclipse Rich Client Platform


I n d e x 539

Eclipse Plug-in Development Environment, 267, 275, 483

See also PDE WorkbenchEclipse projects, xvii, 47, 256–261, 483

See also projectsEclipse Rich Client Platform, 483

See also rich client platformsEclipse SDK software, 6Eclipse views, 278, 483Eclipse Workbench, 73, 277, 325, 484Eclipse workspace, 254, 484ECMAScript language, 91Edit Script command, 138editor attribute, 308editor pages, 395EJBs, 131, 485element, 269element definitions (ROM), 64Element element, 64element method definitions (ROM), 65ElementDetailHandle class, 161ElementFactory class, 213ElementFactory objects, 231elements

See also report elements; ROM elementsaccessing CSV files and, 371customizing plug-ins and, 268defined, 484defining plug-in extension, 283plug-in extension points and, 286, 299

ellipsis (...) button, 484embeddable HTML output, 200embedded fonts, 201, 202embedded HTML, 200embedded report engine, 147EMF (defined), 482EMF libraries, 185EMF software, 7emitter csv plug-in, 341, 350emitter extension points, 330, 335emitter extensions, 300, 363emitter interfaces, 337emitter objects, 342emitter package, 329emitter plug-in, 337, 338emitters

customizing, 57defining rendering options for, 349

extending functionality of, 330, 335generating CSV output and, 341, 350generating reports and, 52, 188rendering extensions and, 330setting properties for, 336

emitters package, 335emitters plug-in, 300emitters.exsd, 300, 330encapsulation, 484encoding, 522end method, 343endCell method, 347endRow method, 347engine API library, 184engine api package, 145, 151, 152engine APIs. See chart engine API; report

engine APIengine extension package, 317engine home, 183, 186engine home directory, 183engine plug-ins, 148, 331engine variable, 202engineapi.jar, 184EngineConfig class, 148EngineConfig objects, 148, 186, 187, 190EngineConstants class, 348, 349EngineEmitterServices class, 339EngineException exceptions, 203engines, 48, 52, 366

See also specific engineenterprise, 485Enterprise JavaBeans. See EJBsenterprise reporting, 485enterprise systems, 485enumeration classes, 163, 165environment-dependent processing, 147environments, 506error messages, 105, 108, 382errors, 105evaluateQuery method, 197event firing sequence, 74–75event handler classes, 111, 112, 116, 118, 123event handler interfaces, 112, 117, 118event handlers

accessing JAR files for, 38adding logging code to, 81adding to designs, 74, 82, 91, 122associating context objects with, 94, 126


540 I n d e x

event handlers (continued)associating with report elements, 116–117building charts and, 83–89, 224–225, 248building data sets and, 82, 120, 122, 128building data sources and, 82, 120, 121creating, 73, 74, 91, 112, 118

tutorial for, 104–108defined, 485executing, 74–81, 93mapping to report viewer and, 37rendering report elements and, 61, 95, 111rendering report items and, 61, 81, 119rendering sequence for, 75

event listeners, 486event package, 164, 166events

See also event handlersaccessing data sources and, 82building data rows and, 78building dynamic columns and, 82controlling page breaks and, 75creating report designs and, 82, 122defined, 485firing, 61, 74–75generating reports and, 75, 76, 78generating table or lists and, 78–81running reports and, 74, 76–81, 93scripting for, 73, 74, 104, 118subscribing to, 273

example charting applications, 24example database, 8

See also Classic Models sample databaseexample extensions, 297exception package, 164, 168exceptions, 210, 486executeQuery method, 384, 433ExecuteReport class, 357executing reports, 74, 76, 93execution processes, 93execution sequence (events), 74, 75–81Experts. See wizardsexport options, 292Export Wizard (PDE), 291exporting data, 183, 337exporting plug-in extensions, 292, 302Exporting section (Overview), 292expression builder, 486expression property type, 61

expressionsdefined, 486defining aggregate values and, 465manipulating numeric values and, 502manipulating string data and, 518matching text patterns and, 509returning Boolean values from, 467setting properties and, 61

ex-property property type, 61.exsd files, 268extended-item name element, 62ExtendedItemHandle class, 317ExtendedItemHandle objects, 226, 231, 232extensible markup language. See XMLextension APIs, 145extension element, 271Extension Element Details section, 283extension IDs, 308, 335, 371, 393extension names, 128, 269extension package (report engine), 301extension point identifier, 308, 335, 371, 393extension point schema definitions, 268, 283Extension Point Selection page, 281, 335extension points

accessing external sources and, 366accessing Hibernate data sources

and, 441, 444adding report items and, 299customizing ODA drivers and, 53, 371defined, 487defining, 279displaying descriptions of, 283, 284finding, 283generating output and, 330, 335implementing, 267, 299selecting, 284, 310, 395

Extension Points page (New Extension), 310, 395

Extension Points page (PDE Editor), 279extensionName property, 308extensionProperties array, 101extensions

adding chart items and, 54adding report items and, 299, 301building plug-in, 287–290creating, 62, 279, 283, 299customizing report items and, 54declaring, 279


I n d e x 541

extensions (continued)defined, 487deploying, 268, 291, 296developing ODA, 53, 365, 366, 419naming, 308, 335, 393overview, 57, 267rendering reports and, 329, 356sample projects for, 297selecting export options for, 292setting class attributes for, 286setting contents of, 284specifying, 281structuring, 279–282testing, 291

extensions package, 316Extensions page (PDE Editor), 279, 281, 283external connections, 202external data sources, 68, 366, 379external libraries, 108external objects, 85

Ffactory method, 149factory package, 165, 168Factory processes, 93, 95Feature License dialog, 32Feature Updates dialog, 31Feature Updates page, 293features, 11, 293fetch method, 122, 132, 138, 140field variables, 487

See also member variables; variablesfields

See also columns; computed fieldsaccessing CSV data and, 367changing data sources and, 215defined, 487exporting CSV output and, 337, 339

File class, 381, 382file objects, 381, 382file types, 54, 488FileDialog method, 450files

See also specific typeaccessing resource, 187creating, 102downloading program archive, 14, 15, 17extracting program archive, 5, 14

generating output and, 181installing Tomcat servers and, 35mapping to report viewer, 36overview, 54–55rendering output and, 182tracking method execution in, 102, 103

FileSelectionWizardPage class, 405, 409filtering data, 53, 56, 193filters, 488finalization code, 78, 102, 103, 140Find and Install command, 293Find declaring extension point option, 283findDataSet method, 214findDataSource method, 214findElement method, 207finding extension points, 283finding program updates, 31findTOC method, 191flat file data sources, 365flat file plug-in, 365flat files, 488

See also flat file data sources; text filesFLOAT data type, 100flute.jar, 184folders, 289font files, 40font style constants, 211fontFamily style specification, 63fonts, 40, 201, 488footer grids, 76footer rows, 80footers, 80, 232, 488form e-capable browser, 489__format parameter, 41, 43format property, 335format styles. See stylesFormatCharts charting example, 247FormatCharts class, 247FormatChartsViewer class, 247formatQueryText method, 383formats

adding CSV, 349customizing report generation and, 52, 56defined, 488exporting data and, 337generating output and, 181, 199, 329getting output, 94, 127rendering images and, 201


542 I n d e x

formats (continued)rendering output and, 200, 201setting output, 182

formatted output, 181, 203formatting data. See formatsFormula Editor. See expression builderformulas. See expressionsframe objects, 109frameset servlet, 41framework, 489Full Eclipse Install (BIRT Report

Designer), 5, 15–16function declarations, 88function stubs, 87, 88, 112functions

See also methodsaccessing, 95defined, 489defining chart events and, 88, 225selecting, 97

fundamental data types. See data types

GGEF software, 7GeneralCategoryWrapper class, 321generating

charts, 53, 221, 247CSV files, 329, 339, 341, 346, 357design files, 154formatted output, 203HTML reports, 43, 149, 150, 199, 200lists, 78–81master pages, 76output, 43, 181, 329PDF documents, 43, 149, 150, 199, 201report design files, 52, 56, 154reports, 182, 185, 200, 203sample data, 231tables, 78–81

generation engine, 50, 51, 52generation-time events, 74, 75generators (custom), 145genReport script, 27get method, 208getAllExtensionProperties method, 128getAppContext method, 94, 126getBlock method, 86getBody method, 207

getCategoryTabs method, 321getChartInstance method, 85getChildren method, 191getColumnAlias method, 99, 128getColumnCount method, 99, 128, 130, 345getColumnLabel method, 99, 128getColumnMetaData method, 99, 128getColumnName method, 99, 128, 130, 387getColumnNativeTypeName method, 100,

128getColumnType method, 100, 128getColumnTypeName method, 100, 128getColumnValue method, 129, 130getConfigVariableValue method, 94getConnection method, 382, 388, 428getContents method, 194getDataSet method, 129getDataSets method, 214, 215, 232getDataSource method, 128getDataSources method, 214, 215getDataType method, 195getDefaultValue method, 194getDefaultValues method, 194getDescription method, 86getDesignHandle method, 206getDimension method, 86getElementFactory method, 231getExtendedProperties method, 86getExtensionID method, 129getExtensionProperty method, 129getExternalContext method, 85getGlobalVariable method, 94, 126getGridColumnCount method, 86getHibernateProp method, 439getHibernatePropTypes method, 439getHttpServletRequest method, 94, 126getInt method, 386getInteractivity method, 86getLabel method, 195, 319getLegend method, 86, 227getLocale method, 85, 94, 127getLogger method, 85getMaxConnections method, 428getMaxQueries method, 429getMeasure method, 212getMessage method, 94, 127getMetaData method, 429, 433getName method, 129


I n d e x 543

getNext method, 208getOutline method, 227getOutputFormat method, 94, 127getPageNumber method, 192getParameterDefn method, 194getParameterDefns method, 194getParameterType method, 194getParameterValue method, 94, 101, 127getParameterValues method, 195getPersistentGlobalVariable method, 94, 95,

127getPlot method, 86, 227getPrimaryBaseAxes method, 228getPrimaryOrthogonalAxis method, 228getProperty method, 191getPropertyDefinitions method, 320getQuery method, 410getQueryColumnNames method, 411getQueryString method, 95getQueryText method, 129getResult method, 435getResultSetColumn method, 216getResultSetExpression method, 216getResultSetMetaData method, 412, 457getRow method, 386getSampleData method, 86getScript method, 86getSelectionList method, 195getSelectionListForCascadingGroup

method, 198getSeriesDefinitions method, 230getSeriesForLegend method, 86getSeriesPalette method, 230getSeriesThickness method, 86getSQLStateType method, 431getString method, 388, 435getStyle method, 209getStyles method, 86getSubType method, 86getSupportedImageFormats method, 201getTitle method, 86getType method, 86getTypeCode method, 389getUnits method, 86getURI method, 208getValue method, 195getVersion method, 86getWidth method, 209, 212

global options (report engine), 148global variables, 92, 95, 126, 489

See also variablesGlossary, 465glyph, 489

See also character sets; fontsgrandchild classes. See descendant classesgrandparent classes. See ancestor classesgraphical report design tool, 51graphical user interfaces. See user interfacesgraphics. See imagesGraphics Editor Framework, 7GraphicsUtil class, 321graphs. See chartsgrid cells. See cellsgrid elements, 490grid items, 67, 77, 213GridColumnCount attribute, 86, 87grids, 67, 86, 87, 490

See also grid elements; grid itemsgroup fields. See group keysgroup headers, 491group keys, 491group slots, 208grouped lists, 79, 80grouped reports, 490grouped tables, 79, 80grouping data, 53, 56

See also groupsGroupOnXSeries charting example, 246GroupOnXSeries.rptdesign, 246GroupOnYAxis charting example, 246GroupOnYAxis.rptdesign, 246groups, 78, 490GUI components, 53

See also user interfaces

Hhandle classes, 156handle objects, 211handler class, 112

See also event handler classeshardware interfaces, 494HashMap objects, 202HashMap value, 151header grids, 76header rows, 80headers, 80, 491


544 I n d e x

headings. See column headingshelp, 503hexadecimal numbers, 491Hibernate Core for Java, 365, 366Hibernate data sets, 420, 449Hibernate data sources, 419Hibernate data types, 425Hibernate libraries, 441Hibernate objects, 131Hibernate ODA driver plug-in, 420, 439Hibernate ODA drivers, 419, 420, 427Hibernate ODA extension example, 426Hibernate ODA extensions, 419, 420Hibernate ODA UI example, 420Hibernate ODA UI extension points, 444Hibernate ODA UI extensions, 441Hibernate ODA UI plug-in

building, 458creating projects for, 442deploying, 458described, 419developing, 448launching, 460specifying dependencies for, 443specifying run-time settings for, 443testing, 460–463

hibernate package, 426hibernate plug-in, 419, 420, 439Hibernate Query Language. See HQL

statementshibernate ui plug-in, 419hibernate.cfg, 420HibernateClassSelectionPage class, 452HibernateDataSourceWizard class, 448, 452HibernateDriver class, 426, 428HibernateHqlSelectionPage class, 449HibernatePageHelper class, 448, 449, 452HibernatePropertyPage class, 448, 452HibernateUtil class, 427, 428, 436, 439hibfiles directory, 420, 436hierarchy, 491HOME property, 372homeDir parameter, 382host applications, 147host instance (PDE Workbench), 277HQL (defined), 365HQL statements

adding user interface for, 449

creating, 419, 429executing, 433retrieving data with, 435verifying, 454

HTML (defined), 491HTML elements, 484HTML emitter configuration property

type, 187HTML emitters, 52, 187, 188HTML formats, 329HTML frames, 41HTML reports

See also web pagesconfiguring properties for, 202generating, 43, 149, 150, 199, 200opening, 203rendering unpaginated, 150setting up rendering context for, 201viewing, 41writing to disk, 147

HTML tags, 489HTMLCompleteImageHandler objects, 188HTMLEmitterConfig objects, 187HTMLRenderContext class, 201HTMLRenderContext objects, 200HTMLRenderOption class, 150, 151, 182, 200HTMLServerImageHandler objects, 188HTTP (defined), 492HTTP request objects, 95HttpServletRequest objects, 94, 126hyperlinks, 337, 340, 491hypertext markup language pages. See web

pageshypertext markup language. See HTMLhypertext transfer protocol. See HTTP

IIAdvancedQuery interface, 381IBandContent interface, 339IBM WebSphere servers, 33IBounds interface, 340ICascadingParameterGroup interface, 193ICell interface, 124ICellContent interface, 339ICellInstance interface, 125IChartEventHandler interface, 88IChartScriptContext interface, 83, 85IColumnMetaData class, 99


I n d e x 545

IColumnMetaData interface, 128IConnection interface, 380, 426icons, 54, 308IContainerContent interface, 339IContent package, 340IContentEmitter interface, 338IContentVisitor interface, 340ICU library, 184id attribute, 371, 372, 394ID property, 308, 335, 371, 393id property, 335IDataContent interface, 339IDataExtractionTask interface, 150IDataExtractionTask objects, 183IDataSetEventHandler interface, 120IDataSetInstance interface, 128IDataSetMetaData interface, 380, 427IDataSetRow interface, 129IDataSourceEventHandler interface, 120identifiers, 492IDriver interface, 371, 380, 426, 428IElement interface, 340IEmitterServices interface, 338IEngineTask interface, 149IForeignContent interface, 340IGetParameterDefinitionTask interface, 149IGetParameterDefinitionTask objects, 194IGetParameterDefnTask interface, 193IHTMLActionHandler interface, 188IHTMLImageHandler interface, 188IHyperlinkAction interface, 340IImageContent interface, 340ILabelContent interface, 340image constants, 209image elements, 492image files, 36, 201image formats, 201image handler, 188ImageHandle objects, 208images

accessing, 37, 89, 201defined, 492exporting to sample CSV report rendering

extension and, 337rendering context and, 201rendering rotated text as, 319, 321

IMessages interface, 318impl packages, 163, 165import statements, 109

importing Java packages, 109, 139importPackage method, 109, 139in_count parameter, 142incrementing record counters, 106index.jsp, 35information. See datainheritance, 492initCustomControl method, 408, 449, 451initialization code, 83, 102, 139initialize events, 83, 123initialize method

building report designs and, 76, 102, 123, 154

creating event handlers and, 94creating output files and, 102creating output streams and, 342importing Java packages and, 109

initializeControl method, 454initializing report designs, 76, 83initSessionFactory method, 436inner joins, 493

See also joinsinput parameters, 141input sources. See data sourcesinput streams, 217inputParams array, 141, 142installation

BIRT Chart Engine, 23–24BIRT components, 5BIRT Demo Database, 25BIRT RCP Report Designer, 3, 16–18BIRT Report Designer, 4, 14–15BIRT Samples package, 28BIRT Test Suite, 29JDBC drivers, 35JDK software, 5, 6language packs, 19–21plug-ins, 184, 271report engine, 17, 27report viewer, 34–35, 36testing, 15, 18, 25, 27troubleshooting, 18–19TrueType fonts, 40

installation demo, 5instance interfaces, 125instance property, 226, 231instance variables, 493

See also class variables; variablesinstances. See objects


546 I n d e x

instantiation, 493INTEGER data type, 100integrated debugger, 74interactive features (charts), 87InteractivityCharts charting example, 247interfaces

See also application programming interfaces; specific programming interface

adapter classes compared to, 118chart engine API and, 163, 164CSV report rendering extension, 338, 339data row objects and, 129data set objects and, 128defined, 494design model objects and, 153developing with, 145event handlers and, 111, 112, 118, 123extending adapter classes and, 112Hibernate ODA drivers and, 428hierarchical diagrams for, 146naming conventions for, 117, 118ODA extensions and, 365, 371, 379overview, 123report elements and, 124–126report engine API, 152rotated label plug-in, 316run-time drivers and, 379

International Components for Unicode. See ICU library

internationalization, 23, 494See also locales

IP addresses, 494IPageContent interface, 340IParameterDefnBase interface, 193IParameterGroupDefn interface, 193IParameterMetaData interface, 381IParameterSelectionChoice class, 195IParameterSelectionChoice interface, 193IPlatformContext interface, 187, 188IPropertyDefinition interface, 318IPropertyTabUI interface, 316IQuery interface, 380, 427IRenderOption interface, 200, 349IRenderOption objects, 182IRenderTask interface, 150, 200IRenderTask objects, 182IReportContent interface, 341

IReportContext interface, 126IReportDocument interface, 149IReportDocument objects, 182, 191IReportElement interface, 124IReportEventHandler interface, 122IReportItem interface, 318IReportItemFactory interface, 318IReportItemLabelProvider interface, 316IReportItemPresentation interface, 317IReportItemPropertyEditUI interface, 316,

320IReportRunnable interface, 149, 190IReportRunnable objects, 182, 191IResultSet interface, 380, 427IResultSetMetaData interface, 380, 427IRowContent interface, 340IRowData interface, 129IRowInstance interface, 126IRowSet interface, 317IRunAndRenderTask interface, 150, 199, 200IRunAndRenderTask objects, 182, 202IRunTask interface, 150, 199IRunTask objects, 202IScalarParameterDefn interface, 193IScalarParameterDefn objects, 194isComputedColumn method, 100, 128IScriptedDataSourceEventHandler

interface, 121, 122isEmpty method, 194isEncryptable attribute, 372isEncryptable property, 309isNameRequired property, 308__isnull parameter, 41, 43isRowInFooterBand method, 346IStatusHandler interface, 187IStyle interface, 340IStyleModel interface, 317ITableBandContent interface, 340ITableContent interface, 340iterator method, 208, 435iterator objects, 140iText open source library, 5, 6, 7itext-1.3.jar, 15, 16, 221, 261ITextContent interface, 340ITextItem interface, 124

JJ2EE applications, 26, 40


I n d e x 547

J2EE environments, 13, 17, 494J2SE environments, 5, 6, 495.jar files

adding to classpaths, 113building projects and, 261building update sites and, 294configuring report engine and, 148copying, 38creating charting applications and, 221creating event handlers and, 112default location for, 110defined, 495deploying Java classes and, 141deploying plug-ins and, 268, 281, 291deploying to JBOSS servers and, 34developing ODA extensions and, 368generating, 268installing JDBC drivers and, 35running report projects and, 353selecting external, 355developing ODA extensions and, 370

JAR Selection dialog, 355Java. See Java programming languageJava 2 Enterprise Edition. See J2EE

environmentsJava 2 Runtime Standard Edition. See J2SE

environmentsJava APIs, 52Java applets, 466Java applications

See also applicationsadding charting capabilities to, 23, 219adding reporting capabilities to, 26creating, 56, 147generating designs and, 52

Java archives. See .jar filesJava Attribute Editor, 286Java Build Path page, 112Java Class dialog, 114Java classes

See also classesaccessing, 108, 109, 116associating with report elements, 116creating, 63, 111, 112, 355default location for, 110deploying, 141developing ODA extensions and, 368developing with, 145

importing, 109naming, 115referencing, 109, 139registering, 225scripting for, 108, 109, 139, 140setting properties for, 287

Java code, 73, 108, 110, 111, 494Java command, 354Java compiler, 116Java Database Connectivity. See JDBCJava development environment, 74Java Development Kit. See JDK softwareJava editor, 115Java event handler classes, 111, 116, 120Java event handlers, 74, 87, 111, 120, 224Java interfaces, 123, 494Java Naming and Directory Interface, 495Java naming conventions, 117Java objects, 95, 109, 131, 139Java packages, 108, 109, 110, 139Java perspective, 354Java programming language, 494Java programs, 74, 495Java Project option, 354Java projects, 113, 116Java report generator, 56Java run-time API, 273Java Runtime Environment, 33Java Settings page, 354Java source files, 114Java Virtual Machines. See JVMsjava.lang package, 109JavaBeans, 496JavaScript

accessing data sources and, 131accessing Java classes for, 108, 109accessing ROM elements and, 95defined, 496entering variables in, 92, 95indexing column position and, 99line breaks in, 225previewing, 98setting properties with, 96tracking method execution and, 102tutorial for, 104wrapping Java code in, 108, 110writing event handlers and, 73, 87, 91, 225

JavaScript array properties, 99


548 I n d e x

JavaScript library, 184JavaScript objects, 109JavaScript palette, 107JavaScriptViewer application, 248JavaServer Pages. See JSPsJavaViewer application, 248JBOSS servers, 33, 34JDBC (defined), 495JDBC connections, 101JDBC data sources, 365JDBC drivers, 35, 420, 436JDK software, 5, 6, 9, 254, 495JFrame objects, 109JNDI (defined), 495join conditions, 497joins, 68, 496joint data sets, 68, 493, 497JointDataSet element, 68JRE software, 33js.jar, 184JSPs, 496JUnit libraries, 29JUnit Regression Testing Framework, 10JVMs, 19, 496

Kkeywords, 497

Llabel elements, 497label items, 213labels, 96, 319, 497LabelStyleProcessor class, 250language packs, 19–21language-specific environments. See localesLaunch an Eclipse application option, 291layout editor, 300, 497layout package, 165, 176Layout page. See layout editorlayouts, 497

See also page layouts; master pageslazy load, 497legend area (charts), 86, 223, 227Legend block (charts), 86legend line properties (charts), 227Legend objects, 227Level class, 190

level-break listings. See grouped reportslib directory, 35, 112libraries

See also component librariesaccessing, 55, 181accessing properties in, 156building plug-in extensions and, 279, 288changing, 55creating reporting applications and, 181,

204defined, 498deploying applications and, 183deploying reports and, 112naming, 289required, 184reusing designs and, 51running Hibernate drivers and, 441scripting and, 108selecting, 289

Libraries page (Java Settings), 354library files, 55, 204, 498LibraryHandle class, 156, 205licenses, 32line break characters, 225line breaks (JavaScript), 225LineAttribute objects, 227LineSeries objects, 228, 229links. See hyperlinksLinux platforms, 23list elements, 66, 213, 498list execution sequence (events), 79, 80list items, 67, 77list processing phase (events), 79list setup phase (events), 79listeners. See event listenersListing element, 66listing reports, 80, 498ListingGroup elements, 80ListingGroup items, 80lists, 67, 78–81

See also list elements; list itemsload_classicmodels.sql, 26loading

class files, 286document files, 149metadata, 154plug-ins, 280


I n d e x 549

loading (continued)report designs, 149, 206

examples for, 191source code, 271, 497

local variables, 92, 499See also global variables; variables

__locale parameter, 41, 43Locale objects, 85locale-independent formats, 193locales

building charts for, 85changing, 21converting strings and, 193defined, 499getting, 94, 127installing language packs for, 19–21managing programmatically, 149specifying, 21, 43

localization, 19, 23, 499See also locales

locating extension points, 283locating program updates, 31log files, 36, 187, 190log messages, 37, 85, 148, 190log package, 165, 169Logger class, 190Logger objects, 85logging classes, 190logging code, 81logging configurations, 190logging levels, 37, 190Logging property type, 187logging threshold, 190

MManage Configuration command, 293manifest files, 271, 275, 277, 279, 499manifest headers, 277manifest.mf, 277, 279mapping to report viewer, 36markers (charts), 86markup languages, 481, 487, 491

See also elements; tagsmaster pages, 66, 76, 499MasterPage element, 66Math class, 109matrix reports. See cross-tab reportsMember element, 65

member variables, 500See also field variables; variables

members, 65, 500messages, 94, 127, 513

See also error messages; log messagesMessages class

CSV ODA driver extension, 382, 388CSV ODA UI extension, 404Hibernate ODA extension, 427, 449

messages.properties file, 404, 449metadata

accessing, 150accessing Hibernate data sources

and, 433accessing ODA data sources and, 380,

382, 383defined, 501defining ROM elements and, 63–66getting column information from, 99, 128getting data set, 128loading, 154

metadata interface, 128MeterChartExample application, 250method definitions, 64, 65Method element, 64, 65Method metadata definition (ROM), 65Method property, 67methods

See also functionsaccessing column information and, 99,

128accessing data sets and, 120, 122, 128, 132accessing data sources and, 82, 120, 121accessing report components and, 156accessing report designs and, 155accessing report items and, 207building charts and, 83, 85, 86, 87building data rows and, 78, 129building tables or lists and, 79, 80creating event handlers and, 94, 111, 118,

126creating report designs and, 123defined, 501defining ROM elements and, 61, 65executing reports and, 76, 78, 95generating report elements and, 124, 125generating report items and, 81, 119importing Java packages and, 109


550 I n d e x

methods (continued)overriding, 118providing external values for, 187rendering CSV output and, 342, 344running rotated text plug-in and, 273scripting with, 108selecting, 96, 97tracking execution of, 102–104viewing arguments for, 119

methods array, 60Microsoft Access databases, 26, 89Microsoft Windows. See Windows systemsmilestone builds, 11milestone release, 31MIME types, 335mimeType property, 335modal windows, 501mode, 501model attribute, 269model element, 308model extension element, 308model package (charts), 165, 169modelapi.jar, 185modeless windows, 501ModifyListener method, 450ModuleHandle class, 155Mozilla Rhino, 91, 108, 110multicolumn page layouts, 67Multipurpose Internet Mail Extensions. See

MIME typesmultithreaded applications, 501myChart.chart file, 221mysql command line interface, 26MySQL databases, 8, 26MySQL installation scripts, 441

Nname attribute, 372name collisions, 109name element, 309Name property, 308, 335, 371, 393name property, 309name variable, 202names

See also aliases; display namesaccessing Java packages and, 109changing context root, 36defining properties and, 61

getting column, 99, 128retrieving values and, 99, 128

name-value pairs, 60naming

data set columns, 122event handler classes, 117, 118Java classes, 115ODA data source extensions, 371ODA data source UI extensions, 393output files, 200plug-in libraries, 289report design files, 326report item extensions, 269, 308report items, 207report rendering extensions, 335scripted data sets, 134scripted data sources, 134

naming conventions, 117nativeDataType property, 373nativeDataTypeCode property, 372Navigator, 104, 501Navigator command, 104New Class command, 355New Data Set wizard, 134New Data Source wizard, 133New Extension wizard, 281New Java Class wizard, 355New Java Project wizard, 354new line characters, 347new line tag, 348New Plug-in Project wizard, 275, 276, 277New Project wizard, 275New Report command, 326New Report wizard, 326New Source Folder dialog, 289New Update Site wizard, 295newDataSourceWizard attribute, 394newElement method, 213newExtendedItem method, 231newQuery method, 429newReportItem method, 318newSession method, 154, 206newsgroups, xvii, 5next method, 386, 435nightly builds, 11–nl command line argument, 21node, 502NonGroupOnXSeries.rptdesign, 246


I n d e x 551

NonGroupOnYAxis.rptdesign, 246non-scripted data sets, 131non-scripted data sources, 131non-visual elements, 59, 205null values, 43, 502Number class, 109numeric data types, 502numeric expressions, 502N-up reports. See multicolumn page layouts

OObject class, 109object libraries. See component librariesobject references, 140object-oriented programming, 502objects

accessing, 131, 139defined, 502getting, 222instantiating, 139, 271registering service, 273saving, 127

octal numbers, 503ODA (defined), 503ODA API, 365, 366, 379ODA API Reference, 214, 366oda csv package, 381oda csv plug-in, 367ODA data set extension elements, 372, 376ODA data set extensions. See ODA

extensionsODA data sets, 82, 215, 372, 380, 382, 390ODA data source extension elements, 371,

372, 374ODA data source extension points, 371, 373,

395, 441ODA data source extensions. See ODA

extensionsODA data sources

accessing, 366, 371adding, 390committing changes to, 380connecting to, 380, 381defining event handlers for, 82designing for, 404getting columns in, 380moving through rows in, 380querying, 380, 381, 384

retrieving data from, 365, 379setting connection properties for, 101

oda dataSource extension point, 367oda dataSource plug-in, 366, 371ODA driver constants, 389ODA driver extension examples, 297, 367,

381ODA driver extensions

compiling and debugging, 368creating, 366, 379implementing, 371setting dependencies for, 370specifying run-time settings for, 370

ODA driver interfaces, 379ODA driver plug-in project, 365, 368, 390ODA driver plug-ins, 368, 414ODA drivers

adding to BIRT framework, 366adding user interface for, 366, 371connecting to, 380, 381creating, 53, 365, 367, 419customizing, 57, 366defined, 503defining error messages for, 382setting extension elements for, 371specifying run-time interface for, 379

ODA extension example (Hibernate), 420ODA extension identifiers, 371ODA extension points, 366, 371ODA extensions

See also ODA driver extensionsaccessing CSV data sources and, 367adding user interfaces for, 367building, 368data type mappings and, 372defining run-time settings for, 371developing, 365, 366, 419display names for, 372downloading code for, 367overview, 366run-time properties and, 101setting display names for, 371setting properties for, 371specifying, 376

ODA framework, 53ODA interfaces, 371, 379, 381ODA packages, 366oda plug-in, 368, 371, 379


552 I n d e x

ODA plug-ins, 371, 379, 381oda ui dataSource plug-in, 366ODA UI extension, 368ODA UI extension points, 393ODA UI extensions, 390–403ODA UI plug-ins, 367, 368, 393, 403ODA user interface, 366, 367ODA_DEFAULT_CHARSET variable, 405OdaDataSetHandle class, 215OdaDataSourceHandle class, 214odaDataSourceUI element, 396, 398, 400odaDriverClass property, 101ODAHOME variable, 405odaPassword property, 101odaScalarDataType property, 373odaURL property, 101odaUser property, 101odaVersion attribute, 371ODBC (defined), 504ODBC drivers, 26onCreate events, 61, 75, 81onCreate method

listing groups and, 80report items and, 81, 119

onFetch events, 82, 121onFetch method, 99, 121onFinish method, 80online documentation. See documentationonline help, 503online reports. See web pagesonPageBreak events, 61onPageBreak method, 119onPrepare events, 61, 81onPrepare method, 76, 81, 119onRender events, 61, 75, 81onRender method, 81, 119onRow method, 80onRowSets method, 319open data access, 503

See also ODAopen database connectivity. See ODBCopen events, 82Open extension point description

option, 283, 284open method

Hibernate drivers and, 428iterator objects and, 140scripted data sets and, 122, 135, 139

scripted data sources and, 121, 132Open Services Gateway Initiative. See OSGiopen source projects. See projectsopen source software development. See

Eclipseopening

class files, 286configuration files, 38connections, 380, 381cursors, 380data sets, 82, 121, 122, 139data sources, 82, 120, 121, 135document files, 149, 182, 191Export Wizard, 292HTML reports, 203Navigator, 104output files, 343PDF documents, 203Plug-in Development perspective, 275report designs, 62, 182, 190, 206

examples for, 104, 191openReportDesign method, 149, 182, 190openReportDocument method, 149, 182, 191operators, 504optional parameters (URLs), 41options (rendering), 200orthogonal axis values, 228, 472OSGi Alliance web site, 273OSGi API, 273OSGi class loader, 372OSGi platform, 273, 277OSGi resource bundles, 272, 277out_msg parameter, 142outer joins, 504

See also joinsoutline attribute, 308Outline view (Eclipse), 278, 504outlining chart legends, 227output

accessing formatted, 203creating CSV files and, 329, 339, 341, 346,

357creating HTML reports and, 200generating, 43, 181, 203, 329generating with conditions, 95rendering, 52, 56, 138, 300setting options for, 200validating, 62, 65


I n d e x 553

output (continued)writing to disk, 147

output columns, 135Output Columns view, 136output files

accessing, 203adding method calls to, 102closing, 344displaying, 357naming, 200opening, 343

output formatscustomizing, 199, 300, 330getting, 94, 127rendering context and, 201rendering designs as, 363rendering options for, 181, 200rendering output and, 329setting, 43, 56, 182, 335specifying MIME types for, 335

output parameters, 141output streams, 102, 181, 200, 204, 342outputParams array, 141, 142overriding methods, 118overriding report parameters, 28Overview page (PDE Editor), 278, 292

P–p command line argument, 28package (defined), 505Package Explorer, 262, 278packages, 3, 7, 23, 146Packages object, 108Packages prefix, 109page breaks, 75page footers, 488page headers, 491page layouts

See also designs; master pagesbuilding multicolumn, 67creating lists and, 67creating tables and, 67defined, 497

pageBreak events, 75palette element, 308Palette view, 54, 505parameter definitions, 150, 194parameter groups, 193, 194

PARAMETER_GROUP value, 194parameters

See also data set parameters; report parameters

accessing information about, 149assigning null values to, 43creating scripted data sets and, 141defined, 505defining session-specific, 154developing ODA extensions and, 381getting values for, 101, 127, 183, 194overview, 44running reports and, 41, 95setting values for, 95, 127, 195, 200

code example for, 195, 197validating, 150, 151

param-value element, 38parent class. See superclassesparse method, 195passwords, 101, 506paths

charting applications and, 221context mapping, 36event handlers, 38fonts and, 201image files and, 201report design files, 36, 42report designer, 37report engine and, 186scripted data sources and, 140

patterns, 506See also object-oriented programming

PDE (defined), 483PDE Manifest Editor, 278, 353PDE Workbench, 277–296

See also Eclipse Plug-in Development Environment

PDF documentsbuilding charts for, 221, 247displaying, 41generating, 43, 149, 150, 199, 201installing fonts for, 40missing content in, 40opening, 203setting up rendering context for, 201writing to disk, 147

PDF emitter, 52PDF formats, 329


554 I n d e x

PDF reports. See PDF documentsPDFChartGenerator charting example, 247PDFChartGenerator class, 247PDFRenderContext class, 201PDFRenderContext objects, 200PDFRenderOption class, 150peek method, 344persistent global variables, 95persistent variables, 94, 126, 127perspectives, 482platform, 506Platform context property type, 187Platform Plug-in Developer Guide, 296PlatformServletContext objects, 188plot area (charts), 223, 227Plot block (charts), 86Plot objects, 227plot properties (charts), 223, 227Plugin class, 272Plug-in Development Environment, 267,

275, 483See also PDE Workbench

Plug-in Development perspective, 275plug-in directories, 267plug-in drivers, 366plugin element, 271plug-in extensions

building, 287–290creating, 279–287customizing BIRT and, 267deploying, 268, 291–296examples for, 297selecting export options for, 292setting class attributes for, 286specifying, 281, 335testing, 291viewing descriptions of, 283, 284

plug-in fragments, 506plug-in manifest files, 271Plugin package, 318plug-in registry, 271, 330plug-in run-time class, 271, 272Plug-in Selection dialog, 279, 306plugin.xml, 268, 271Plug-in.xml page (PDE Manifest Editor), 279plug-ins

accessing CSV data sources and, 367, 368accessing source code for, 4

building CSV report rendering extension and, 330, 334, 348

building rotated label report item extension and, 302, 305

caching conflicts and, 18, 24compiling code for, 290creating Hibernate driver, 420, 439, 448creating Hibernate ODA UI, 458defined, 506defining extension points in, 299deploying applications and, 183developing, 268, 275developing ODA extensions for, 366, 372,

379, 381editing project settings for, 278, 279extending application development

and, 267extending functionality of, 279installing, 184, 271instantiating objects in, 271integrating with Eclipse, 47loading, 280running report engine and, 183, 330selecting run-time libraries for, 289setting dependencies for, 279, 305setting properties for, 277setting up projects for, 275–277testing, 268, 277, 353updating, 293verifying run-time archive for, 281viewing information about, 278viewing project settings for, 278

plugins folder, 368plug-ins subdirectory, 183Point property, 308, 335, 371, 393polymorphism, 506pop method, 344portal, 507portlets, 507predefined layouts. See master pagespredefined values, 476preference example (charts), 250preferences (Eclipse workspace), 254PreferenceServlet charting example, 250preparation phase (events), 76prepare method, 383, 431prepareMetaData method, 383


I n d e x 555

presentation enginecomponents of, 50customizing output formats for, 300, 330generating reports and, 51overview, 52

presentation extensions, 300presentation plug-in, 307, 309presentations, 319presentation-time events, 74, 75previewer, 51, 74, 75, 507previewing

reports, 51, 147scripts, 98source code, 105

primary base axis (charts), 228print method, 341printing, 66, 341println method, 103PrintWriter objects, 102, 103private styles, 212PrivateStyleHandle class, 212procedures, 507

See also functions; methodsprocess, 507Product Configuration dialog, 294program archives, 5, 14, 15, 17program requirements

BIRT Chart Engine, 7BIRT Demo Database, 8BIRT RCP Report Designer, 5BIRT Report Designer, 6–7BIRT Report Engine, 9BIRT Samples, 9BIRT Test Suite, 9–10

program updates, 31, 291, 293programming environments, 74programming interfaces, 123, 494

See also application programming interfaces; interfaces

programming languages, 494See also scripting languages

programming tools, 267projects

adding event handler classes to, 112, 116building BIRT, 253–256building plug-in extension, 288, 290building update site, 294changing settings for, 278, 279

checking out, 256creating

CSV ODA driver, 368CSV report rendering, 331, 353Eclipse, xvii, 256–261Hibernate ODA driver, 421, 422Hibernate UI plug-in, 442plug-in, 275–277report item extension, 303rotated label report item, 302–305

developing ODA extensions and, 367running, 353selecting, 113viewing settings for, 278

propertiesaccessing, 155, 208charting applications and, 222–224charts and, 86, 87, 164, 227–228, 231customizing, 60data sets and, 129, 215data source connections and, 101defined, 508event handlers and, 95, 96Hibernate data sources and, 451, 452Java classes and, 287Java packages and, 108libraries and, 156ODA extensions and, 371plug-ins and, 277report designs and, 66, 155, 191report elements and, 67, 125, 206report emitters and, 335, 336report engine and, 186, 187report item extensions and, 307report items and, 67, 96, 208, 209, 211, 212ROM elements and, 60, 61, 62, 66selecting, 96user sessions and, 154visual components and, 67

properties files, 19, 127properties list, 507Properties page. See Properties viewProperties view, 507property annotations, 285property collections, 61property definitions, 60Property Edit Page, 308Property Editor, 508


556 I n d e x

property editors, 268, 316, 390property element, 62property handles, 212property pages, 404, 448Property property, 67property property type, 60property sheets, 63

See also Properties viewproperty types, 60, 67, 318property-list property type, 60propertyPage element, 308propertyPage extension point, 441propertyPages extension point, 404PropertyProcessor class, 317PropertyType class, 318protocol, 508public classes, 115publish, 508push method, 344

Qqueries

See also HQL statements; SQL statementsaccessing Hibernate data sources

and, 431, 433, 435, 449, 454changing, 101defined, 509defining chart series and, 229, 230developing ODA extensions for, 365, 380,

381executing, 384extending functionality of, 300retrieving data with, 196

query preparation extensions, 300query strings (request objects), 95queryText property, 101quotation mark characters. See double

quotation mark character

Rrange, 509RCP (defined), 483

See also rich client platformsreadLine method, 385record counters, 104, 106records. See rowsreferencing

Java classes, 109, 139report designs, 37, 41report documents, 41

registering service objects, 273registry (plug-ins), 271, 330regression testing, 470Regression Testing Framework (JUnit), 10regular expressions, 509relational databases, 365

See also databasesrelative paths, 36, 42release builds, 10, 14, 16, 17removing. See deletingrenaming report design files, 232render option classes, 150, 151, 200render option objects, 150, 151, 200render package, 165, 177render processes, 93, 94, 95rendering classes, 341rendering context, 201rendering environments, 147, 181rendering extension API, 329rendering extensions

creating projects for, 331, 353defined, 509developing, 329, 330, 337naming, 335overview, 329running, 356sample for, 329, 337setting dependencies for, 334viewing output for, 357

rendering options, 200, 349rendering plug-ins, 337, 353rendering sequence (events), 75rendering services, 147RenderOptionBase class, 348, 349__report parameter, 41, 42report body processing phase (events), 76,

77report components, 155, 156

See also componentsreport context objects, 94, 126, 200report descriptions, 55, 59report design elements, 66, 82, 122report design engine, 52, 54, 204report design engine API, 145, 153, 157, 181

See also report model API


I n d e x 557

report design engine class, 154report design environments. See BIRT;

Eclipsereport design files

accessing report items in, 222associating with reports, 42defined, 509generating, 52, 56, 154generating reports from, 147, 182, 190,

200, 206installing report viewer and, 35, 36loading, 149naming, 326opening, 62, 182, 190, 206

examples for, 104, 191overview, 55referencing in URLs, 37, 41, 42renaming, 232running, 150, 200specifying paths for, 37validating, 52

report design perspective, 14report design properties, 66report design tools, 51, 153, 154report designer packages, 4, 13, 31report designer ui extensions package, 316report designers, 13, 51, 56, 147

See also BIRT Report Designer; BIRT RCP Report Designer

report designsSee also page layoutsaccessing, 154, 181, 204, 206accessing Hibernate data sources for, 441accessing items in, 204accessing properties for, 155accessing ROM schema for, 62adding charts to, 232, 246, 250adding data sources to, 390adding report items to, 67, 207, 213, 301changing, 185, 204, 206, 211connecting to external sources and, 202creating, 55, 153, 205, 217defined, 480defining event handlers for, 74, 75, 82, 91,

122deploying, 204developing, 204extending functionality of, 57

generating CSV files and, 359getting parameters in, 194initializing, 76, 83, 102, 123retrieving data for, 366reusing, 51saving, 204, 217, 232setting location of, 36, 37, 42setting properties for, 191testing for parameters in, 194validating, 52, 62, 65viewing report items in, 77

report document filesaccessing data in, 150creating, 183, 199defined, 510generating reports from, 181, 182, 190,

192opening, 149, 182, 191overview, 55referencing in URLs, 41setting location of, 42writing to disk, 150

report documents. See documents; reportsreport editor, 510Report element, 62report element interfaces, 124–126report elements

See also specific typeaccessing, 181, 204adding, 66applying styles to, 62associating event handlers with, 91, 111,

116–117changing, 205creating, 124, 125, 213defined, 510developing ODA extensions for, 371, 372getting formats for, 344loading property definitions of, 154operations unique to, 156providing services for, 156rendering, 337scripting for, 95, 118setting properties for, 125, 206validating, 52

report emitters. See emittersreport engine

accessing external data sources and, 379


558 I n d e x

report engine (continued)configuring, 148, 187, 188configuring HTML emitter for, 188connecting to data sources and, 182creating, 148, 186customizing, 147defined, 469defining default location for, 186defining platform context for, 187, 188deploying report viewer and, 33extending report items and, 54generating output and, 363generating report items and, 300getting output formats for, 330implementing CSV report rendering

extension and, 348installing, 17, 26, 27logging messages for, 37overview, 52platform context for, 188running, 330services provided by, 147setting as stand-alone application, 189setting global options for, 148setting properties for, 186, 187shutting down, 183software requirements for, 9testing installation for, 27

report engine API, 147, 148, 152, 181report engine API package, 145, 151, 348Report Engine API Reference, 181report engine classes, 148, 151report engine content package, 329, 339report engine emitters package, 329, 335report engine emitters plug-in, 300report engine extension package, 301, 317report engine hierarchy, 50report engine home directory, 183report engine package, 14, 183report engine plug-in, 331report examples (charts), 250report executable files, 510

See also report object executable filesreport execution process (events), 76–81report file types, 54, 488report files, 54–55

See also specific typereport generation services, 147

report generators, 56, 145report item API, 301report item elements, 67

See also report itemsreport item emitter extension point, 300report item events, 119report item extension points, 299, 307, 310report item extension sample plug-in, 297,

301, 470report item extensions

creating, 299, 312defined, 511defining dependencies for, 305deploying, 302, 324designing reports and, 301developing, 54, 301–315displaying reports and, 52downloading sample code for, 297implementing classes and interfaces

for, 316implementing presentation plug-in

for, 307, 309naming, 269, 308overview, 299–301setting up projects for, 303testing, 324XML schema definitions for, 268, 269, 284

report item interfaces, 316report item model extension points, 299report item palette, 300report item query extension point, 300report item run-time extension point, 300report item UI elements, 308report item UI extension points, 300report items

accessing, 181, 204, 207, 209, 210adding, 67, 213, 299, 301, 318applying styles to, 212binding data sets to, 216changing, 211changing properties for, 211, 212creating, 54, 213, 300customizing, 54, 57, 301defined, 67, 510defining event handlers for, 61, 74, 76, 81,

119determining level of, 77examining, 208


I n d e x 559

report items (continued)extending functionality of, 57, 62, 299generating output for, 300getting handles to, 155, 156getting properties for, 208localizing, 43naming, 207overview, 53–54, 207rendering, 81retrieving from design files, 222setting properties for, 67, 96, 210, 211writing to CSV files, 341

report layouts. See report designs; page layouts

report library files, 55, 204, 498report model API, 153, 154report model api extension package, 318report model api package, 145, 153, 157, 317report object model. See ROMreport objects. See reportsreport parameter collections, 196report parameters

See also cascading parametersaccessing, 192, 193converting, 193defined, 512getting attributes of, 195getting default values for, 194getting value of, 101, 195overriding, 28overview, 44running reports and, 41setting values for, 195, 197, 200, 202testing for, 194validating, 151

report previewer, 51, 74, 75report projects. See projectsReport Rendering Extension API. See

rendering extension APIreport rendering sample plug-in, 297report sections, 515report specifications. See report designsreport template files, 55, 512report templates, 56, 520Report templates section (New Report), 326report viewer

accessing reports for, 36, 40building, 262

changing configurations for, 36components of, 50default location for, 36deploying, 33, 51developing for, 147generating charts for, 53generating reports from, 182installing, 34–35, 36installing auxiliary files for, 35integrating report item extensions

with, 324mapping to, 36overview, 51placing Java classes for, 110referencing report designs for, 37, 41referencing report documents for, 41, 42running on Apache servers, 34, 36, 39setting context parameters for, 38starting, 34, 39testing installation of, 35

report viewer servlet, 51, 512reportContext objects, 94, 126ReportDesign element, 66, 82, 122ReportDesign events, 74, 75, 82, 123ReportDesignHandle class, 155, 156, 205,

207ReportDesignHandle objects, 154, 155, 206,

222ReportElement element, 66ReportElementHandle class, 159ReportEngine class, 148, 186, 193ReportEngine objects, 148, 182, 186

See also report engineReportEventAdapter class, 122reporting applications. See applicationsreporting platform. See BIRTReportItem element, 66, 67ReportItem events, 74reportitem plug-in (charts), 301ReportItemFactory class, 318reportitemGeneration plug-in, 300reportitemGeneration.exsd, 300ReportItemHandle class, 160ReportItemLabelProvider class, 319reportItemLabelUI element, 285, 308reportItemModel plug-in, 299, 301, 307, 308reportItemModel.exsd, 299reportitemPresentation package, 309


560 I n d e x

reportitemPresentation plug-in, 300, 302, 307

reportitemPresentation.exsd, 300ReportItemPresentationBase class, 319reportitemQuery plug-in, 300reportitemQuery.exsd, 300reportitemUI plug-in, 283, 300, 301, 307, 308reportitemUI.exsd, 268, 300ReportParameterConverter class, 193reports

accessing, 36, 40, 203associating styles with, 65, 66building, 76, 78controlling generation of, 73creating, 154, 182customizing, 185defined, 509deploying, 33, 110, 112designing. See designing reports; designsdeveloping, 13, 73displaying, 40, 51, 52generating, 182, 185, 200, 203personalizing, 56previewing, 51, 147rendering environments for, 181rendering output for, 52, 56, 147rendering specific pages for, 149running, 74, 76, 93selecting language for, 20setting default styles for, 62testing report viewer for, 35writing to disk, 147

Repository Location command, 257request objects, 95requests, 94, 126, 513Required Plug-ins section, 279, 280reserved words. See keywordsresource bundles, 272, 388resource files, 94, 187, 206, 513Resource files property type, 187resource keys, 513resources, 293response, 513response messages, 513result sets

See also data setsaccessing, 380defined, 513

developing ODA extensions for, 365, 379, 380, 382

getting Hibernate data source, 430, 435getting number of columns in, 99returning, 68

ResultSet class, 382, 385, 427, 435ResultSetMetaData class, 382, 387, 427rich client platforms, 51, 73, 483rollback method, 430rollback operations, 380, 430ROM, 54, 59, 511ROM API Reference, 181ROM definition file, 511ROM Definitions Reference, 59ROM element design interfaces, 118ROM element handles, 204ROM element instance interfaces, 118ROM elements

accessing, 204applying styles to, 62as visual components, 67creating, 64customizing properties for, 60customizing XML code for, 60defined, 511defining event handlers for, 61, 112defining executable code for, 67overview, 59, 66, 68scripting for, 95, 118setting properties for, 60, 63viewing metadata definitions for, 63–66

ROM report item elements, 67ROM report item extensions, 299, 307ROM schemas, 62, 512ROM slots, 61ROM specification, 54, 59ROM types, 60rom.def, 63, 511rotated label extension points, 287rotated label manifest file, 271rotated label plug-in, 273, 301, 302, 316rotated label plug-in project, 278rotated label report item extension

creating projects for, 302–305defining dependencies for, 305deploying, 302developing, 301, 312, 316downloading BIRT plug-ins for, 302, 305


I n d e x 561

rotated label report item extension (continued)

downloading source code for, 302implementing, 301overview, 301specifying extension points for, 307–312viewing property annotations in, 285

rotated text items, 318, 319, 321rotated text report item extension. See rotated

label report item extensionrotatedlabel plug-in, 273, 301, 302, 316RotatedLabelGeneralTabUIImpl class, 320,

321RotatedLabelItemFactoryImpl class, 318RotatedLabelPlugin class, 273RotatedLabelPresentationImpl class, 319RotatedLabelPropertyEditUIImpl class, 320RotatedLabelReportItemImpl class, 320RotatedLabelUI class, 319rotateImage method, 322, 323rotationAngle property, 309, 320Row element, 69row execution sequence (events), 78Row instance interface, 126row objects

See also rowsfetching data sets and, 129getting column information from, 99getting query statements from, 100populating, 121, 122

rowsaccessing columns in, 99building, 78, 80, 129, 138defined, 513getting information for, 129incrementing cursors for, 386iterating through, 140, 380returning from Java objects, 140returning result sets and, 69

.rptdesign files. See report design files

.rptdocument files. See report document files

.rptlibrary files. See report library files

.rpttemplate files. See report template filesrun, 514Run dialog, 356run method, 203Run mode, 353run report project, 353, 354

run servlet, 41runnable variable, 202running reports, 74, 76, 93RunReport class, 355run-time archives (plug-ins), 268, 281run-time connections, 101run-time drivers, 379run-time environments, 271Runtime Information section, 288run-time instance (PDE Workbench), 277run-time libraries, 289Runtime page (PDE Manifest Editor), 279,

281run-time workbench, 325

Ssac.jar, 185SalesReport application, 250sample charting applications, 24sample data, 87, 226, 231Sample Data containment reference

(charts), 87sample database, 8

See also Classic Models sample databasesample extensions, 297Samples package, 9, 14, 28, 470save method, 217saveAs method, 217savePage method, 413, 456saving

report components, 51report designs, 204, 217, 232

scalar data types, 373scalar parameters, 193, 194schema directory, 268schema element, 268schema-aware tools, 62schemas

BIRT extension points and, 335custom formats and, 300defined, 514Eclipse extensions and, 283ODA extensions and, 366presentation extensions and, 300query extensions and, 300report item extensions and, 307, 312report item generation and, 300report item user interfaces and, 300


562 I n d e x

schemas (continued)report object model and, 62report rendering extensions and, 330ROM report items and, 299validating designs and, 62

scope, 92, 93, 514script API library, 185Script attribute (charts), 86, 87script editor, 91, 514script package, 165, 178Script tab, 87, 91script window, 95, 96scriptable external objects, 85scriptable objects, 148scriptapi.jar, 112, 185ScriptCharts class, 248ScriptDataSetHandle class, 215ScriptDataSourceHandle class, 214scripted data set elements, 69, 82scripted data sets

See also data setsaccessing Java classes for, 139accessing ODA data sources for, 215accessing parameters for, 141–142closing, 82, 122, 140creating, 131, 134defining event handlers for, 82, 122defining output columns for, 135initializing, 135, 139opening, 82, 122, 139specifying type, 122

scripted data source elements, 68, 82, 121, 122

Scripted Data Source option, 133scripted data sources

See also data sourcesaccessing Java objects and, 139closing, 82, 121, 132, 135creating, 131, 132, 133defined, 131defining event handlers for, 82, 121initializing, 132opening, 82, 121, 135tutorial for, 133–138

ScriptedDataSet element, 69, 82ScriptedDataSet interface, 122ScriptedDataSource element, 68, 82, 121, 122ScriptedDataSource events, 82

ScriptedDataSourceAdapter class, 121, 122ScriptedDataSrc.rptdesign, 133ScriptHandler class, 165Scripting configuration property type, 187scripting context, 149scripting engine, 523scripting languages, 73, 74, 91, 515scripting specifications, 91ScriptingJava.html, 110scripts

accessing Java classes and, 108, 109, 116accessing ROM elements and, 95additional references for, 110building charts and, 83, 85, 88, 224, 225concatenating code for, 225creating, 108, 110

tutorial for, 104–108executing events and, 74–81, 93generating reports and, 73importing Java packages and, 109, 139overview, 73, 91previewing, 98providing external values for, 187referencing Java classes and, 109, 139returning parameter values and, 101tracking method execution and, 102–104variables in, 92, 95writing event handlers and, 73, 74, 91, 118

ScriptViewer charting example, 248scrollable methods list, 97scrollable properties list, 97SDK package, 515SDK software, 6, 14SDO Runtime component, 7search paths, 40searching for extension point

information, 283searching for program updates, 31sections, 515security, 56select, 515SELECT statements. See SQL statementsselection formulas. See parametersSelectionAdapter method, 450semantic validators, 66SemanticValidator element, 66sequential files. See flat filesserializable objects, 127


I n d e x 563

serialize method, 217series

See also chartsadding, 224, 228–230building queries for, 229, 230changing properties for, 224defined, 515getting properties for, 86setting properties for, 87, 230setting type, 164

Series Thickness attribute (charts), 86, 87SeriesDefinition objects, 230SeriesDefinitionImpl interface, 230SeriesImpl interface, 164, 228SeriesPalette objects, 230server.xml, 36servers, deploying to, 33, 34, 110service applications, 273Service Data Objects component, 7service objects, 273service registry, 272services, 156, 267, 272ServletContext class, 188servlets, 516session handles, 206session parameters, 154SessionFactory objects, 436SessionFactory operations, 420, 428SessionHandle class, 154, 217SessionHandle objects, 154, 206setAbsolute method, 212setActionHandler method, 189setAppContext method, 200setBaseImageURL method, 201setBaseURL method, 201setBlock method, 87setChartInstance method, 85setConfigurationVariable method, 187setContext method, 201setDataSet method, 214, 216setDataSource method, 215setDescription method, 87setDimension method, 87setEmbeddedFont method, 202setEmitterConfiguration method, 187, 189setEngineContext method, 187, 188setEngineHome method, 186setExtensionProperty method, 129

setExternalContext method, 85setFontDirectory method, 201setGlobalVariable method, 94, 127setGridColumnCount method, 87setImageDirectory method, 201setImageHandler method, 188setInitialProperties method, 451, 452setInteractivity method, 87setLogConfig method, 187, 190setLogger method, 85setName method, 207setParameterValue method, 95, 127, 195, 200setParameterValues method, 200setPersistentGlobalVariable method, 95, 127setQueryText method, 129setResourcePath method, 187setResultSetMetaData method, 412, 457setSampleData method, 87setScript method, 87, 225setSeriesThickness method, 87setStatusHandler method, 187setSubType method, 87setSupportedImageFormats method, 201setTempDir method, 187setThreadContextClassLoader attribute, 371settings. See propertiessetType method, 87setULocale method, 85setUnits method, 87setup phase (events), 79setupConfigLocation method, 450setupFileLocation method, 407setURI method, 210setVersion method, 87shared styles, 212SharedStyleHandle class, 212simple properties, 209singleton pattern, 506site.xml, 294slot handles, 207, 208, 216Slot property, 68slots, 61, 207, 516Software Development Kit, 6, 14, 515

See also JDK software; SDK packagesoftware interfaces, 494software requirements

BIRT Chart Engine, 7BIRT Demo Database, 8


564 I n d e x

software requirements (continued)BIRT RCP Report Designer, 5BIRT Report Designer, 6–7BIRT Report Engine, 9BIRT Samples, 9BIRT Test Suite, 9–10

Software Updates command, 293sort, 516sort fields. See sort keyssort keys, 517sort-and-group-by fields. See group keyssorting data, 53source archives, 288Source Build section, 288source code

accessing data sources and, 131accessing Java, 4, 267accessing sample, 297adding event handlers and, 74, 81, 91changing run-time connections and, 101checking for errors in, 105checking out, 256, 259compiling, 254, 290creating Eclipse projects and, 256customizing, 73defining executable, 67deploying applications and, 183developing applications and, 145, 182,

183developing Hibernate drivers and, 420developing ODA extensions and, 367downloading, 302editing, 470executing reports and, 93extracting URL parameters and, 95generating CSV files and, 329, 330, 359initializing report designs and, 83loading, 271, 497specifying repository location for, 257tracking method execution in, 102, 103

source data. See data sourcessource extension point, 288source files, 114SQL (defined), 517SQL data sources, 131SQL databases, 8, 26SQL language, 517SQL statements, 100, 101, 129, 366, 517

See also queriesstable builds, 11stand-alone applications, 56, 163, 185stand-alone environments, 187stand-alone report engine, 147stand-alone web pages, 41Standard Viewer, 517

See also report viewerstart method, 343starting

BIRT RCP Report Designer, 19BIRT Report Designer, 15, 19report viewer, 34, 39

startRow method, 345startTable method, 345startText method, 346state. See instance variablesStatement class, 427, 431statements, 381, 517static constants, 108static variables, 518

See also dynamic variables; variablesStatus handling property type, 187StockReport application, 250streams. See input streams; output streamsString class, 109STRING data type, 100String data type, 518string expressions, 518string properties, 211strings

concatenating, 225converting, 193, 387defining URL parameters and, 43getting, 95writing to CSV files and, 341

stringToInt method, 387Structure element, 65structure property type, 61structured content, 518Structured Query Language. See SQLstructured report items, 208StructureHandle class, 162structures, 65stubs, 119style attributes, 62, 63, 68, 210Style class, 317style definitions, 65


I n d e x 565

Style element, 65style elements, 61style properties, 154style property, 62style sheets, 62, 184, 185, 471StyleChartViewer application, 248StyleHandle class, 212StyleProcessor charting example, 248StyleProcessor class, 248StyleProperty property, 68styles

accessing, 156applying to report items, 212associating with reports, 65, 66charts and, 248, 250creating, 62defined, 518getting, 209, 212setting attributes for, 63, 68, 210

Sub Type attribute (charts), 87subclasses, 519

See also descendant classessubreports, 519subroutines. See proceduressummary data. See aggregate valuesSuperclass Selection dialog, 115superclasses, 115, 519

See also ancestor classessupportedFormats element, 309supportsMultipleResultSets method, 430__svg parameter, 41, 43SvgInteractivityViewer application, 247Swing applications, 239, 247SwingChartViewersSelector application, 249SwingInteractivityViewer application, 247SwingLiveChartViewer application, 249SWT applications, 247, 248SWTchartViewerSelector application, 249SwtInteractivityViewer application, 247syntax (programming languages), 519syntax conventions (documentation), xxv

Ttable cells. See cellstable elements, 66, 213, 519

See also tablestable execution sequence (events), 78, 79, 80table items, 67, 77

table of contents, 191table of contents markers, 149table processing phase (events), 79table setup phase (events), 79tables

See also table elements; table itemsadding columns to, 137building data rows for, 78creating, 67defined, 519defining pageBreak events for, 75generating, 78–81

tabs, 519See also page

tab-separated values. See TSV formatstabular layouts, 67tabular result sets, 68tags, 520

See also elementstemplate files, 55, 512templates, 51, 56, 181, 205, 520Temporary file location property type, 187temporary files, 37, 148, 187test packages, 470Test Suite. See BIRT Test Suitetest.rptdesign, 35testCharts.chart, 249testing

BIRT installations, 15, 18CSV ODA UI plug-in, 414CSV report rendering extension, 350Demo Database installations, 25Hibernate ODA UI plug-in, 460–463plug-in extensions, 291plug-ins, 268, 277, 353report engine installations, 27report item extensions, 324report viewer installations, 35, 39

Testing section (PDE Manifest Editor), 325, 353

text, 67, 75See also text elements; text items

text elements, 301, 521text file data sources. See text filestext files

See also CSV filescreating rendering extensions for, 330exporting data to, 337


566 I n d e x

text files (continued)tracking method execution in, 102, 103

text item design interface, 124text items

adding, 67rendering as images, 319, 321rotating, 301, 321

text objects. See texttext patterns, 509text strings. See stringsTextItem objects, 124themes, 156, 521

See also stylesthis object, 95, 96thread context class loader, 371tick, 521tick interval, 521time data type, 479Title block (charts), 86Tomcat manager accounts, 39Tomcat servers, 33, 34toolbars, 521top-level report items, 67, 76transactions, 380, 430transient files. See temporary filestranslators. See converterstroubleshooting installation problems, 18–19TrueType fonts, 40TSV formats, 337tutorials

creating event handlers, 104–108creating scripted data sources, 133–138

.txt files. See text filestype attribute, 372Type attribute (charts), 86, 87Type elements, 68type package, 165, 176type property, 309types. See data typestypographic conventions

(documentation), xxiv

Uui extensions package, 316ui plug-in, 367, 368UiPlugin class, 404ULocale objects, 85ungrouped lists, 79, 80

ungrouped tables, 79, 80Unicode, 522Unicode encoding, 522Uniform Resource Locators. See URLsUnits attribute (charts), 86, 87universal hyperlinks. See hyperlinksUniversal Resource Identifiers. See URIsUNIX platforms, 19, 23unknown values, 43unpacking BIRT archives, 5, 14unpaginated HTML formats, 199unsupported data sources, 53Update Manager, 31Update Site Editor, 291Update Site Map page, 296Update Site Project page, 295update site projects, 294update sites, 291, 293, 294updates, 31, 291, 293updating

designer packages, 31plug-ins, 293report designers, 32

upgrades, 31uploading update sites, 294URIs, 208, 210, 522URL parameters, 41–44, 250URLClassLoader objects, 372URLs

accessing reports and, 36, 40, 95BIRT Samples and, 28BIRT Test Suite and, 29changing context roots for, 36chart engine and, 24data source connections and, 101defined, 522demo database and, 9Eclipse Modeling Framework and, 7Eclipse SDK software, 6ECMAScript specification and, 91Graphics Editor Framework and, 7image files and, 201installation demo and, 5iText PDF library and, 15, 16, 17JDK software and, 5, 6program archives and, 14, 16, 17report design files and, 37, 41report document files and, 41, 201


I n d e x 567

URLs (continued)report engine and, 27report parameters in, 41, 44report viewer and, 35, 36

user interface extensions, 269user interfaces

accessing ODA data sources and, 53building, 320, 321creating chart reports and, 54creating custom report designer and, 56customizing, 195HQL queries and, 449ODA drivers and, 366, 367replicating parameters and, 194report design tools and, 154report item extensions and, 268, 300, 307,

308user names, 101user sessions, 154, 206user-defined property definitions, 60UserID parameter, 101userProperties array, 60UserProperty objects, 60util package, 165, 179

VvalidateParameters method, 150, 151validateQueryText method, 383validating report designs, 62, 65validating report output, 62, 65validator classes, 65validator definitions (ROM), 65value axes. See axes valuesvalue series. See data seriesvalues

See also datadefined, 522defining URL parameters and, 43displaying external, 193getting parameter, 94, 101, 127, 194getting property, 191overriding parameter, 28retrieving, 99setting parameter, 95, 127, 195, 200

code sample for, 195, 197setting property, 212

var identifier, 92variables

See also specific typecreating, 92, 93defined, 522deleting, 94, 126getting, 94, 126scripting and, 92, 95setting, 94, 127

VBScript, 523verifyQuery method, 454Version attribute (charts), 86, 87version numbers, 267viewer applications (charts), 247Viewer charting example, 248viewer. See report viewer; web viewerviewing

charts, 52error messages, 105, 108extension point descriptions, 283, 284HTML pages, 41PDF files, 41PDF reports, 203project settings, 278property annotations, 285reports, 40, 51, 52

views, 483, 523visitor interface, 340visitor objects, 342Visual Basic Script Edition. See VBScriptvisual components, 53, 67

See also report elements; report itemsvisual elements, 59, 66

W.war files, 34, 36, 38, 187, 523web applications

accessing report viewer for, 36, 51configuring engine home for, 187external connections and, 202generating reports and, 147integrating custom report generator

with, 56web archive files, 34, 36, 38, 523web browsers, 40, 203, 489web pages, 41, 200, 523

See also HTML reportsweb servers, 33, 523web sites, xvii, 291web standards, 524


568 I n d e x

web viewer, 262See also web browsers

web.xml, 34webapps directory, 34web-based reports, 147

See also web applicationsWebLogic servers, 33WebSphere servers, 33well-formed XML, 524windows, 96, 501Windows platforms, 19, 23wizardPageClass property, 449wizards, 275, 390, 404, 441wizards package, 405wizards plug-in, 404workbench projects, 73, 277

See also Eclipse workbench; projectsworkspace. See Eclipse workspaceworkspace directory, 32World Wide Web Consortium (W3C), 524wrapping Java objects, 131wrap-up processing phase (events), 79writer objects, 342

Xx series items, 230

See also data seriesx-axis items, 164x-axis values. See axes valuesXML (defined), 487XML documents, 524XML elements, 59, 60, 268, 484XML Extension-Point Schema Definition

files. See XML schema filesXML files, 59, 62

XML formats, 337, 339XML manifest files, 275, 277XML PATH language, 524XML schema files, 268XML Schema language, 62XML schemas

BIRT extension points and, 335creating extensions and, 268, 283custom formats and, 300defined, 514ODA extensions and, 366overview, 268presentation extensions and, 300query extensions and, 300report item extensions and, 307, 312report item generation and, 300report item user interfaces and, 300report rendering extension and, 330ROM report items and, 299validating designs and, 62

XML streams, 131XML writer, 337, 339xml-property property type, 60XMLSpy utility, 62XMLWriter class, 339, 341XPath expressions, 524

Yy series items, 228, 229, 230

See also data seriesy-axis values. See axes values

Z.zip files. See archive files


birt-print-2.book Page 525 Friday, October 20, 2006 5:44...

Documents

Transcript of birt-print-2.book Page 525 Friday, October 20, 2006 5:44...