1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* Copyright (c) 2006 - 2009 Pentaho Corporation and Contributors. All rights reserved.
*/
package org.pentaho.reporting.libraries.resourceloader;
import java.util.Map;
/**
* A resource bundle is a compound archive that holds several resources.
*
* @author Thomas Morgner
*/
public interface ResourceBundleLoader
{
/**
* Tries to load the bundle. If the key does not point to a usable resource-bundle, this method returns
* null. The Exception is only thrown if the bundle is not readable because of IO-Errors.
* <p/>
* A resource-bundle loader should only load the bundle for the key itself, never for any of the derived subkeys.
* It is the ResourceManager's responsibility to search the key's hierachy for the correct key.
*
* @param key the resource key pointing to the bundle.
* @return the loaded bundle or null, if the resource was not understood.
* @throws ResourceLoadingException if something goes wrong.
*/
public ResourceBundleData loadBundle
(final ResourceManager resourceManager, final ResourceKey key) throws ResourceLoadingException;
/**
* Checks, whether this resource loader implementation was responsible for
* creating this key.
*
* @param key the key that should be tested.
* @return true, if the key is supported.
*/
public boolean isSupportedKey (ResourceKey key);
/**
* Derives a new resource key from the given key. If neither a path nor new
* factory-keys are given, the parent key is returned.
*
* @param parent the parent
* @param path the derived path (can be null).
* @param factoryKeys the optional factory keys (can be null).
* @return the derived key.
* @throws ResourceKeyCreationException if the key cannot be derived for any
* reason.
*/
public ResourceKey deriveKey (ResourceKey parent,
String path,
Map factoryKeys)
throws ResourceKeyCreationException;
/**
* Serializes the resource key to a String representation which can be recreated
* using the <code>deserialize(ResourceKey)<code> method.
* @return a <code>String<code> which is a serialized version of the <code>ResourceKey</code>
* @throws ResourceException indicates an error serializing the resource key
* @param bundleKey
* @param key
*/
public String serialize(final ResourceKey bundleKey, final ResourceKey key) throws ResourceException;
/**
* Creates a <code>ResourceKey</code> based off the <code>String</code> representation
* of the key. The <code>String</code> should have been created using the <code>serialize</code>
* method.
*
* @param bundleKey
*@param stringKey the <code>String</code> representation of the <code>ResourceKey</code> @return a <code>ResourceKey</code> which matches the <code>String</code> representation
* @throws ResourceKeyCreationException indicates an error occurred in the creation or
* deserialization of the <code>ResourceKey</code>
*/
public ResourceKey deserialize(final ResourceKey bundleKey, final String stringKey) throws ResourceKeyCreationException;
public boolean isSupportedDeserializer(final String data) throws ResourceKeyCreationException;
}
|
