Source code: com/dghda/kent/ReportTransform.java
1 /* Copyright (C) 2001 Duane Griffin <duanegriffin@users.sourceforge.net>
2 This file is part of Kent.
3
4 Kent is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
9 Kent is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 General Public License for more details.
13
14 You should have received a copy of the GNU General Public
15 License along with Kent; see the file COPYING. If not,
16 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA.
18 */
19
20 package com.dghda.kent;
21
22 /**
23 An interface used to transform a report's results.
24 For example, an implementing class may generate a HTML representation of
25 the results.
26 */
27 public interface ReportTransform extends KentModule {
28
29 /** Returns the MIME type of the result of the transform. */
30 public String getContentType (java.util.Properties config);
31
32 /**
33 Transform the results of a report.
34 @param output The stream the transformed results will be written to.
35 @param template The report template being transformed.
36 @param data The report data being transformed.
37 @param config The configuration settings for the transformation.
38 */
39 public void transform (java.io.OutputStream output,
40 String template, String data,
41 java.util.Properties config)
42 throws java.io.IOException, ReportTransformException;
43 }