com.toolsverse.ext.loader

Class Unit<C>

Object

com.toolsverse.ext.loader.Unit<C>

Type Parameters:

C - the generic type. Not necessary implements ExtensionModule but usually does.

Direct Known Subclasses:

AliasReaderUnit, ConnectorUnit, DriverUnit, ImageProcessor, IoProcessorFactory, MetadataUnit

public abstract class Unit<C>
extends Object

All dynamically loaded modules are grouped in Units. The module not necessary implements ExtensionModule but usually does. Unit knows where they are, how to store and configure them, etc. The example is a DriverUnit which knows that ETL drivers belong to the com.toolsverse.etl.driver package and sub packages, should be loaded once, can not be reloaded, etc. The class responsible for actual loading is UnitLoader.

Since:

2.0

Version:

2.0

See Also:

UnitLoader, ExtensionModule

Constructor Summary

Constructors

Constructor and Description
Unit() Instantiates a new Unit using default parameters.
Unit(String classPath, Class<C> objClass, boolean singleton) Instantiates a new Unit.
Unit(String path, String jarPath, String classPath, Class<C> objClass, boolean singleton) Instantiates a new Unit.

Method Summary

Modifier and Type	Method and Description
abstract void	add(String name, Object object) Adds loaded object using name as a key.
abstract void	addWithoutLicense(String name, Object object) Adds loaded object which doesn't have license using name as a key.
abstract boolean	allowLoadAll() Checks if loader allowed to to load all objects regardless of license.
abstract boolean	canBeLoadedAgain() Checks if module can be loaded again.
abstract void	finishLoad(UnitLoader loader) Executed when UnitLoader finishes load.
abstract void	free() Executed when there is a need to free memory.
String	getClassPath() Gets the root class path to the modules.
String	getJarPath() Gets the jar path.
abstract List<C>	getList() Gets the list of loaded modules.
Class<C>	getObjClass() Gets the module class.
String	getPath() Gets the path.
boolean	isSingleton() Checks if module should be a singleton.
abstract boolean	loadsConfigurableExtensions() Returns true if Unit is indented to load configurable extensions.
void	setClassPath(String value) Sets the class path.
void	setJarPath(String value) Sets the jar path.
void	setObjClass(Class<?> value) Sets the module class.
void	setPath(String value) Sets the path.
void	setSingleton(boolean value) Sets the singleton flag.
abstract boolean	startLoad() Executed when UnitLoader starts loading.

Methods inherited from class Object

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

Constructor Detail

Unit

public Unit()

Instantiates a new Unit using default parameters.

Unit

public Unit(String classPath,
            Class<C> objClass,
            boolean singleton)

Instantiates a new Unit.

Parameters:

classPath - the root class path

objClass - the class of object. All loaded modules will be casted to objClass.

singleton - the singleton == true all modules will be loaded as singletons

Unit

public Unit(String path,
            String jarPath,
            String classPath,
            Class<C> objClass,
            boolean singleton)

Instantiates a new Unit.

Parameters:

path - the path. UnitLoader will use it first to load modules.

jarPath - the path the jar path. UnitLoader will use it second path to load modules.

classPath - the root class path

objClass - the class of object. All loaded modules will be casted to objClass.

singleton - if singleton == true all modules will be loaded as singletons

Method Detail

add

public abstract void add(String name,
                         Object object)

Adds loaded object using name as a key.

Parameters:

name - the unique name of the object

object - the object

addWithoutLicense

public abstract void addWithoutLicense(String name,
                                       Object object)

Adds loaded object which doesn't have license using name as a key.

Parameters:

name - the unique name of the object

object - the object

allowLoadAll

public abstract boolean allowLoadAll()

Checks if loader allowed to to load all objects regardless of license.

Returns:

true, if successful

canBeLoadedAgain

public abstract boolean canBeLoadedAgain()

Checks if module can be loaded again.

Returns:

true, if successful

finishLoad

public abstract void finishLoad(UnitLoader loader)

Executed when UnitLoader finishes load.

Parameters:

loader - the UnitLoader

free

public abstract void free()

Executed when there is a need to free memory.

getClassPath

public String getClassPath()

Gets the root class path to the modules.

Returns:

the class path

getJarPath

public String getJarPath()

Gets the jar path.

Returns:

the jar path

getList

public abstract List<C> getList()

Gets the list of loaded modules.

Returns:

the list

getObjClass

public Class<C> getObjClass()

Gets the module class.

Returns:

the module class

getPath

public String getPath()

Gets the path.

Returns:

the path

isSingleton

public boolean isSingleton()

Checks if module should be a singleton.

Returns:

true, if it is a singleton

loadsConfigurableExtensions

public abstract boolean loadsConfigurableExtensions()

Returns true if Unit is indented to load configurable extensions. The configurable extension will have a place in the configuration UI and requires xml configuration file.

Returns:

true, if successful

setClassPath

public void setClassPath(String value)

Sets the class path.

Parameters:

value - the new class path

setJarPath

public void setJarPath(String value)

Sets the jar path.

Parameters:

value - the new jar path

setObjClass

public void setObjClass(Class<?> value)

Sets the module class.

Parameters:

value - the new module class

setPath

public void setPath(String value)

Sets the path.

Parameters:

value - the new path

setSingleton

public void setSingleton(boolean value)

Sets the singleton flag.

Parameters:

value - the new singleton flag

startLoad

public abstract boolean startLoad()

Executed when UnitLoader starts loading. Put initialization code here.

Returns:

true, if supported