org.eclipse.birt.report.engine.api.EngineConfig Java Examples

@Override
public void onInitialize(OrienteerWebApplication app, ODatabaseDocument db) {
	super.onInitialize(app, db);
	app.mountPages("org.orienteer.birt.web");
	app.registerWidgets("org.orienteer.birt.component.widget");
	
	try{
		
		//Connection.setUserData(new OUserDataProxy());//remarked by "useLocalDB" settings parameter 
					
	    final EngineConfig config = new EngineConfig( );

	    config.setLogConfig(LOGS_PATH, Level.FINE);
	    //config.setFontConfig("c:/temp/fontsConfig.xml");

	    Platform.startup( config );
	    //If using RE API in Eclipse/RCP application this is not needed.
	    IReportEngineFactory factory = (IReportEngineFactory) Platform
	            .createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
	    engine = factory.createReportEngine( config );
	    engine.changeLogLevel( Level.WARNING );
	}catch( Exception ex){
		LOG.error("Can't initialize BIRT module", ex);
	}
}
 

public TemplateExecutor( ExecutionContext context )
{
	this.context = context;
	String tmpDir = null;
	if ( context != null )
	{
		IReportEngine engine = context.getEngine( );
		if ( engine != null )
		{
			EngineConfig config = engine.getConfig( );
			if ( config != null )
			{
				tmpDir = config.getTempDir( );
			}
		}
	}
	if ( tmpDir == null )
	{
		tmpDir = FileUtil.getJavaTmpDir( );
	}
	if ( tmpDir == null )
	{
		tmpDir = ".";
	}
	imageFolder = new File( tmpDir );
}
 

public IReportEngine createReportEngine( )
{
	EngineConfig config = new EngineConfig( );
	HashMap map = new HashMap( );
	File jar = new File( JAR );
	map.put( EngineConstants.PROJECT_CLASSPATH_KEY, jar.getAbsolutePath( ));
	config.setAppContext( map );
	// assume we has in the platform
	Object factory = Platform
			.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
	if ( factory instanceof IReportEngineFactory )
	{
		return ( (IReportEngineFactory) factory )
				.createReportEngine( config );
	}
	return null;
}
 

public void open( Map appContext, EngineConfig config,
		DataEngineFlowMode flowMode ) throws BirtException
{
	engine = createReportEngine( config );
	if ( mode == PreviewType.RESULTSET )
	{
		task = engine.createDatasetPreviewTask( );
		task.setDataEngineFlowMode( flowMode );
	}
	else
	{
		task = new OutParameterPreviewTask( (ReportEngine) engine );
	}
	task.setMaxRow( maxRow );
	task.setDataSet( dataSetHandle );
	task.setAppContext( appContext );
	ReportParameterUtil.completeParamDefalutValues( task, dataSetHandle.getModuleHandle( ) );
}
 

public void open( Map appContext, EngineConfig config ) throws BirtException
{
	engine = createReportEngine( config );
	if ( mode == PreviewType.RESULTSET )
	{
		task = engine.createDatasetPreviewTask( );
	}
	else
	{
		task = new OutParameterPreviewTask( (ReportEngine) engine );
	}
	task.setMaxRow( maxRow );
	task.setDataSet( dataSetHandle );
	task.setAppContext( appContext );
	ReportParameterUtil.completeParamDefalutValues( task, dataSetHandle.getModuleHandle( ) );
}
 

private EngineConfig getEngineConfig( ModuleHandle handle )
	{
		EngineConfig ec = new EngineConfig( );
		ClassLoader parent = Thread.currentThread( ).getContextClassLoader( );
		if ( parent == null )
		{
			parent = this.getClass( ).getClassLoader( );
		}
		ClassLoader customClassLoader = DataSetProvider.getCustomScriptClassLoader( parent, handle );
		
//		"customerClassLoader" should not be set into engine appContext, which results in using wrong
//		classLoader later in JavascriptEvalUtil class. Comment the following lines can make data
//		preview work correctly.
		
		
//		ec.getAppContext( ).put( EngineConstants.APPCONTEXT_CLASSLOADER_KEY,
//				customClassLoader );
		return ec;
	}
 

