F
-F command line option 19
-f command line option 19
factory API classes 260
factory method 222
factory processes 86
fetch events 70
fetch method
retrieving data rows and 174, 178, 182
writing event handlers and 127
field names. See column names
field variables 734 See also member variables; variables
fields 304, 734 See also columns; computed fields
File class 524
file objects 524
file output streams 257, 474, 499, 609
file systems 27, 264, 265, 266
FileDialog method 586
files See also specific type
accessing resource 264
changing source code and 356
creating 101
creating reports and 43
extracting program archive 8, 9
generating output and 257
generating temporary 221
mapping to report viewer 29
overview 47–49
referencing image 266
removing BIRT program 12
rendering output and 465, 473, 497
ROM schemas and XML 53
updating designers and 11
writing logging information to 269
writing to disk 219
FileSelectionWizardPage class 539, 543
fill colors (charts) 160
Fill interface 159
fill patterns (charts) 159
fillOval method 687
fillPolygon method 700
filter element 536
filtering data 46, 49, 89, 276
Find declaring extension point setting 373
findDataSet method 303
findDataSource method 303
findElement method 293
finding source archives 378
findTOCByValue method 286
flat file data sources 98, 509
flat files 735 See also text files
Float class 735
float data type 735
floating footers 283
floating point numbers 726, 727, 735
flute.jar 260
font files 31
font style constants 297
fontFamily style specifications 54
form e-capable browser. See web browsers
format styles. See styles
FormatCharts charting example 341
FormatCharts class 341
FormatChartsViewer class 341
formatQueryText method 524
chart labels and 162
charting extensions and 649, 687
configuring emitters for 264
customizing report generators for 49
debugging and 197
defined 736
generating ebXML data and 494
generating reports and 257, 278
loading emitters for 388
rendering charts and 155
rendering output and. See output formats
rendering report items and 397
viewing reports and 43
formatted output 257, 281, 286, 288
Formula Editor. See expression builder
formulas. See expressions
fragment. See plug-in fragments
fragment tag 635
fragment.xml 635
frame objects 113
framework 736 See also classes
Full Eclipse Install package 4, 7
Full Eclipse Installation 7–8, 351
functions 93, 95, 320, 736 See also methods
fundamental data types. See data types
G
Gantt charts 310 See also charts
GanttDataSet interface 310
GEF plug-in 4
GeneratedChartState objects 153, 154
generating
binary documents 281
ebXML data formats 494
formatted output 257, 281, 286
PDF documents 278
report design files 44, 49, 227
report document files 44
reports 49, 73, 227, 262, 270, 286
sample data 325
update site listings 383
generation phase (engine) 65, 73, 80, 86, 91
generation phase events 74
generation services 42, 44, 45, 219
genReport script 20
get method 293
getAllExtensionProperties method 134
getAppContext method 87, 92, 131, 265
getBlock method 146
getBody method 293
getBookmarkInstance method 271
getBookmarks method 271
getBooleanOption method 285
getBundle method 114
getCategory method 170
getCategoryAxis method 171
getCategoryProvider method 409
getChartInstance method 145
getChartSubtypes method 662, 665
getChildren method 286
getColumnCount method 97, 133, 135, 476
getColumnMetaData method 97, 134
getColumnName method 97, 133, 135, 528
getColumnNativeTypeName method 97, 133
getColumnTypeName method 97, 133
getColumnTypes method 619
getColumnValue method 134, 135
getCompatibleAxisType method 674
getConnection method 523, 529, 565
getContents method 273
getConvertedChart method 667
getConvertedSeries method 670
getDataSet method 134
getDataSets method 303, 304, 326
getDataSource method 134
getDataSources method 303, 304
getDataType method 274
getDefaultDimension method 662, 672
getDefaultOrientation method 662
getDefaultValue method 274
getDefaultValueList events 66, 72
getDefaultValues method 274
getDescription method 146, 170
getDesignHandle method 87, 292
getDisplayName method 659, 662
getDsMinMax method 693
getElementFactory method 323
getEventObject method 688
getExportLabelTag method 501
getExpressionValue method 135
getExtendedProperties method 146
getExtensionID method 134
getExtensionProperty method 134
getExternalContext method 146, 149
getFactory method 170
getGlobalVariable method 87, 131
getGridColumnCount method 146
getHibernateProp method 577
getHibernatePropTypes method 577
getHttpServletRequest method 87, 131
getInteractivity method 146
getLabelPropValue method 501, 502
getLogger method 146
getMaxConnections method 565
getMaxQueries method 567
getMeasure method 297
getNext method 293
getOption method 285
getOptions method 285
getOutline method 314
getOutputFileName method 285
getOutputFormat method 87, 88, 132
getOutputType method 171
getPageNumber method 286
getPageVariable method 87
getParameterDefn method 273
getParameterDefns method 273
getParameterDisplayText method 87
getParameterType method 273
getParameterValue method 87, 100, 132
getParameterValues method 274
getPersistentGlobalVariable method 87, 90, 132
getPlatform method 265
getPlot method 146
getPrimaryBaseAxes method 315
getPrimaryOrthogonalAxis method 315
getPropertyHandle method 298
getQuery method 544
getQueryColumnNames method 545
getQueryText method 134
getRealPath method 266
getRenderOption method 132
getReportElement method 170
getReportName method 616
getReportRunnable method 87, 132, 271
getResource method 87
getResult method 572
getResultSetColumn method 305
getResultSetExpression method 305
getResultSetMetaData method 546, 592, 593
getRoot method 286
getRow method 527
getRowData method 135
getRunTimeSeries method 151, 311
getSampleData method 146
getScript method 147
getSelectionList method 274
getSelectionListForCascadingGroup method 277
getSelectionValueList events 66, 72
getSeries method 663, 673, 689
getSeriesAttributeSheet method 673, 676
getSeriesClass method 673, 674
getSeriesDataComponent method 673, 674, 675
getSeriesDefinitions method 319
getSeriesForLegend method 147
getSeriesThickness method 147
getSQLStateType method 568
getStatus method 288
getString method 527, 529, 572
getStyle method 294
getStyles method 147
getSubType method 147
getSupportedDimensions method 662, 672
getSupportedImageFormats method 282
getTaskType method 132
getText method 294
getTimeZone method 88
getTOCTree method 286
getUnits method 147
getURI method 294
getValue method 274
getValueAxes method 171
getValueSeries method 171, 172
getVersion method 147
GIF formats 282
global options (design engine) 227
global options (report engine) 220
global variables 84, 85, 87, 90, 736 See also variables
Glossary 707
glyph 736 See also character sets; fonts
GObjectFactory class 688
grandchild classes. See descendant classes
grandparent classes. See ancestor classes
Graphical Editing Framework 4
graphical report design tool 43
graphical user interfaces. See user interfaces
graphics. See images
graphics API 424
GraphicsUtil class 406
graphs. See charts
grid cells. See cells
Grid Column Count attribute 146, 147, 148
grid elements 737
GridHandle objects 289
grids 59, 737 See also grid elements; grid items
group fields. See group keys
group footers 736
group headers 738
group keys 738
group sections 76
group slots 294
grouped reports 737
grouping breakpoints 192
grouping data 46, 49, 79, 151 See also groups
grouping plug-ins 383
GroupOnXSeries charting example 341
GroupOnYAxis charting example 341
binding data and 76
building data rows for 77
defined 737
generating tables or lists and 78
setting page breaks for 76
GUI components 46 See also user interfaces
H
handle classes 228, 229, 230 See also report elements
handle objects 297
handleEvent method 682
handler classes 117 See also event handler classes
hasOption method 285
hasOwnModel property 397
hasStyle property 396
headings. See column headings
Helios Eclipse SDK software 351, 352
help 752 See also BIRT documentation
hexadecimal numbers 738
Hibernate Core for Java 510
Hibernate data sources 173, 554
Hibernate data types 563
Hibernate libraries 577
Hibernate objects 173
Hibernate ODA driver example 555, 564
Hibernate ODA driver plug-in 556, 577
Hibernate ODA drivers 384, 554, 555, 565, 574
Hibernate ODA extensions 554, 555
Hibernate ODA UI example 555
Hibernate ODA UI extension points 580
Hibernate ODA UI extensions 577
Hibernate ODA UI plug-in
building 594
creating projects for 578
launching 595
specifying dependencies for 580
specifying run-time settings for 580
testing 594–599
hibernate package 564
hibernate plug-in 554, 556, 577
Hibernate Query Language. See HQL statements
hibernate ui plug-in 554
hibernate.cfg 555
HibernateClassSelectionPage class 588
HibernateDataSourceWizard class 584, 588
HibernateDriver class 564, 565
HibernateHqlSelectionPage class 585
HibernatePageHelper class 584, 585, 588
HibernatePropertyPage class 584, 588
HibernateUtil class 565, 573, 577
hiding report content 90
hierarchy 738
highlight rules 299
home directory 358
home directory parameter 524
HOME property 524
HOME value 519
homeDir parameter 524
host instance (PDE Workbench) 368
HQL (defined) 510
HQL statements See also Hibernate data sources
adding user interface for 585
downloading sample plug-in for 384
executing 571
retrieving data with 572
verifying 590
HTML (defined) 739
HTML elements 730
HTML emitter configurations 265
HTML emitter options 266
HTML extension 727
HTML format parameter 20
HTML rendering options 266, 282
HTML reports See also web pages
configuring properties for 284
opening 288
paginating 283
referencing images in 266
rendering output for 258
saving image files for 266
setting up rendering context for 282
writing event handlers for 76
writing to disk 219
HTML tables 283
HTML tags 282
HTML value 20
HTMLActionHandler class 284
HTMLCompleteImageHander class 266, 267
HTMLRenderOption class 258, 266, 281, 282, 284
HTMLRenderOption objects 266
HTMLServerImageHandler class 266, 267
HTTP (defined) 740
HTTP servlet requests 87, 93, 131
hypercharts 739
HyperText Markup Language. See HTML
HyperText Markup Language pages. See web pages
HyperText Transfer Protocol. See HTTP
I
IActionFilter interface 537
IAggregateFunction interface 649
IBM WebSphere servers 25
ICascadingParameterGroup interface 273
ICell interface 129
ICellInstance interface 130
IChart interface 170
IChartType interface 648, 661, 664
IChartWithAxes interface 170, 171
IChartWithoutAxes interface 170, 172
IColumnMetaData interface 97, 133
ICommonDataExtractionOption interface 610
icon property 470
IConnection interface 522, 564
icons directory 663
IContentEmitter interface 470
ICU library 260
icu.jar 260
id attribute 636
id element 537
ID property
CSV ODA UI extension 535
CSV rendering extension 470
data extraction extension 607
ODA data source extension 518
rotated label plug-in 395
id property
data extraction extension 607
emitter extension 470
ODA data sets 519
ODA data sources 518
property pages 398
report element adapters 447
IDataExtractionExtension interface 609
IDataExtractionOption interface 610
IDataExtractionTask interface 222
IDataSetEventHandler interface 126, 127
IDataSetInstance interface 133
IDataSetInstance objects 126
IDataSetMetaData interface 523, 564
IDataSetProcessor interface 151
IDataSetRow interface 134
IDataSetRow objects 126
IDataSourceEventHandler interface 125, 126, 127
IDataSourceInstance interface 126, 127
IDataSourceInstance objects 125, 127
identifiers 740
IDesignElement interface 129
IDeviceRenderer interface 155
IDisplayServer interface 155
IDriver interface 518, 522, 564, 565
IEmitterServices interface 474, 499
IEngineTask interface 222
IExternalContext objects 146
IExtractionResults interface 609
IFigure interface 435
IGetParameterDefinitionTask interface 222
IGetParameterDefinitionTask objects 220, 273
IGetParameterDefnTask interface 272
IHTMLImageHandler interface 266, 267
IHTMLImageHandler objects 266
image constants 294
image directory 266
image elements 740 See also images
image file names 266
image formats 282
Image UI provider 421, 429, 435
ImageHandle objects 294
defined 740
displaying 429
exporting 473
generating HTML reports and 266
handling events for 137
referencing 266
rendering context and 282
rendering labels as 385
rendering text items as 404, 424, 425
resizing chart legend 163
rotating 408
saving 266
specifying formats for 471
IME files 741
IMenuBuilder interface 443
Import Projects dialog 354
importing
source code projects 22
in_count parameter 183
incrementing record counters 105
index.jsp 28
indexing column position 96
inheritance 740
initCustomControl method 542, 585, 587
initialization code 181
initialize method
building report designs and 102, 128
charting extensions and 659
importing Java packages and 112
rendering CSV output and 474
rendering XML output and 499
script execution and 101
writing event handlers and 85
XMLDataExtractionImpl 615
initializeControl method 590
initializing report elements 71
initSessionFactory method 574
initXMLOptions method 615
inner joins 740 See also joins
inner reports. See subreports
Input Method Editor files 741
input parameters 183
input sources. See data sources
input streams 306
inputParams array 183
Install New Software command 384
install new software manager 381, 382, 384
installation
BIRT Full Eclipse Install 7–8
BIRT RCP Report Designer 8–9
chart engine 15–16
demo database 18
DTP Integration package 17
Eclipse SDK software 352
language packs 10–11
report viewer 26–28
Samples package 21
source code 21–22
troubleshooting 9–10
TrueType fonts 31
upgrades and 11
WTP plug-ins 22
installation errors 9
instance interfaces 130
instance variables 741 See also class variables; variables
instances. See objects
int data type 742
Integer class 742
integer data type. See int data type
integrating with report generators 49
interactive features (charts) 146, 147, 155, 688
interactive features (report items) 421
Interactivity property 435
InteractivityCharts example 342
interfaces See also application programming interfaces; user interfaces
adapter class extensions and 118
adapter classes compared to 124
chart engine API and 239, 240, 310
chart events and 151, 155, 161, 163
charting applications and 169, 170
charting extensions and 648, 658, 661
data extraction extensions and 609
data set objects and 133
defined 742
design engine API and 230, 238
design model objects and 226
developing with 217
event handlers and 117, 124, 128
generating HTML documents and 266, 267
generating reports and 263
hierarchical diagrams for 218
loading BIRT plug-ins and 265, 266
naming conventions for 123
ODA drivers and 509, 517, 522, 565
opening report files and 258
plug-in extensions and 360
rendering output and 258
rendering reports and 473
report designs and 128
report document files and 271
report elements and 129–135
report engine API and 219, 225, 257
report item extensions and 398
report parameters and 272
scripted data sets and 127
scripted data sources and 126
web services connections and 185
International Components for Unicode. See ICU library
internationalization 742 See also locales
invalid data types 195
IP addresses 742
IPageGenerator interface 398, 448
IParameterDefnBase interface 272
IParameterGroupDefn interface 272, 273
IParameterSelectionChoice interface 273, 274
IParameterSelectionChoice objects 277
IPlatformContext interface 264, 265, 266
IPlatformContext objects 265
IPrimitiveRenderer interface 686, 687
IRenderOption interface 281
IRenderOption objects 258
IRenderTask interface 222, 279, 281
IReportContent interface 475, 499
IReportContext interface 131
IReportContext objects 125, 126, 128
IReportDesign objects 128
IReportDocument interface 221, 271
IReportDocument objects 258, 270, 271
IReportElement interface 129
IReportElementInstance interface 135
IReportEngineFactory interface 220, 267
IReportEventHandler interface 128
IReportItemBuilderUI interface 440
IReportItemFactory interface 396
IReportItemFigureProvider interface 395, 421
IReportItemImageProvider interface 395, 421
IReportItemLabelProvider interface 421
IReportItemPresentation interface 397, 424
IReportRunnable interface 221
IReportRunnable objects 258, 270, 271
IResultSetMetaData interface 523, 564
IRowData interface 135
IRowInstance interface 130
IRunAndRenderTask interface 223, 278, 281
IRunAndRenderTask objects 223, 258, 284
IRunTask objects 222
IScalarParameterDefn interface 272, 274
IScalarParameterDefn objects 273
isColorByCategory method 171
isComputedColumn method 97, 133
IScriptedDataSourceEventHandler interface 127
isDimensionSupported method 662
isEmpty method 273
isEncryptable attribute 519
isEncryptable property 397
ISeriesRenderer interface 155, 648, 686
ISeriesUIProvider interface 673
isExportDataType variable 615
isHorizontal method 171
isList property 397
isLocaleNeutral element 612
isLocaleNeutral variable 615
isNameRequired property 396
isRowInFooterBand method 477
IStatusHandler interface 265
IStyleProcessor interface 342
isv plug-ins 261
isValidAggregationType method 673
iterator objects 182
ITextItem interface 129
ITOCTree interface 286
J
J2EE application servers 4
J2EE applications 31
accessing demo database and 18
accessing Java classes and 113
accessing JDBC data sources and 261
adding to classpaths 118
building plug-in fragments and 642
building plug-ins and 390
building update sites and 382
building web viewer 350
changing source code and 356
charting API examples and 340
charting applications and 308
configuring BIRT engines and 220, 228
creating event handlers and 117, 164
creating JNDI connections and 33
debugging and 198
defined 743
deploying Java classes and 183
deploying to web servers and 26
developing applications and 259, 261
developing ODA extensions and 513
installing designers and 9
installing report viewer and 27, 28
running reports and 118
setting driver location and 92
testing CSV rendering extension and 484
Java. See Java programming language
Java 2 Enterprise Edition. See J2EE environments
Java 2 Runtime Standard Edition. See J2SE environments
Java adapter classes. See adapter classes; Java event handlers
Java APIs 44
Java applets 708
Java applications See also applications
adding charting capabilities to 15, 307
adding reporting capabilities to 19
generating charts and 46
rendering reports and 219
Java archives. See .jar files
Java Attribute Editor 376
Java Build Path page 118
Java Build Path settings 261
associating with report elements 121
building report designs and 226, 227, 230
building scripted data sources and 182
changing chart objects and 239, 240
changing report designs and 262
debugging event handlers and 194
generating reports and 263, 270
handling events and 117, 118, 121
implementing data extraction extensions and 609, 610, 614
implementing rotated label plug-in and 390, 404
instantiating 115
opening data sets and 127
opening data sources and 125, 127
registering 320
rendering CSV output and 473, 485
rendering XML output and 498
running plug-in instances and 360, 364, 368
running reports and 219, 220, 223
setting location of 113
setting properties for 119, 376
Java code 25, 63, 112, 114, 117
Java compiler 350
Java Database Connectivity. See JDBC
Java development environment 64
Java Development Kit. See JDK software
Java Development Tools interface 194
Java editor 120
Java event handler classes. See Java classes
Java event handler examples 135–142, 343
Java event handlers See also event handlers
accessing classes for 121
accessing JAR files for 118
accessing methods for 114
associating context objects with 131
building charts and 143, 164–167, 170, 320
building data sets and 126, 127, 180
building data sources and 125, 126
changing designs and 128
compared to JavaScript 63
extending adapter classes for 118
generating report elements and 117, 123
generating report items and 125
integrating with JavaScript 112, 113
passing JavaScript variables to 84
retrieving external content and 149
saving 113
tracking execution sequence for 101
viewing 64
Java EventHandler debugger 188
Java files 64
Java interfaces 117, 128, 217, 742
Java methods 113
Java Naming and Directory Interface 743
Java programming language 742 See also Java code
Java report generator 49
Java Runtime Environment 25
Java source files 119
Java Virtual Machines. See JVMs
JAVA_HOME variable 350
java.lang package 112
JavaBeans 744
Javadoc files 261
JavaScript See also source code
accessing data and 173
accessing Java classes for 112
concatenating values and 75
creating event handlers and. See JavaScript event handlers
customizing reports and 262
defined 744
entering 94
line breaks in 320
validating syntax of 189
wrapping Java code in 112, 113
JavaScript array properties 97
JavaScript debugger 188
JavaScript event handler examples 107–111, 343
JavaScript event handlers See also event handlers
accessing application context and 91
accessing methods for 114
adding to designs 83
adding variables to 84, 85, 90
associating context objects with 86
building charts and 143, 148, 167–169, 170, 320
building data sets and 181
building data sources and 181
changing connection properties and 99
changing designs and 89
changing property values and 98
closing connections and 92
compared to Java 63
tutorial for 103–107
dropping report elements and 90
generating report elements and 93
getting column information for 96, 97
getting parameter values and 100
previewing 96
retrieving external content and 149
running reports and 93
saving 113
setting parameter values and 101
setting properties with 94
tracking execution sequence for 101
type casting and 152
viewing 64
JavaScript expressions 86, 188, 456, 458
JavaScript files 111
JavaScript implementation 83
JavaScript language 744
JavaScript library 260
JavaScript names 96
JavaScript objects 113
JavaScript palette 106
JavaScriptViewer application 343
JavaServer Pages. See JSPs
JavaViewer application 343
JDBC (defined) 743
JDBC connection profiles 510
JDBC data sources 32, 98, 261, 510
JDBC driver manager 9
adding nonstandard 26
configuring Hibernate data sources for 555, 574
configuring JNDI service providers for 32, 33
loading 261
setting location of 92
jdbc plug-in 92
JDT interface 194
JNDI (defined) 743
JNDI connection objects 33
JNDI connection properties 33
JNDI name paths 32
jndi.properties file 33
join conditions 745
JointDataSet element 60
JPEG formats 155
JPG device renderers 649
JRE software 25
js.jar 260
JVM path 10
K
keyboard input 194
keywords 745
L
-l locale command line option 20
Label object (charts) 160
label tag 501
Label UI provider 421
LabelImpl class 160
labels (charts). See chart labels
labels (reports) 56, 385, 405, 745 See also label elements; label items
LabelStyleProcessor class 342
language packs 10–11, 635, 645
language settings 643
language-specific environments. See locales
Launch an Eclipse application setting 381
launch configuration entry point 191
launch configuration types 196
launching. See opening
Layout page. See layout editor
LAYOUT_PREFERENCE_AUTO value 283
LAYOUT_PREFERENCE_FIXED value 283
layout.xsd 652
lazy load 746 See also source code
left outer joins. See outer joins
legend anchor points 158
legend area (charts) 146, 163, 314
legend entry bounds 163
Legend interface 314
legend line properties 314
legend markers 155
Legend objects 314
LegendEntryRenderingHints class 163
Level class 269
level-break listings. See grouped reports
lib plug-in 182
libraries See also component libraries
building plug-in extensions and 369, 377, 378
building plug-in fragments and 636
configuring report engine for 263
creating reporting applications and 290
defined 746
deploying applications and 262
deploying report engine and 259
developing applications and 259
developing report designers and 229
finding source archives for 378
installing BIRT and 5
naming 378
reusing designs and 44
running charting applications and 16
running Hibernate drivers and 577
scripting and 112
Library element (designs) 59
library extension element 636
library files 48, 290, 747 See also libraries
library names 195
library-specific properties 229
Life Cycle property 435
line attributes (charts) 678, 681, 682, 689
line break characters 320
line breaks (JavaScript) 320
line charts 307, 310 See also charts
line-render events 688
LINEAR_LITERAL value 161
LineAttribute objects 314
LineRenderEvent method 700
LineSeries objects 317
links. See hyperlinks
list elements 302, 747 See also list items; lists
list execution sequence (events) 78–79
list items 58, 59, 73 See also list elements; lists
Listener interface 677
listeners. See event listeners
Listing element 58
listing reports 747
ListingGroup items 79
lists See also list elements; list items
accessing report designs and 272
adding to reports 59
binding to data sets 75
building data rows for 77
displaying parameters and 274, 277
getting column information for 96, 97
grouping data for 78
handling events for 75, 77, 78
literal strings 456
load_classicmodels.sql 18
loadClass method 115
LoadExportSchema class 498, 504
loading
class files 376
document files 221
JDBC drivers 261
plug-in fragments 635
report designs 221, 258, 270, 291
report documents 258, 270, 271
resource files 265
source code 362
XML schema files 504
local classes and interfaces 218
local variables 84, 747 See also global variables; variables
locale codes 11 See also locales
Locale element 611
Locale objects 146
Locale parameter 20
Locale property 614
locale settings 11
locale variable 614
locale-independent formats 273
building charts for 146
changing 11
converting strings and 273, 635
creating session handles for 228
defined 748
developing report item extension for 417
exporting data and 612
installing language packs for 10–11
localizing display names for 520
localizing property groups for 519
localizing viewer messages for 636, 640
selecting 11
testing plug-in fragments for 637, 643
localization 10, 748 See also locales
localized messages 87
log file names 269
LOGARITHMIC_LITERAL value 161
Logger class 269
Logger objects 146
logging chart engine tasks 245
logging classes 269
logging configurations 264
logging environments 269
logging levels (applications) 269, 270
logging levels (emitters) 475, 499, 500
logging script execution 101–103
logging threshold 269
M
-m command line option 19
machine-readable metadata 360
manifest files 360, 362, 635, 748
Manifest wizard 521
MANIFEST.MF 368 See also manifest files
MANIFEST.MF page (PDE Editor) 369
mapping to report viewer 28, 29
margins 283
marker lines (charts) 161
marker range (charts) 161
markers (charts) 147, 689, 690
markup languages 727, 733, 739 See also elements; tags
mashup 748
master page components 229
master page footers 283
adding autotext items to 85
adding report items to 302
defined 748
handling events for 72, 73, 74
reusing 49
setting margins for 283
setting properties for 58
MasterPage element 58
Math class 112
matrix reports. See cross-tab reports
measurement units 228
measures 749 See also data cubes
Member element 57
member variables 749 See also field variables; variables
members 749 See also methods; variables
memory 362
menu builders 443
menuBuilders plug-in 443
messages 87 See also error messages; logging messages
Messages class
CSV ODA driver extension 523, 529
CSV ODA UI extension 538
Hibernate ODA extension 564, 585
Messages_es.properties 640
messages.properties file 538, 585, 635, 636
metadata
accessing CSV data sources and 523, 524, 528
accessing Hibernate data sources and 567, 570
adding ROM elements and 53–57
building JDBC data sets and 32
building ODA data sets and 545
creating plug-in extensions and 360
creating property sheets and 54
defined 750
examining data row 222
getting column information from 97, 133
getting data set 134
updating ODA data sets and 539, 547
metadata interface 133
meter charts 239, 310, 312, 314 See also charts
MeterChartExample application 345
Method property 60
methods See also functions
calling 114
chart blocks and 158
chart engine generator and 150
chart event handlers and 143, 145
chart instance objects and 146, 147, 148, 239
chart properties and 313
charting extensions and 658, 661, 674, 686
charting interfaces and 155, 161, 170, 171
data extraction extension and 609, 615
data set elements and 126, 133
data source elements and 125
defined 750
documentation for 257
event handler classes and 123
event handler interfaces and 117, 124
event handlers and 84, 85, 112, 113
external context objects and 149
importing Java packages and 112
ODA extensions and 522
ODA UI extensions and 540, 541, 543
opening report files and 258
overriding 124
providing external values for 265
report components and 228, 229, 292
report context objects and 86, 131
report design events and 128
report element events and 129
report engine configurations and 264
report item events and 125
run requests and 93
running plug-in instances and 364
running rotated label plug-in and 404
scripted data sets and 127, 174
scripted data sources and 127, 174
selecting 95
starting platforms and 267
viewing arguments for 124
viewing stack for 191
web services connections and 184
Microsoft Internet Explorer. See web browsers
milestone build 5
missing designer functionality 9
modal windows 750
mode 750
model definitions 456
model packages (charts) 240, 245
model plug-in 53
model renderer elements 686
model renderers (charts) 155, 648, 685, 689
model.xsd 652
modeless windows 750
modelodaapi.jar 260
modelRenderer element 686
modelrenderers extension point 685
modelrenderers plug-in 648
ModifyListener method 586
module handles 228
ModuleHandle class 228
Mozilla Firefox. See web browsers
multicolumn page layouts 59
multidimensional data 750
multilingual reports. See locales; localization
multipass aggregation 68
Multipurpose Internet Mail Extensions. See MIME types
multithreaded applications 751
multivalued parameters 100
myChart.chart file 309
mysql command line interface 18
MySQL installation scripts 577
MySQL software 5
N
name attribute
dataSource element 519
plug-in fragments 636
name collisions 112
name element 397
Name property
CSV ODA UI extension 535
CSV rendering extension 470
data extraction extension 607
ODA data source extension 518
rotated label plug-in 395
name space 229
name variable 284
names 96, 134 See also aliases; display names
naming
data extraction extensions 607
ODA driver extensions 518
ODA UI extensions 535
plug-in libraries 378
report item extensions 360, 395, 396
report items 293
report rendering extensions 470
scripted data sets 176
scripted data sources 175
naming conventions 123
National Language Support applications. See NLS applications
nativeDataType property 520
nativeDataTypeCode property 520
Navigator 751
needOutputResultSet property 471
Neutral local property 615
New Chart wizard. See chart builder
New Data Set wizard 176
New Data Source wizard 175
New Extension wizard 372
New Java Class dialog 119
New Java Class wizard 485
new line characters 478
new line tags 479
New Plug-in Project wizard 366, 367
New Project wizard 366
New Source Folder dialog 379
new_report.rpdesign 626
newElement method 302
newExtendedItem method 325
newInstance method 115
newReportItem method 405
newSessionHandle method 227
newsgroups xix
newWizard element 510
nightly builds 6
-nl command line option 11
NL1 fragment 636
NLpack1 language pack 10
NLS applications 635
NLS language pack 645
NLS messages.properties file 640
node 751
NonGroupOnXSeries.rptdesign 341
NonGroupOnYAxis.rptdesign 341
non-relational database sources 509
nonstandard drivers 26
non-visual components 51
non-visual elements 291
null values 152, 184, 519, 751
Number class 112
number parameters 274
NumberDataSet interface 151, 311
numeric data types 751
numeric expressions 751
numeric values 612
N-up reports. See multicolumn page layouts
O
-o command line option 20
object attribute filters 536
object cache 687
Object class 112
object factory (charts) 688
object libraries. See component libraries; libraries
object-oriented programming 510, 752
adding to application context 91
defined 752
determing if exists 91
iterating through 92
registering service 365
resetting to null 182
saving 132
storing 91
ODA (defined) 752
ODA API Reference 511
ODA connection constants 540
ODA connection profiles 510, 520, 535
ODA connection properties page 511
oda connectionProfile extension 510, 520
ODA context class loader 519
ODA CSV driver extension
adding data access functionality to 517–520
building projects for 513–??
compiling and debugging 513
downloading source code for 511
setting dependencies for 521
ODA CSV driver plug-ins 512, 513
ODA data set designer page 538
ODA data set editor page 530, 537
ODA data set elements 60 See also ODA data sets
ODA data set extensions 519, 530 See also ODA extensions
ODA data set handles 304
ODA data set IDs 537
ODA data set UI extension 537
ODA data set wizard page 539, 543, 588
mapping to 520
ODA data source editor page 530, 538
ODA data source elements 60 See also ODA data sources
ODA data source extension elements 518, 537
ODA data source extensions 509, 517, 530 See also ODA extensions
ODA data source handles 303
ODA data source wizard page 539, 543
ODA data source wizards 538
adding 530
closing connections to 92
creating queries for 544
preparing queries for 524
setting connection properties for 99
ODA data types 520
oda dataSource extension 509, 510, 517
ODA driver constants 529
ODA driver extension examples
Hibernate data sources 555, 564
ODA drivers
accessing CSV data sources and 511
accessing JDBC data sources and 99
adding connection profiles for 510, 520, 535
adding to BIRT framework 510
adding user interface for 385, 510, 530, 537
changing connection properties for 511
configuring 518
creating 554
defined 752
defining error messages for 523
extending functionality of 509, 512
initializing connections for 522
running 522
testing 511
ODA DTP framework 46, 509, 538
ODA DTP interfaces 509, 519, 522
ODA extension identifiers 518, 519
creating projects for 509
data type mappings for 520
defining connection properties and 99
downloading sample plug-ins for 511, 513
retrieving data and 46
setting design-time properties for 518
setting display names for 519, 520
setting run-time properties for 518
testing 548
ODA framework 510
ODA Hibernate drivers. See Hibernate drivers
ODA packages 510
ODA Runtime driver wizard 521
ODA UI extensions 512, 530, 534, 537
ODA UI plug-in 512, 535, 538, 548
ODA UI plug-in projects 511, 531–534
adding connection profiles to 510, 535
adding data sources to 530
building CSV drivers and 512
defining editor pages for 537
defining property pages for 511, 536, 538
defining wizard pages for 538, 543
enabling page editing functionality for 540, 541
generating messages for 538
testing 548
ODA wizards 509, 511, 521, 538
ODA_DEFAULT_CHARSET constant 540
OdaDataSet element 60
OdaDataSetHandle class 304
OdaDataSource element 60
OdaDataSourceHandle class 303
odadesignapi.jar 260
odaDriverClass property 99
ODAHOME constant 540
OdaJDBCDriverPassInConnection setting 92
OdaJDBCDriverPassInConnectionClose AfterUse setting 92
odaPassword property 99
odaScalarDataType property 520
odaURL property 99
odaUser property 99
odaVersion property 518
ODBC (defined) 753
OLAP (defined) 752
olap package 233
onCreate events
bound columns and 75
lists and 78
report items and 52, 71, 73, 76, 77
run-time properties and 130
tables and 78
onCreate scripting example 108
onFetch events 70
Online Analytical Processing systems. See OLAP
online help 752 See also documentation
onPageBreak events 52, 68, 71, 74, 79
onPageBreak method 125
onPageBreak script 85
onPageEnd events 68
onPageEnd script 85
onPageStart events 68
onPageStart script 85
onPrepare events 52, 71, 72, 79
onPrepare method 125
onPrepare script 107
onRender events
lists and 78
run-time properties and 130
tables and 78
onRender script 109
onRowSets method 406, 425, 457
open data access 752 See also ODA
open database connectivity. See ODBC
Open Debug Dialog command 142
Open extension point description setting 374
Open extension point schema setting 373
open method
Hibernate drivers and 565
iterator objects and 182
scripted data sets and 127, 178, 181
scripted data sources and 127, 174, 178
Open Perspective command 8
Open Services Gateway Initiative. See OSGi
open source 753
open source projects xix, 349 See also projects
open-source software development. See Eclipse
builders 439
class files 376
configuration files 29
data sources 125
debug configurations 197
Debug perspective 196
document files 221, 258, 270, 271
Export Wizard 381
HTML reports 288
PDF documents 288
Plug-in Development perspective 366
report designs 221, 258, 270, 291
schema definition files 373, 374
Tomcat Manager 30
openReportDesign method 220, 221, 258, 270
openReportDocument method 220, 221, 258, 270
operators 753
Organize Manifest wizard 521
orthogonal axis values 315, 714 See also pie charts
orthogonal series 319, 675, 691
OSGi Alliance web site 365
OSGi class loader 519
OSGi configuration property type 264
OSGi error messages 309
OSGi resource bundles 364, 368
out_msg parameter 183
outer joins 753 See also joins
outline element 396
Outline property 421
Outline view (BIRT) 194
Outline view (Eclipse) 369, 753
outlining chart legends 314
output
accessing formatted 288
changing source code and 356
creating charts and 43, 241, 649, 687
customizing reports and 262
determining 93
handling events for 71
rendering 45, 64, 80, 219, 258, 465
setting pagination for 470
storing XML 614
validating 53
output devices 241
output file name parameter 20
output file names 258, 473, 497
output files See also specific file type
accessing 288
creating 101
debugging and 197
exporting to 609
rendering CSV output and 473
rendering XML output and 494, 497, 507
tracking script execution in 101, 103
output format parameter 19
charting extensions and 649, 687
configuring emitters for 264
customizing 278, 388, 465, 602
debugging and 197
default 257
developing report generator for 49
generating ebXML data and 494
generating reports and 45, 281
rendering charts and 155
rendering images and 471
rendering report items and 397
rendering reports and 221, 222, 223
specifying MIME types for 470, 609
specifying properties for 264
output method 617
output parameters 183
converting XML data for 620
formatting 617
generating reports and 281, 288
setting 258
output types 171 See also output formats
outputDisplayNone property 471
outputParams array 183
overriding methods 124
overriding report parameters 20, 93
Overview page (PDE Editor) 369, 380, 381
overwrite property 448
P
-p command line option 20
package (defined) 754
Package Explorer 369
package names 119
package visibility settings 369, 371
Packages object 112
Packages prefix 112
page break events 76
page components 754
page counts 221
page extension element 536
page generator 449
page information 271
page layouts 49, 229, 746 See also designs; master pages
page properties 58
pagination controls 80
pagination property 470
palette (color) 228
palette (data series) 684
palette (report items) 388, 420
palette extension element 396
Palette page. See Palette view
parameter definition tasks 273, 276
parameter definitions 222
parameter files 19
PARAMETER_GROUP value 273
parameters See also data set parameters; report parameters
accessing information about 222
chart script context and 145, 149
configuring report viewer and 28, 29
connecting to web services and 184
creating scripted data sets and 183
customizing connections and 184
debugging event handlers and 188
defined 755
defining session-specific 227
grouping. See parameter groups
running reports and 93
setting multiple values for 66
viewing reports and 32
Parameters element 611
parameterValues parameter 185
param-value element 30
parent class. See superclasses
parse method 274
PATH language. See XML PATH language
BIRT APIs 261
debugger and 196
Eclipse home directory 358
font files 31
image files and 266
JNDI resource files 33
report design files 28
report viewer configurations 29
patterns 755 See also object-oriented programming
PDE (defined) 729
PDE Workbench 368–384 See also Eclipse Plug-in Development Environment
PDF converter 755
PDF device renderers 649
building charts for 342
generating 278
installing fonts for 31
missing content in 31
opening 288
rendering output for 258
PDF emitter 45
PDF reports. See PDF documents
PDF viewer. See Acrobat Reader
PDFChartGenerator charting example 342
PDFChartGenerator class 342
PDFRenderOption class 281
performance 76
persistent files 43
persistent variables 86, 87, 90, 132
pictures. See images
pie chart events 153
pie charts 239, 307, 310, 314 See also charts
placeComponents method 678
platform context 265
Platform context property type 264
PlatformFileContext class 265
PlatformServletContext class 266
PlatformServletContext objects 266
plot area (charts) 146, 154, 158, 313, 314
Plot interface 313
Plot object 314
plot properties (charts) 313, 314
plot property 312
plug-in 756
plug-in activation framework 362
plug-in archive files 360, 371
Plugin class 364
Plug-in Development Environment 360, 366, 729
Plug-in Development perspective 366 See also PDE Workbench
plug-in drivers 510
plugin element 363
plug-in extension examples 384
plug-in extension points 362, 369, 373 See also extension points
plug-in extension schema definitions 373, 374
plug-in extensions See also extensions
accessing ODA data sources and 509, 510
adding report items and 47, 387, 389, 416, 417
adding reporting functionality and 359
building 377–380
changing MIME types for 609
creating 370–377
debugging and 194
declaring 369
deploying 381–384
developing CSV ODA driver 511
downloading source code for 384
exporting 390
extracting data and 601
implementing 359
rendering reports and 465
setting class attributes for 376
specifying 372
testing 380–381
unloading 220
viewing property annotations for 376
plug-in fragment example 636, 640
plug-in fragment manifest file 635
plug-in fragment projects 637–639
plug-in fragment source code 385
plug-in fragments 635, 641, 756
plug-in manifest file 360, 362, 363, 369 See also manifest files
plug-in manifest headers 368, 369
plug-in registry 362, 466, 602
plug-in run-time class 360, 362, 364
Plug-in Selection dialog 370
plugin.xml 362, 363 See also plug-in manifest file
Plug-in.xml page (PDE Editor) 369
plugin-id attribute 636
accessing ODA data sources and 509, 510
building rotated label sample extension and 390, 393
caching conflicts and 9
calling methods in 114
charting extensions and 648, 649, 650
compiling code for 350, 354, 380, 390
configuring report engine for 263
controlling life cycle of 368
creating Hibernate driver 556, 577, 584
creating Hibernate ODA UI 594
debugging 390
defined 756
designing reports and 227, 228
developing applications and 259
developing content for 4, 360, 366, 373
developing with 359
downloading sample extensions for 384
downloading source code for 21
editing project settings for 369, 370
exporting 381
extending functionality of 370
finding source archives for 378
integrating with Eclipse 39
rendering output and 465
selecting run-time libraries for 378
setting dependencies for 370
setting location of 220
setting properties for 367
updating 384
verifying run-time archive for 371
viewing information about 369
viewing project settings for 369
plugins directory 259, 265, 362, 513
plug-ins packages 382
PNG device renderers 649
PNG formats 155, 171, 282, 687
PolygonRenderEvent event 700
polymorphism 756
populate method 151
PostScript emitter 45
PowerPoint converter 756
PPT emitter 45
predefined layouts. See master pages
predefined values 719
PreferenceServlet charting example 342
preparation phase (engine) 65, 71, 86
preparation phase events 72
preparation services 42
prepare phase (charts) 150
prepareMetaData method 524
presentation engine 388, 390, 466, 602
presentation implementer class 424
presentation phase (engine) 66, 80, 86, 91
Presentation property 435
preview engine 482
preview servlet 65
previewer 757
previewing
charts 671
rotated text images 429
scripts 96
source code 104
primary base axis (charts) 315
PrimitiveRenderEvent class 687
println method 102
PrintWriter objects 102
private classes 217
private styles 297
PrivateStyleHandle class 297
procedures 757 See also functions; methods
process 757
Process Console 194
ProductsByProductLineDBG.rptdesign 197
program upgrades 11
programmers xxi
programming environments 64, 259
programming interfaces 128
programming languages 25, 742 See also scripting languages
progressive viewing 80
accessing custom data sources and 509
accessing Java classes for 113
adding event handler classes to 118, 121
building Eclipse xix
building update sites and 382
changing settings for 369, 370
charting extensions and 654
creating
data extraction extension 603–605
ODA driver extension 511, 513, 556
ODA UI extension 511, 531, 578
report rendering extension 466, 494
rotated label extension 390–392
developing plug-in extensions and 378, 380
developing plug-in fragments and 637–639
developing plug-ins and 366, 367
running rotated label extension and 381
selecting 119
setting Javadoc locations for 261
testing 356
viewing settings for 369
adding text controls for 536
builders and 439
charting applications and 310, 312–315, 341
charting extensions 652
charts and. See chart properties
connection profiles 539
controlling visibility of 56
CSV emitters and 470
data extraction extensions 607, 610, 614
defined 758
getting 87
Hibernate data sources and 587, 588
Java packages and 112
JavaScript arrays and 97
JNDI connection 33
libraries and 229
master pages and 58
ODA CSV extensions and 518, 519
ODA data type mappings and 520
plug-ins and 367
report designs and 59, 229, 270
report elements and 130, 291, 299
report engine and 263, 264, 265, 279
report items and 59, 94, 294, 296, 298
rotated label plug-in 395, 396
rotated text items 418, 420, 429, 439
scripting and 90
user sessions and 228
Properties element 610
Properties page. See Properties view
properties tag 614
Properties view 757
property annotations 376
property binding 98
property definitions 227
Property Editor 758
property groups 519
property name element 53
property names 519
property page adapters 388, 395, 398, 446
property page generators 448
adding to user interfaces 388, 389, 410, 449, 536
building ODA user interfaces and 530, 538, 584
building text item extensions and 446
changing ODA driver settings and 511
enabling editing functionality for 445, 451, 540, 541
enabling expression builder for 460
extending report items and 418, 420, 429
implementing read-only 454
specifying categories for 409, 446, 449
specifying properties for 398
property pages extension points 511, 535, 536, 578
Property property 60
property sheets 54 See also Properties view
property structure objects 298, 299
PropertyHandle class 298
propertyPages extension point 511, 530, 535, 536, 578
propertyPages.exsd 511
protocol 758
PS emitter 45
public interfaces 217
publish 758
pUserParameters variable 614
pyramid charts 310, 323 See also charts
Q
queries See also HQL statements; SQL statements
accessing web service data sources and 185
building charts and 151, 316, 648
building ODA data sets and 544
defined 758
developing ODA extensions for 510, 522, 554
executing 525
getting parameter values and 274
retrieving data with 32, 43, 276
returning unique set of values 648
writing event handlers for 69, 74, 100
query editor 759
query preparation extensions 388
query strings (request objects) 93
Query Text control 539
QueryImpl class 318
queryProperties parameter 185
queryText method 98
queryText parameter 185
queryTimeOut map key 185
quick start package 7
quotation mark characters. See double quotation mark character