org.openimaj.io

Class Cache

java.lang.Object

org.openimaj.io.Cache

public class Cache
extends Object

In its simplest form this function constructs an object using the construct found for the objects specified. This works with all java classes. If the class also happens to be cachable, the property org.openimaj.cache.dir is use (or $HOME/.OIcache) to save the class. The object instance is saved in $CACHE_DIR/classpackage/classname/unique-name where unique-name is taken from cachable. If cachable objects already exist they are read in using IOUtils.read(java.io.File). Once created, cachable objects are saved using either IOUtils.writeASCII(java.io.File, WriteableASCII) or IOUtils.writeBinary(java.io.File, WriteableBinary)

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
Cache()

Method Summary

Methods

Modifier and Type	Method and Description
static void	clear(Cachable instance) Clear the cache entry for a given cachable object
static <T extends Cachable> void	clear(Class<T> clazz, Object... objects) Clear the cache entry for a given clazz and a set of constructors
static <T> T	load(Class<? extends T> clazz, Object... objects) Create an instance of the clazz for the objects (for the constructor).
static <T> T	load(T instance) load an instance using load(Object, Class, boolean) with class as instance#getClass.
static <T> T	load(T instance, Class<? extends T> clazz, boolean skipcache)
static <T> T	loadSkipCache(Class<? extends T> clazz, Object... objects) Create an instance of the clazz for the objects (for the constructor).
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

Cache

public Cache()

Method Detail

load

public static <T> T load(T instance)

load an instance using load(Object, Class, boolean) with class as instance#getClass. The cache lookup is not skipped.

Type Parameters:

T -

Parameters:

instance -

Returns:

a loaded instance

load

public static <T> T load(Class<? extends T> clazz,
         Object... objects)

Create an instance of the clazz for the objects (for the constructor). If the class creates Cachable instances, an attempt is made to load the instance from the Cache.

Type Parameters:

T - The type of the object returned

Parameters:

clazz - the class which to get a cached instance of

objects - the parameters used to instantiate and index the cached object

Returns:

an instance of the clazz

loadSkipCache

public static <T> T loadSkipCache(Class<? extends T> clazz,
                  Object... objects)

Create an instance of the clazz for the objects (for the constructor). If the class creates Cachable instances, an attempt is made to load the instance from the Cache.

Type Parameters:

T - The type of the object returned

Parameters:

clazz - the class which to get a cached instance of

objects - the parameters used to instantiate and index the cached object

Returns:

an instance of the clazz

clear

public static <T extends Cachable> void clear(Class<T> clazz,
                              Object... objects)

Clear the cache entry for a given clazz and a set of constructors

Type Parameters:

T -

Parameters:

clazz -

objects -

clear

public static void clear(Cachable instance)

Clear the cache entry for a given cachable object

Parameters:

instance -

load

public static <T> T load(T instance,
         Class<? extends T> clazz,
         boolean skipcache)

Type Parameters:

T - The type of the object returned

Parameters:

instance - the instance to attempt to load from the cache if the instance is Cachable

clazz - the class which to get a cached instance of

skipcache - force the cache to be skipped, for a new instance to be returned

Returns:

an instance of the clazz

main

public static void main(String[] args)

Parameters:

args -