/**
 * Create a Report Engine using a configuration.
 * 
 * The user must set the BIRT_HOME in the EngineConfig.
 * 
 * @param config
 *            an engine configuration object used to configure the engine
 */
public ReportEngine( EngineConfig config )
{
	if ( config == null )
	{
		throw new NullPointerException( "config is null" );
	}
	this.config = config;
	beans = new HashMap<String, Object>( );
	mergeConfigToAppContext( );

	intializeLogger( );

	logger.log( Level.FINE, "ReportEngine created. EngineConfig: {0} ",
			config );
	this.helper = new ReportEngineHelper( this );
	openedDocuments = new LinkedObjectManager<ReportDocumentReader>( );
	IStatusHandler handler = config.getStatusHandler( );
	if ( handler != null )
	{
		handler.initialize( );
	}
	
	registerCustomFontConfig( );
}
 

protected void loadOption( IReportEngine engine )
{
	if ( engine != null )

	{
		EngineConfig config = engine.getConfig( );
		if ( config != null )
		{
			Object locator = config.getResourceLocator( );
			if ( locator != null )
			{
				options.put( ModuleOption.RESOURCE_LOCATOR_KEY, locator );
			}
			Object resourcePath = config.getResourcePath( );
			if ( resourcePath != null )
			{
				options
						.put( ModuleOption.RESOURCE_FOLDER_KEY,
								resourcePath );
			}
		}
	}
}
 

/**
 * get the tempDir which be set in EngineConfig.
 */
protected String getTempDir( ExecutionContext context )
{
	IReportEngine engine = context.getEngine( );
	if ( engine != null )
	{
		EngineConfig config = engine.getConfig( );
		if ( config != null )
		{
			return config.getTempDir( );
		}
	}
	return null;
}
 

protected IReportEngine getEngine( )
{
	if ( engine == null )
	{
		try
		{
			EngineConfig config = new EngineConfig( );
			// config.setEngineHome( getReportEngineHome( ) );

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

			engine = new ReportEngine( config );

			engine.changeLogLevel( Level.WARNING );

			HTMLEmitterConfig hc = new HTMLEmitterConfig( );
			HTMLCompleteImageHandler imageHandler = new HTMLCompleteImageHandler( );
			hc.setImageHandler( imageHandler );
			config.setEmitterConfiguration( HTML_FORMAT, hc );
		}
		catch ( Exception ex )
		{
		}
	}
	return engine;
}
 

protected IReportEngine getReportEngine( ) throws BirtException
{
	EngineConfig config = new EngineConfig( );

	Platform.startup( config );

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

}
 

public void setUp( )
{
	removeFile( ORIGINAL_REPORT_DESIGN );
	removeFile( CHANGED_REPORT_DESIGN );
	EngineConfig config = new EngineConfig( );
	engine = new ReportEngine( config );
}
 

private ReportEngine createReportEngine(Level logLevel, String fileName)
{
	EngineConfig engineConfig = new EngineConfig();
	engineConfig.setLogConfig(null, logLevel);
	engineConfig.setLogFile(fileName);
	return new ReportEngine(engineConfig);
}
 

protected String execute( String reportName, Locale locale )
		throws Exception
{
	ReportEngine engine = new ReportEngine( new EngineConfig( ) );
	InputStream in = this.getClass( ).getResourceAsStream( reportName );
	assertTrue( in != null );
	ReportRunnable runnable = (ReportRunnable)engine.openReportDesign( in );
	if ( in != null )
	{
		try
		{
			in.close( );
		}
		catch ( IOException e )
		{					
		}
	}

	ExecutionContext context = new ExecutionContext( );
	setEngine( context, engine );

	context.setLocale( ULocale.forLocale( locale ) );
	context.setRunnable( runnable );
	ByteArrayOutputStream out = new ByteArrayOutputStream( );
	DumpEmitter emitter = new DumpEmitter( out );
	ReportExecutor executor = new ReportExecutor( context );
	context.setExecutor( executor );
	
	ReportExecutorUtil.execute( executor, emitter );
	
	return out.toString( );
}
 

