01: /**
02: * ===========================================
03: * JFreeReport : a free Java reporting library
04: * ===========================================
05: *
06: * Project Info: http://reporting.pentaho.org/
07: *
08: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
09: *
10: * This library is free software; you can redistribute it and/or modify it under the terms
11: * of the GNU Lesser General Public License as published by the Free Software Foundation;
12: * either 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, but WITHOUT ANY WARRANTY;
15: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16: * See the GNU Lesser General Public License for more details.
17: *
18: * You should have received a copy of the GNU Lesser General Public License along with this
19: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20: * Boston, MA 02111-1307, USA.
21: *
22: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
23: * in the United States and other countries.]
24: *
25: * ------------
26: * ResourceBundleFactory.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report;
30:
31: import java.io.Serializable;
32: import java.util.Locale;
33: import java.util.ResourceBundle;
34:
35: /**
36: * A resource bundle factory defines the locale for a report and is used to create resourcebundles.
37: *
38: * @author Thomas Morgner
39: */
40: public interface ResourceBundleFactory extends Serializable {
41: /**
42: * A constant containing the configuration key to specify a resource-bundle name for the report.
43: * <p/>
44: * This property has the value "org.jfree.report.ResourceBundle".
45: */
46: public static final String DEFAULT_RESOURCE_BUNDLE_CONFIG_KEY = "org.jfree.report.ResourceBundle";
47:
48: /**
49: * Creates a resource bundle for the given key. How that key is interpreted depends on the used concrete
50: * implementation of this interface.
51: *
52: * @param key the key that identifies the resource bundle
53: * @return the created resource bundle
54: * @throws java.util.MissingResourceException
55: * if no resource bundle for the specified base name can be found
56: */
57: public ResourceBundle getResourceBundle(String key);
58:
59: /**
60: * Returns the locale that will be used to create the resource bundle. This locale is also used to initialize the
61: * java.text.Format instances used by the report.
62: *
63: * @return the locale.
64: */
65: public Locale getLocale();
66: }
|