com.technia.tvc.core.util.cache.loader

Class ResourceLoader

java.lang.Object

com.technia.tvc.core.util.cache.loader.ResourceLoader

All Implemented Interfaces:

CacheLoader, com.technia.tvc.core.util.cache.KeyTransformer

Direct Known Subclasses:

XMLResourceLoader

public abstract class ResourceLoader
extends java.lang.Object
implements CacheLoader, com.technia.tvc.core.util.cache.KeyTransformer

A CacheLoader that loads objects from resources.

Since:

6.1.5

Constructor Summary

Constructors

Constructor and Description
ResourceLoader(com.technia.tvc.core.res.ResourceDefType type) Creates a loader for the given type.
ResourceLoader(java.lang.String resourceTypeName)

Method Summary

Modifier and Type	Method and Description
void	cacheWasCleared(Cache cache) This method is called when the underlying cache was cleared.
boolean	canLoad(java.lang.Object key) This method is called to check if a CacheLoader can load an object from the specified key.
void	fill(CacheRef cache) Fill the cache with all objects that we can find (optional).
java.lang.Object	getCacheKey(java.lang.Object key)
protected com.technia.tvc.core.res.ResourceDefLocator	getLocator()
boolean	isObsolete(java.lang.Object key, java.lang.Object value) This method is called to see if the current object in the cache is obsolete and has to be reloaded.
java.lang.Object	load(java.lang.Object key) Load an object that was requested from the cache, but was not already in the cache.
abstract ResourceSource	loadResource(java.lang.String name, java.net.URL url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceLoader

public ResourceLoader(com.technia.tvc.core.res.ResourceDefType type)

Creates a loader for the given type.

Parameters:

type - The resource type.

Since:

6.1.5

ResourceLoader

public ResourceLoader(java.lang.String resourceTypeName)

Parameters:

resourceTypeName - The name of the resource type

Since:

2009.2.2

Method Detail

cacheWasCleared

public void cacheWasCleared(Cache cache)

Description copied from interface: CacheLoader

This method is called when the underlying cache was cleared.

Specified by:

cacheWasCleared in interface CacheLoader

Parameters:

cache - TODO

getCacheKey

public java.lang.Object getCacheKey(java.lang.Object key)

Specified by:

getCacheKey in interface com.technia.tvc.core.util.cache.KeyTransformer

canLoad

public boolean canLoad(java.lang.Object key)

Description copied from interface: CacheLoader

This method is called to check if a CacheLoader can load an object from the specified key.

Specified by:

canLoad in interface CacheLoader

Parameters:

key - The key that was requested in the Cache.

Returns:

Returns true if the loader can load an object from the specified key.

getLocator

protected com.technia.tvc.core.res.ResourceDefLocator getLocator()

Returns:

Returns the locator.

Since:

6.1.5

fill

public void fill(CacheRef cache)
          throws TVCException

Description copied from interface: CacheLoader

Fill the cache with all objects that we can find (optional).

Specified by:

fill in interface CacheLoader

Parameters:

cache - The cache to fill.

Throws:

TVCException - If unable to fill the cache.

isObsolete

public boolean isObsolete(java.lang.Object key,
                          java.lang.Object value)

Description copied from interface: CacheLoader

This method is called to see if the current object in the cache is obsolete and has to be reloaded. Please note that this method will only be called by the Cache when TVC is running in development mode.

Specified by:

isObsolete in interface CacheLoader

Parameters:

key - The key that was requested in the Cache.

value - The current value in the cache.

Returns:

Returns true if the object should be reloaded.

load

public java.lang.Object load(java.lang.Object key)
                      throws TVCException

Description copied from interface: CacheLoader

Load an object that was requested from the cache, but was not already in the cache.

Specified by:

load in interface CacheLoader

Parameters:

key - The key that was requested in the Cache.

Returns:

Returns the object that was loaded.

Throws:

TVCException - If unable to load the object.

loadResource

public abstract ResourceSource loadResource(java.lang.String name,
                                            java.net.URL url)
                                     throws TVCException

Throws:

TVCException