protected IReportEngine createReportEngine() {
	EngineConfig config = new EngineConfig();

       IReportEngineFactory engineFactory = (IReportEngineFactory)Platform.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
	assertNotNull(engineFactory);
	
	IReportEngine reportEngine = engineFactory.createReportEngine( config );
	assertNotNull(reportEngine);
	return reportEngine;
}
 

private EngineConfig getEngineConfig( ModuleHandle handle )
{
	EngineConfig ec = new EngineConfig( );
	ClassLoader parent = Thread.currentThread( ).getContextClassLoader( );
	if ( parent == null )
	{
		parent = this.getClass( ).getClassLoader( );
	}
	ClassLoader customClassLoader = DataSetProvider.getCustomScriptClassLoader( parent, handle );
	ec.getAppContext( ).put( EngineConstants.APPCONTEXT_CLASSLOADER_KEY,
			customClassLoader );
	return ec;
}
 

private static EngineConfig getEngineConfig( ModuleHandle handle )
{
	EngineConfig ec = new EngineConfig( );
	ClassLoader parent = Thread.currentThread( ).getContextClassLoader( );
	if ( parent == null )
	{
		parent = handle.getClass( ).getClassLoader( );
	}
	ClassLoader customClassLoader = DataSetProvider.getCustomScriptClassLoader( parent, handle );
	ec.getAppContext( ).put( EngineConstants.APPCONTEXT_CLASSLOADER_KEY,
			customClassLoader );
	return ec;
}
 

/**
 * Get engine instance.
 * 
 * @return engine instance
 */
synchronized public static ReportEngine getInstance( )
{
    if ( engine == null )
	{
		System.setProperty( "RUN_UNDER_ECLIPSE", "false" ); //$NON-NLS-1$ //$NON-NLS-2$
           EngineConfig config = new EngineConfig( );
           String t = Platform.getLocation( ).toFile( ).getAbsolutePath( );
           config.setEngineHome( t ); //$NON-NLS-1$
           engine = new ReportEngine( config );
	}
    
    return engine;
}
 

public String[] getTypeInfo( )
{
	List<String> list = new ArrayList<String>();
	if ( typeInfo == null )
	{
		ReportEngine engine = new ReportEngine( new EngineConfig( ) );
		//typeInfo = engine.getSupportedFormats( );
		EmitterInfo[] emitters = engine.getEmitterInfo( );
		if (emitters == null || emitters.length == 0)
		{
			typeInfo = new String[]{};
		}
		else
		{
			List<String> temp = new ArrayList<String>();
			for (int i=0; i<emitters.length; i++)
			{
				EmitterInfo info = emitters[i];
				if (!info.isHidden( ))
				{
					temp.add( info.getFormat( ) );
				}
			}
			Collections.sort(temp, new AlphabeticallyComparator());
			typeInfo = temp.toArray(new String[temp.size( )] );
		}
	}
	return typeInfo;
}
 

public IReportEngine createReportEngine( final EngineConfig config )
{
	return java.security.AccessController
			.doPrivileged( new java.security.PrivilegedAction<IReportEngine>( ) {

				public IReportEngine run( )
				{
					return new ReportEngine( config );
				}
			} );
}
 

/**
 * Test IEmitterServices methods.
 * 
 * @throws BirtException
 */
public void testIEmitterServices( ) throws BirtException
{
	EngineConfig config = new EngineConfig( );
	emitterConfig = new HTMLEmitterConfig( );
	config.setEmitterConfiguration( EMITTER_HTML, emitterConfig );
	emitterConfig = config.getEmitterConfigs( ).get( EMITTER_HTML );
	Platform.startup( config );
	IReportEngineFactory factory = (IReportEngineFactory) Platform
			.createFactoryObject( IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY );
	IReportEngine reportEngine = factory.createReportEngine( config );
	IReportRunnable reportRunnable = engine.openReportDesign( this
			.genInputFile( report ) );

	IRenderOption options = new HTMLRenderOption( );
	options.setOutputFormat( EMITTER_HTML );
	options.setOutputFileName( this.genOutputFile( "myService.html" ) );
	HTMLRenderContext renderContext = new HTMLRenderContext( );
	renderContext.setImageDirectory( "myImage" ); //$NON-NLS-1$
	HashMap appContext = new HashMap( );
	appContext.put(
			EngineConstants.APPCONTEXT_HTML_RENDER_CONTEXT,
			renderContext );
	appContext.put( "emitter_class", this );

	IRunAndRenderTask rrTask = reportEngine
			.createRunAndRenderTask( reportRunnable );
	rrTask.setRenderOption( options );
	rrTask.setAppContext( appContext );
	rrTask.run( );
	rrTask.close( );
}
 

