org.pentaho.reporting.libraries.resourceloader

Class ResourceManager

public final class ResourceManager extends Object

The resource manager takes care about the loaded resources, performs caching, if needed and is the central instance when dealing with resources. Resource loading is a two-step process. In the first step, the ResourceLoader accesses the physical storage or network connection to read in the binary data. The loaded ResourceData carries versioning information with it an can be cached indendently from the produced result. Once the loading is complete, a ResourceFactory interprets the binary data and produces a Java-Object from it.

Resources are identified by an Resource-Key and some optional loader parameters (which can be used to parametrize the resource-factories).

Author: Thomas Morgner

Field Summary
static String	BUNDLE_CACHE_PROVIDER_KEY
static String	BUNDLE_LOADER_PREFIX
static String	DATA_CACHE_PROVIDER_KEY
static String	FACTORY_CACHE_PROVIDER_KEY
static String	FACTORY_TYPE_PREFIX
static String	LOADER_PREFIX

Constructor Summary
	ResourceManager() Default Constructor.
	ResourceManager(ResourceManagerBackend resourceManagerBackend)
	ResourceManager(ResourceManager parent, ResourceManagerBackend backend)

Method Summary
Resource	create(ResourceKey key, ResourceKey context, Class target)
Resource	create(ResourceKey key, ResourceKey context)
Resource	create(ResourceKey key, ResourceKey context, Class[] target)
Resource	createDirectly(Object keyValue, Class target)
ResourceKey	createKey(Object data) Creates a ResourceKey that carries no Loader-Parameters from the given object.
ResourceKey	createKey(Object data, Map parameters) Creates a ResourceKey that carries the given Loader-Parameters contained in the optional map.
ResourceKey	deriveKey(ResourceKey parent, String path) Derives a new key from the given resource-key.
ResourceKey	deriveKey(ResourceKey parent, String path, Map parameters) Derives a new key from the given resource-key.
ResourceKey	deserialize(ResourceKey bundleKey, String serializedKey) Converts a serialized version of a `ResourceKey` into an actual `ResourceKey` by locating the proper `ResourceLoader` that can perform the deserialization.
ResourceManagerBackend	getBackend()
ResourceBundleDataCache	getBundleCache()
ResourceDataCache	getDataCache()
ResourceFactoryCache	getFactoryCache()
ResourceData	load(ResourceKey key)
ResourceData	loadRawData(ResourceKey key)
ResourceBundleData	loadResourceBundle(ResourceKey key) Tries to find the first resource-bundle-loader that would be able to process the key.
void	registerBundleDataCache()
void	registerBundleLoader(ResourceBundleLoader loader)
void	registerDataCache()
void	registerDefaultFactories()
void	registerDefaultLoaders()
void	registerDefaults()
void	registerFactory(ResourceFactory factory)
void	registerFactoryCache()
void	registerLoader(ResourceLoader loader)
String	serialize(ResourceKey bundleKey, ResourceKey key) Creates a String version of the `ResourceKey` that can be deserialized with the `deserialize()` method.
void	setBundleCache(ResourceBundleDataCache bundleCache)
void	setDataCache(ResourceDataCache dataCache)
void	setFactoryCache(ResourceFactoryCache factoryCache)
void	shutDown()
URL	toURL(ResourceKey key) Tries to convert the resource-key into an URL.

Field Detail

BUNDLE_CACHE_PROVIDER_KEY

public static final String BUNDLE_CACHE_PROVIDER_KEY

BUNDLE_LOADER_PREFIX

public static final String BUNDLE_LOADER_PREFIX

DATA_CACHE_PROVIDER_KEY

public static final String DATA_CACHE_PROVIDER_KEY

FACTORY_CACHE_PROVIDER_KEY

public static final String FACTORY_CACHE_PROVIDER_KEY

FACTORY_TYPE_PREFIX

public static final String FACTORY_TYPE_PREFIX

LOADER_PREFIX

public static final String LOADER_PREFIX

Constructor Detail

ResourceManager

public ResourceManager()

Default Constructor.

ResourceManager

public ResourceManager(ResourceManagerBackend resourceManagerBackend)

ResourceManager

public ResourceManager(ResourceManager parent, ResourceManagerBackend backend)

Method Detail

create

public Resource create(ResourceKey key, ResourceKey context, Class target)

create

public Resource create(ResourceKey key, ResourceKey context)

create

public Resource create(ResourceKey key, ResourceKey context, Class[] target)

createDirectly

public Resource createDirectly(Object keyValue, Class target)

createKey

public ResourceKey createKey(Object data)

Creates a ResourceKey that carries no Loader-Parameters from the given object.

Parameters: data the key-data

Returns: the generated resource-key, never null.

Throws: ResourceKeyCreationException if the key-creation failed.

createKey

public ResourceKey createKey(Object data, Map parameters)

Creates a ResourceKey that carries the given Loader-Parameters contained in the optional map.

Parameters: data the key-data parameters an optional map of parameters.

Returns: the generated resource-key, never null.

Throws: ResourceKeyCreationException if the key-creation failed.

deriveKey

public ResourceKey deriveKey(ResourceKey parent, String path)

Derives a new key from the given resource-key. Only keys for a hierarchical storage system (like file-systems or URLs) can have derived keys. Since LibLoader 0.3.0 only hierarchical keys can be derived. For that, the deriving path must be given as String.

Before trying to derive the key, the system tries to interpret the path as absolute key-value.

Parameters: parent the parent key, must never be null path the relative path, that is used to derive the key.

Returns: the derived key.

Throws: ResourceKeyCreationException if deriving the key failed.

deriveKey

public ResourceKey deriveKey(ResourceKey parent, String path, Map parameters)

The optional parameter-map will be applied to the derived key after the parent's parameters have been copied to the new key.

Before trying to derive the key, the system tries to interpret the path as absolute key-value.

Parameters: parent the parent key, or null to interpret the path as absolute key. path the relative path, that is used to derive the key. parameters a optional map containing resource-key parameters.

Returns: the derived key.

Throws: ResourceKeyCreationException if deriving the key failed.

deserialize

public ResourceKey deserialize(ResourceKey bundleKey, String serializedKey)

Converts a serialized version of a ResourceKey into an actual ResourceKey by locating the proper ResourceLoader that can perform the deserialization.

Parameters: serializedKey the String serialized key to be deserialized

Returns: the ResourceKey that has been deserialized

Throws: ResourceKeyCreationException indicates an error trying to create the ResourceKey from the deserialized version