forked from eclipse-birt/birt
-
Notifications
You must be signed in to change notification settings - Fork 1
/
ReportEngine.java
592 lines (547 loc) · 17.5 KB
/
ReportEngine.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
/*******************************************************************************
* Copyright (c) 2004 Actuate Corporation.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Actuate Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.birt.report.engine.api;
import java.io.InputStream;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.eclipse.birt.core.archive.IDocArchiveReader;
import org.eclipse.birt.core.archive.compound.IArchiveFile;
import org.eclipse.birt.core.exception.BirtException;
import org.eclipse.birt.core.framework.Platform;
import org.eclipse.birt.report.model.api.IResourceLocator;
import org.eclipse.birt.report.model.api.ReportDesignHandle;
/**
* This is a wrapper class for the IReportEngine.
* The new user should use the IReportEngineFactory to create the IReportEngine
* instead of use this class directly.
* @see org.eclipes.birt.report.engine.api.ReportRunner
*/
public class ReportEngine implements IReportEngine
{
/**
* the logger
*/
protected static Logger logger = Logger.getLogger( IReportEngine.class.getName( ) );
/**
* the report engine.
*/
protected IReportEngine engine;
/**
* Constructor. If config is null, engine derives BIRT_HOME from the
* location of the engine jar file, and derives data driver directory as
* $BIRT_HOME/drivers. For a simple report with no images and links, engine
* will run without complaining. If the report has image/chart defined, the
* engine has to be configured with relevant image and chart handlers.
*
* @param config
* an engine configuration object used to configure the engine
*/
public ReportEngine( EngineConfig config )
{
try
{
Platform.startup( config );
}
catch ( BirtException ex )
{
logger.log( Level.SEVERE, ex.getMessage( ), ex );
}
Object factory = Platform
.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
if ( factory instanceof IReportEngineFactory )
{
engine = ( (IReportEngineFactory) factory )
.createReportEngine( config );
}
if ( engine == null )
{
System.out.println( "Can not load the report engine" );
}
}
/**
* get the root scope used by the engine
*
* @return
*/
public Object getRootScope( )
{
return engine.getRootScope( );
}
/**
* Change the log level to newLevel
*
* @param newLevel -
* new log level
*/
public void changeLogLevel( Level newLevel )
{
engine.changeLogLevel( newLevel );
}
/**
* returns the engine configuration object
*
* @return the engine configuration object
*/
public EngineConfig getConfig( )
{
return engine.getConfig( );
}
/**
* opens a report design file and creates a report design runnable. From the
* ReportRunnable object, embedded images and parameter definitions can be
* retrieved. Constructing an engine task requires a report design runnable
* object.
*
* @param designName
* the full path of the report design file
* @return a report design runnable object
* @throws EngineException
* throwed when the input file does not exist, or the file is
* invalid
*/
public IReportRunnable openReportDesign( String designName )
throws EngineException
{
return engine.openReportDesign( designName );
}
/**
* opens a report designHandle and creates a report design runnable. From the
* ReportRunnable object, embedded images and parameter definitions can be
* retrieved. Constructing an engine task requires a report design runnable
* object.
*
* @param designHandle
* @return a report design runnable object
* @throws EngineException
*/
public IReportRunnable openReportDesign( ReportDesignHandle designHandle )
throws EngineException
{
return engine.openReportDesign( designHandle );
}
/**
* opens a report design stream and creates a report design runnable. From
* the ReportRunnable object, embedded images and parameter definitions can
* be retrieved. Constructing an engine task requires a report design
* runnableobject.
*
* @param designStream
* the report design input stream
* @return a report design runnable object
* @throws EngineException
* throwed when the input stream is null, or the stream does not
* yield a valid report design
*/
public IReportRunnable openReportDesign( InputStream designStream )
throws EngineException
{
return engine.openReportDesign( designStream );
}
/**
* opens a report design stream and creates a report design runnable. From
* the ReportRunnable object, embedded images and parameter definitions can
* be retrieved. Constructing an engine task requires a report design
* runnable object.
*
* @param name
* system id of the report design
* @param designStream
* input stream of the report design
* @return a report design runnable object
* @throws EngineException
* throwed when the input stream is null, or the stream does not
* yield a valid report design
*/
public IReportRunnable openReportDesign( String name,
InputStream designStream ) throws EngineException
{
return engine.openReportDesign( name, designStream );
}
/**
* creates an engine task for running and rendering report directly to
* output format
*
* @param reportRunnable
* the runnable report design object
* @return a run and render report task
*/
public IRunAndRenderTask createRunAndRenderTask(
IReportRunnable reportRunnable )
{
return engine.createRunAndRenderTask( reportRunnable );
}
/**
* creates an engine task for obtaining report parameter definitions
*
* @param reportRunnable
* the runnable report design object
* @return a run and render report task
*/
public IGetParameterDefinitionTask createGetParameterDefinitionTask(
IRunnable reportRunnable )
{
return engine.createGetParameterDefinitionTask( reportRunnable );
}
/**
* creates an engine task for obtaining report parameter definitions
*
* @param reportRunnable
* the runnable report design object
* @return a GetParameterDefinitionTask
*/
public IGetParameterDefinitionTask createGetParameterDefinitionTask(
IReportRunnable reportRunnable )
{
return engine.createGetParameterDefinitionTask( reportRunnable );
}
/**
* returns all supported output formats through BIRT engine emitter
* extensions
*
* @return all supported output formats through BIRT engine emitter
* extensions
*/
public String[] getSupportedFormats( )
{
return engine.getSupportedFormats( );
}
/**
* Return all the emitter information which BIRT Engine can load.
*
* @return the emitter information
*/
public EmitterInfo[] getEmitterInfo( )
{
return engine.getEmitterInfo();
}
/**
* the MIME type for the specific formatted supported by the extension.
*
* @param format
* the output format
* @param extensionID
* the extension ID, which could be null if only one plugin
* supports the output format
* @return the MIME type for the specific formatted supported by the
* extension.
*/
public String getMIMEType( String format )
{
return engine.getMIMEType( format );
}
/**
* shuts down the report engine
*/
public void destroy( )
{
if ( engine != null )
{
engine.destroy( );
engine = null;
}
}
/**
* creates a task to run a report to generate a report document
*
* @param reportRunnable
* the runnable report design object
* @return a task that runs the report
*/
public IRunTask createRunTask( IReportRunnable reportRunnable )
{
return engine.createRunTask( reportRunnable );
}
/**
* creates a task that renders the report to a specific output format.
*
* @param reportDocument
* a handle to an IReportDocument object
* @return a task that renders a report to an output format
*/
public IRenderTask createRenderTask( IReportDocument reportDocument )
{
return engine.createRenderTask( reportDocument );
}
/**
* opens a report document and returns an IReportDocument object, from which
* further information can be retrieved.
*
* @param fileName
* the report document name. report document is an archive in
* BIRT.
* @return A handle to the report document
* @throws EngineException
* throwed when the report document archive does not exist, or
* the file is not a valud report document
*/
public IReportDocument openReportDocument( String fileName )
throws EngineException
{
return engine.openReportDocument( fileName );
}
/**
* creates a task that allows data extraction from a report document
*
* @param reportDocument
* a handle to an IReportDocument object
* @return a task that renders a report to an output format
*/
public IDataExtractionTask createDataExtractionTask(
IReportDocument reportDocument )
{
return engine.createDataExtractionTask( reportDocument );
}
/**
* shut down the engine, release all the resources.
*
* @deprecated
*/
public void shutdown( )
{
engine.shutdown( );
}
/**
* opens a report document and returns an IReportDocument object, from which
* further information can be retrieved.
*
* @param systemId
* the system id the opend document. It is used to access the resources with
* relative path in the report document. If it is NULL, a saved one is used.
* @param fileName
* the report document name. report document is an archive in
* BIRT.
* @return A handle to the report document
* @throws EngineException
* throwed when the report document archive does not exist, or
* the file is not a valid report document
*/
public IReportDocument openReportDocument( String systemId, String fileName )
throws EngineException
{
return engine.openReportDocument( systemId, fileName );
}
/**
* opens a report design file and creates a report design runnable. From the
* ReportRunnable object, embedded images and parameter definitions can be
* retrieved. Constructing an engine task requires a report design runnable
* object.
*
* @param designName
* the full path of the report design file
* @param locator
* the resource locator used to locate files referenced in the design
* @return a report design runnable object
* @throws EngineException
* throwed when the input file does not exist, or the file is
* invalid
*/
public IReportRunnable openReportDesign( String designName,
IResourceLocator locator ) throws EngineException
{
return engine.openReportDesign( designName, locator );
}
/**
* opens a report design stream and creates a report design runnable. From
* the ReportRunnable object, embedded images and parameter definitions can
* be retrieved. Constructing an engine task requires a report design
* runnable object.
*
* @param name
* system id of the report design
* @param designStream
* input stream of the report design
* @param locator
* the resource locator used to locate files referenced in the design
* @return a report design runnable object
* @throws EngineException
* throwed when the input stream is null, or the stream does not
* yield a valid report design
*/
public IReportRunnable openReportDesign( String name,
InputStream designStream, IResourceLocator locator )
throws EngineException
{
return engine.openReportDesign( name, designStream, locator );
}
/**
* open the report design and return the runnable
* @param name
* system id of the report design.
* @param designStream
* input stream of the report desgin.
* @param options
* options used to parse the design.
* @return a report design runnable object
* @throws EngineException
*/
public IReportRunnable openReportDesign( String name,
InputStream designStream, Map options )
throws EngineException
{
return engine.openReportDesign( name, designStream, options );
}
/**
* opens a report document and returns an IReportDocument object, from which
* further information can be retrieved.
*
* @param fileName
* the report document name. report document is an archive in
* BIRT.
* @param locator
* the resource locator used to locate files referenced in the design
* @return A handle to the report document
* @throws EngineException
* throwed when the report document archive does not exist, or
* the file is not a valud report document
*/
public IReportDocument openReportDocument( String fileName,
IResourceLocator locator ) throws EngineException
{
return engine.openReportDocument( fileName, locator );
}
/**
* opens a report document and returns an IReportDocument object, from which
* further information can be retrieved.
*
* @param systemId
* the system id the opend document. It is used to access the resources with
* relative path in the report document. If it is NULL, a saved one is used.
* @param fileName
* the report document name. report document is an archive in
* BIRT.
* @param locator
* the resource locator used to locate files referenced in the design
* @return A handle to the report document
* @throws EngineException
* throwed when the report document archive does not exist, or
* the file is not a valud report document
*/
public IReportDocument openReportDocument( String systemId,
String fileName, IResourceLocator locator ) throws EngineException
{
return engine.openReportDocument( systemId, fileName, locator );
}
/**
* opens a report document and returns an IReportDocument object, from which
* further information can be retrieved.
*
* @param systemId
* the system id the opend document. It is used to access the resources with
* relative path in the report document. If it is NULL, a saved one is used.
* @param fileName
* the report document name. report document is an archive in
* BIRT.
* @param options
* Map defines the options used to parse the design file.
* @return A handle to the report document
* @throws EngineException
* throwed when the report document archive does not exist, or
* the file is not a valid report document
*/
public IReportDocument openReportDocument( String systemId,
String fileName, Map options ) throws EngineException
{
return engine.openReportDocument( systemId, fileName, options );
}
/**
* opens a report document and returns an IReportDocument object, from which
* further information can be retrieved.
*
* @param systemId
* the system id the opend document. It is used to access the resources with
* relative path in the report document. If it is NULL, a saved one is used.
* @param reader
* a report archive for reading
* @param options
* Map defines the options used to parse the design file.
* @return A handle to the report document
* @throws EngineException
* throwed when the report document archive does not exist, or
* the file is not a valid report document
*/
public IReportDocument openReportDocument( String systemId,
IDocArchiveReader reader, Map options ) throws EngineException
{
return engine.openReportDocument( systemId, reader, options );
}
/**
* get the logger used by report engine
*
* @return the logger used by the report engine
*/
public Logger getLogger( )
{
return engine.getLogger( );
}
/**
* set the logger used by report engine.
*
* @param logger
*/
public void setLogger( Logger logger )
{
engine.setLogger( logger );
}
/**
* create a task that renders the report to a specific output format.
*
* @param reportDocument
* a handle to an IReportDocument object
* @param reportRunnable
* the runnable report design object
* @return a task that renders a report to an output format
*/
public IRenderTask createRenderTask( IReportDocument reportDocument,
IReportRunnable reportRunnable )
{
return engine.createRenderTask( reportDocument, reportRunnable );
}
/**
* Returns data extraction extension information.
*
* @return the data extraction extension information
*/
public DataExtractionFormatInfo[] getDataExtractionFormatInfo( )
{
return engine.getDataExtractionFormatInfo( );
}
/**
* creates a document writer that can write this archive file
*
* @param file
* the archive file
* @return a document writer of this archive file
* @throws EngineException
*/
public IDocumentWriter openDocumentWriter( IArchiveFile file )
throws EngineException
{
return engine.openDocumentWriter( file );
}
/**
* get the BIRT version
*/
public String getVersion( )
{
return engine.getVersion( );
}
public IEngineTask createEngineTask( String taskName )
throws EngineException
{
return engine.createEngineTask( taskName );
}
public IDatasetPreviewTask createDatasetPreviewTask( )
throws EngineException
{
return engine.createDatasetPreviewTask( );
}
}