/**
 * Test getConfig() method
 */
public void testGetConfig( )
{
	EngineConfig config = new EngineConfig( );
	config.setTempDir( "tempdir" );
	ReportEngine engine = new ReportEngine( config );
	EngineConfig configGet = engine.getConfig( );
	assertEquals( "getConfig() fail", config.getTempDir( ), configGet
			.getTempDir( ) );
}
 

/**
 * Test openReportDesign(string)
 * 
 * @throws EngineException
 */
public void testOpenReportDesign( ) throws EngineException
{
	EngineConfig config = new EngineConfig( );
	IReportRunnable reportRunner;
	config.setTempDir( "tempdir" );
	ReportEngine engine = new ReportEngine( config );
	/*
	 * String input =
	 * PLUGIN_PATH+System.getProperty("file.separator")+RESOURCE_BUNDLE
	 * .getString("CASE_INPUT"); input +=
	 * System.getProperty("file.separator") ; String
	 * designName=input+"report_engine.rptdesign";
	 */
	String designName = this.genInputFile( "report_engine.rptdesign" );

	try
	{
		reportRunner = engine.openReportDesign( designName );
		designName = "file:" + designName;
		designName = designName.replace( '/', '\\' );
		String reportName = reportRunner.getReportName( ).replace(
				'/',
				'\\' );
		assertEquals( "openReportDesign(String) fail", designName
				.substring( designName.indexOf( "org" ), designName
						.length( ) ), reportName.substring( reportName
				.indexOf( "org" ), reportName.length( ) ) );
		assertNotNull( "openReportDesign(String) fail", reportRunner
				.getImage( "23.gif" ) );
	}
	catch ( EngineException ee )
	{
		ee.printStackTrace( );
		fail( "openReportDesign(String) fail" );
	}
	engine.destroy( );

}
 

/**
 * Test openReportDesign(inputStream)
 */
public void testOpenReportDesign1( )
{
	EngineConfig config = new EngineConfig( );
	IReportRunnable reportRunner;
	config.setTempDir( "tempdir" );
	ReportEngine engine = new ReportEngine( config );
	/*
	 * String input =
	 * PLUGIN_PATH+System.getProperty("file.separator")+RESOURCE_BUNDLE
	 * .getString("CASE_INPUT"); input +=
	 * System.getProperty("file.separator") ; String
	 * designName=input+"report_engine.rptdesign";
	 */

	String designName = this.genInputFile( "report_engine.rptdesign" );

	try
	{
		File file = new File( designName );
		FileInputStream fis = new FileInputStream( file );
		reportRunner = engine.openReportDesign( fis );
		assertEquals(
				"openReportDesign(InputStream) fail",
				"<stream>",
				reportRunner.getReportName( ) );
		assertNotNull( "openReportDesign(InputStream) fail", reportRunner
				.getImage( "23.gif" ) );
	}
	catch ( EngineException ee )
	{
		ee.printStackTrace( );
	}
	catch ( FileNotFoundException fe )
	{
		fe.printStackTrace( );
	}
	engine.destroy( );

}
 

/**
 * Test createGetParameterDefinitionTask()
 */
public void testCreateGetParameterDefinitionTask( )
{
	EngineConfig config = new EngineConfig( );
	IReportRunnable reportRunner;
	ReportEngine engine = new ReportEngine( config );
	/*
	 * String input =
	 * PLUGIN_PATH+System.getProperty("file.separator")+RESOURCE_BUNDLE
	 * .getString("CASE_INPUT"); input +=
	 * System.getProperty("file.separator") ; String
	 * designName=input+"parameter.rptdesign";
	 */
	String designName = this.genInputFile( "parameter.rptdesign" );

	try
	{
		reportRunner = engine.openReportDesign( designName );
		IGetParameterDefinitionTask getParamTask = engine
				.createGetParameterDefinitionTask( reportRunner );
		getParamTask.evaluateDefaults( );
		IParameterDefnBase paramDefn = getParamTask.getParameterDefn( "p1" );
		System.err.println( paramDefn.getTypeName( ) );
		System.err.println( paramDefn instanceof ScalarParameterDefn );
		assertEquals(
				"creatGetParameterDefinitionTask() fail",
				"abc",
				getParamTask.getDefaultValue( paramDefn ) );
	}
	catch ( EngineException ee )
	{
		ee.printStackTrace( );
	}

}
 

