org.tmotte.tmplz.load

Class TextLoadMgr

java.lang.Object

org.tmotte.tmplz.load.TextLoadMgr

public class TextLoadMgr
extends java.lang.Object

As per its name, this class manages the process of loading text data from a multitude of possible sources. TextLoadMgr maintains a list of TextLoaderFactory instances and uses the TextLoader provided by the first TextLoaderFactory that returns a non-null TextLoader instance.

Every TemplateManager maintains an internal TextLoadMgr instance.

After a TextLoader is first obtained, TextLoadMgr keeps the TextLoader in HashMap cache for later requests to the same Path.

Constructor Summary

Constructors

Constructor and Description
TextLoadMgr()

Method Summary

Modifier and Type	Method and Description
TextSource	getSource(Path path)
TextLoadMgr	register(TextLoaderFactory factory) This needs to be invoked at least once so that the TextLoadMgr has a factory that can generate TextLoaders to obtain text data.
void	resetCache() Clears the internal Map object that caches TextLoaders.
void	setCache(java.util.Map cache) Allows one to provide a custom Map implementation for the TextLoader cache.
void	unregister(TextLoaderFactory factory) Unregisters the given factory so that it is no longer used to obtain TextLoaders.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextLoadMgr

public TextLoadMgr()

Method Detail

register

public TextLoadMgr register(TextLoaderFactory factory)

This needs to be invoked at least once so that the TextLoadMgr has a factory that can generate TextLoaders to obtain text data. If multiple TextLoaderFactory's are registered, they will be asked in order of registration to provide a suitable TextLoader for a given Path.

Returns:

The same object, for convenience.

unregister

public void unregister(TextLoaderFactory factory)

Unregisters the given factory so that it is no longer used to obtain TextLoaders.

resetCache

public void resetCache()

Clears the internal Map object that caches TextLoaders.

setCache

public void setCache(java.util.Map cache)

Allows one to provide a custom Map implementation for the TextLoader cache.

Parameters:

cache - The new cache.

getSource

public TextSource getSource(Path path)

Returns:

null if no TextLoaderFactory can be found to create the TextLoader.