KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > JRParameter


1 /*
2  * ============================================================================
3  * GNU Lesser General Public License
4  * ============================================================================
5  *
6  * JasperReports - Free Java report-generating library.
7  * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * JasperSoft Corporation
24  * 303 Second Street, Suite 450 North
25  * San Francisco, CA 94107
26  * http://www.jaspersoft.com
27  */
28 package net.sf.jasperreports.engine;
29
30
31 /**
32  * @author Teodor Danciu (teodord@users.sourceforge.net)
33  * @version $Id: JRParameter.java 1485 2006-11-14 20:23:17 +0200 (Tue, 14 Nov 2006) teodord $
34  */
35 public interface JRParameter
36 {
37
38
39     /**
40      * A <tt>Map</tt> containing report parameters passed by users at fill time.
41      */
42     public static final String JavaDoc REPORT_PARAMETERS_MAP = "REPORT_PARAMETERS_MAP";
43
44
45     /**
46      * A <tt>java.sql.Connection</tt> needed to run the default report query.
47      */
48     public static final String JavaDoc REPORT_CONNECTION = "REPORT_CONNECTION";
49
50
51     /**
52      * An integer allowing users to limit the datasource size.
53      */
54     public static final String JavaDoc REPORT_MAX_COUNT = "REPORT_MAX_COUNT";
55
56
57     /**
58      * A {@link JRDataSource} instance representing the report data source. JasperReports defines some convenience implementations
59      * of <tt>JRDataSource</tt>, but users may create their own data sources for specific needs.
60      */
61     public static final String JavaDoc REPORT_DATA_SOURCE = "REPORT_DATA_SOURCE";
62
63
64     /**
65      * A {@link JRAbstractScriptlet} containing an instance of the report scriptlet provided by the user.
66      */
67     public static final String JavaDoc REPORT_SCRIPTLET = "REPORT_SCRIPTLET";
68
69
70     /**
71      * A <tt>java.util.Locale</tt> instance containing the resource bundle desired locale. This parameter should be used in
72      * conjunction with REPORT_RESOURCE_BUNDLE.
73      */
74     public static final String JavaDoc REPORT_LOCALE = "REPORT_LOCALE";
75
76
77     /**
78      * The <tt>java.util.ResourceBundle</tt> containing localized messages. If the resource bundle base name is specified at
79      * design time, the engine will try to load the resource bundle using specified name and locale.
80      */
81     public static final String JavaDoc REPORT_RESOURCE_BUNDLE = "REPORT_RESOURCE_BUNDLE";
82     
83
84     /**
85      * A <tt>java.util.TimeZone</tt> instance to use for date formatting.
86      */
87     public static final String JavaDoc REPORT_TIME_ZONE = "REPORT_TIME_ZONE";
88
89
90     /**
91      * The {@link JRVirtualizer JRVirtualizer} to be used for page virtualization. This parameter is optional.
92      */
93     public static final String JavaDoc REPORT_VIRTUALIZER = "REPORT_VIRTUALIZER";
94
95     
96     /**
97      * A <tt>java.lang.ClassLoader</tt> instance to be used during the report filling process to load resources such
98      * as images, fonts and subreport templates.
99      */
100     public static final String JavaDoc REPORT_CLASS_LOADER = "REPORT_CLASS_LOADER";
101
102     
103     /**
104      * A <tt>java.net.URLStreamHandlerFactory</tt> instance to be used during the report filling process to
105      * handler custom URL protocols for loading resources such as images, fonts and subreport templates.
106      */
107     public static final String JavaDoc REPORT_URL_HANDLER_FACTORY = "REPORT_URL_HANDLER_FACTORY";
108
109
110     /**
111      * A {@link net.sf.jasperreports.engine.util.FormatFactory FormatFactory} instance to be used
112      * during the report filling process to create instances of <tt>java.text.DateFormat<tt> to format date text
113      * fields and instances of <tt>java.text.NumberFormat<tt> to format numeric text fields.
114      */
115     public static final String JavaDoc REPORT_FORMAT_FACTORY = "REPORT_DATE_FORMAT_FACTORY";
116
117     
118     /**
119      * Whether to use pagination.
120      * <b>
121      * If set to <code>true</code> the report will be generated on one long page.
122      */
123     public static final String JavaDoc IS_IGNORE_PAGINATION = "IS_IGNORE_PAGINATION";
124
125
126     /**
127      *
128      */
129     public String JavaDoc getName();
130         
131     /**
132      *
133      */
134     public String JavaDoc getDescription();
135         
136     /**
137      *
138      */
139     public void setDescription(String JavaDoc description);
140         
141     /**
142      *
143      */
144     public Class JavaDoc getValueClass();
145
146     /**
147      *
148      */
149     public String JavaDoc getValueClassName();
150
151     /**
152      *
153      */
154     public boolean isSystemDefined();
155
156     /**
157      *
158      */
159     public boolean isForPrompting();
160
161     /**
162      *
163      */
164     public JRExpression getDefaultValueExpression();
165
166
167 }
168
Popular Tags