public void testGetEmitterInfos( )
{
	String[][] expected = {
		{ "uk.co.spudsoft.birt.emitters.excel.XlsxEmitter", "xlsx", null, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "page-break-pagination" },
		{ "org.eclipse.birt.report.engine.emitter.pdf", "pdf", null, "application/pdf", "paper-size-pagination" },
		{ "org.eclipse.birt.report.engine.emitter.postscript", "postscript", null, "application/postscript", "paper-size-pagination" },
		{ "org.eclipse.birt.report.engine.emitter.word", "doc", null, "application/msword", "page-break-pagination" },
		{ "org.eclipse.birt.report.engine.emitter.docx", "docx", null, "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "page-break-pagination" },
		{ "org.eclipse.birt.report.engine.emitter.html", "html", null, "text/html", "page-break-pagination" },
		{ "org.eclipse.birt.report.engine.emitter.prototype.ods", "ods", "resource/ODS.gif", "application/vnd.oasis.opendocument.spreadsheet", "no-pagination" },
		{ "org.eclipse.birt.report.engine.emitter.ppt", "ppt", null, "application/vnd.ms-powerpoint", "paper-size-pagination" },
		{ "org.eclipse.birt.report.engine.emitter.pptx", "pptx", null, "application/vnd.openxmlformats-officedocument.presentationml.presentation", "paper-size-pagination" },
		{ "org.eclipse.birt.report.engine.emitter.odt", "odt", "resource/ODT.gif", "application/vnd.oasis.opendocument.text", "page-break-pagination" },
		{ "uk.co.spudsoft.birt.emitters.excel.XlsEmitter", "xls_spudsoft", null, "application/vnd.ms-excel", "page-break-pagination" }
	};
	EngineConfig config = new EngineConfig( );
	ReportEngine engine = new ReportEngine( config );
	EmitterInfo[] emitters = engine.getEmitterInfo( );
	assertNotNull(emitters);
	for ( int i = 0; i < expected.length; i++ )
	{
		String found = "";
		for ( int j = 0; j < emitters.length; j++ )
		{
			if( expected[i][0].equals(emitters[j].getID()))
			{
				found = emitters[j].getID();
				assertEquals( expected[i][1], emitters[j].getFormat( ) );
				assertEquals( expected[i][2], emitters[j].getIcon( ) );
				assertEquals( expected[i][3], emitters[j].getMimeType( ) );
				assertEquals( expected[i][4], emitters[j].getPagination( ) );
				break;
			}
		}
		assertEquals(expected[i][0], found);
	}
}
 

protected void setUp( ) throws Exception
{
	super.setUp( );

	// IPlatformContext context = new PlatformFileContext( );
	// config.setEngineContext( context );
	// this.engine = new ReportEngine( config );

	EngineConfig config = new EngineConfig( );
	this.engine = createReportEngine( config );
}
 

protected void setUp( ) throws Exception
{
	super.setUp( );

	// IPlatformContext context = new PlatformFileContext( );
	// config.setEngineContext( context );
	// this.engine = new ReportEngine( config );

	EngineConfig config = new EngineConfig( );
	this.engine = createReportEngine( config );
}
 

public void setUp( ) throws Exception
{
	super.setUp( );
	EngineConfig config = new EngineConfig( );
	this.engine = createReportEngine( config );
	removeResource( );
	copyResource_INPUT( INPUT, INPUT );

}
 

public void setUp( )
{
	removeFile( REPORT_DOCUMENT );
	removeFile( REPORT_DESIGN );
	EngineConfig config = new EngineConfig( );
	engine = createReportEngine( config );
}