| ReportEngine.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.portal.kernel.bi.reporting;
24
25 import java.util.Map;
26
27 import javax.servlet.ServletContext;
28
29 import javax.sql.DataSource;
30
31 /**
32 * <a href="ReportEngine.java.html"><b><i>View Source</i></b></a>
33 *
34 * @author Michael C. Han
35 *
36 */
37 public interface ReportEngine {
38
39 public void compile(ReportRequest reportRequest)
40 throws ReportGenerationException;
41
42 public void destroy();
43
44 public void execute(
45 ReportRequest reportRequest,
46 ReportResultContainer reportResultContainer)
47 throws ReportGenerationException;
48
49 public Map<String, String> getEngineParameters();
50
51 public void init(ServletContext servletContext);
52
53 public void registerDataSource(
54 String dataSourceName, DataSource dataSource);
55
56 public void setDefaultDataSouce(DataSource dataSource);
57
58 public void setEngineParameters(Map<String, String> engineParameters);
59
60 public void setReportFormatExporterRepository(
61 ReportFormatExporterRegistry reportFormatExporterRegistry);
62
63 public void unregisterDataSource(String dataSourceName);
64
65 }