Package net.ssehub.easy.instantiation.core.model.execution

Class TracerFactory

java.lang.Object

net.ssehub.easy.instantiation.core.model.execution.TracerFactory

Direct Known Subclasses:

ConsoleTracerFactory, GuiTracerFactory, TracerFactory.DefaultTracerFactory

public abstract class TracerFactory
extends java.lang.Object

A factory for the VIL language execution tracers. Basically, default tracer factory (getDefaultInstance()) is static and initialized with DEFAULT. However, as VIL can be executed in multiple threads in parallel, this factory can also be used on a per-thread basis (getInstance().

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TracerFactory.DefaultTracerFactory	The default tracer factory returning tracer instances which do not trace anything (NoTracer).
private static class	TracerFactory.TaskData	Stores information about the current task of a progress observer.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Map<java.lang.Thread,ITracer>	BUILDLANG_TRACERS
static TracerFactory	DEFAULT	Defines the default tracer.
private static TracerFactory	defaultFactory
static IInstantiatorTracer	EMPTY_INSTANTIATOR_TRACER
private static java.util.Map<java.lang.Long,TracerFactory>	instances
static java.util.Map<ProgressObserver,TracerFactory.TaskData>	PROGRESS_OBSERVERS
static java.util.Map<java.lang.Thread,ITracer>	TEMPLATELANG_TRACERS

Constructor Summary

Constructors

Constructor	Description
TracerFactory()

Method Summary

Modifier and Type	Method	Description
static ITracer	createBuildLanguageTracer()	Creates a tracer for the VIL build language.
abstract ITracer	createBuildLanguageTracerImpl()	Creates a tracer for the VIL build language.
static IInstantiatorTracer	createInstantiatorTracer()	Creates a tracer for instantiators.
abstract IInstantiatorTracer	createInstantiatorTracerImpl()	Creates a tracer for instantiators, i.e., to send messages to the VIL output.
static ITracer	createTemplateLanguageTracer()	Creates a tracer for the VIL template language.
abstract ITracer	createTemplateLanguageTracerImpl()	Creates a tracer for the VIL template language.
static TracerFactory	getDefaultInstance()	Returns the default instance.
static TracerFactory	getInstance()	Returns the tracer factory for the current thread.
static ITracer	getRegisteredBuildLanguageTracer()	Returns the currently registered build language tracer for the current thread.
static ITracer	getRegisteredTemplateLanguageTracer()	Returns the currently registered template language tracer for the current thread.
static void	progress(int actual, int max, java.lang.String description)	Notifies the tracer about the actual progress in order to inform the user.
static void	registerBuildLanguageTracer(ITracer tracer)	Registers a build language tracer along with the current thread.
static void	registerProgressObserver(ProgressObserver observer)	Registers the given progress reserver.
static void	registerTemplateLanguageTracer(ITracer tracer)	Registers a template language tracer along with the current thread.
static void	setDefaultInstance(TracerFactory factory)	Defines the default instance.
static void	setInstance(TracerFactory newInstance)	Defines a new tracer factory for the current thread.
static void	unregisterBuildLanguageTracer(ITracer tracer)	Unregisters a build language tracer from the current thread.
static void	unregisterProgressObserver(ProgressObserver observer)	Unregisters the given progress observer.
static void	unregisterTemplateLanguageTracer(ITracer tracer)	Unregisters a template language tracer from the current thread.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final TracerFactory DEFAULT

Defines the default tracer.

TEMPLATELANG_TRACERS

public static final java.util.Map<java.lang.Thread,ITracer> TEMPLATELANG_TRACERS

BUILDLANG_TRACERS

public static final java.util.Map<java.lang.Thread,ITracer> BUILDLANG_TRACERS

PROGRESS_OBSERVERS

public static final java.util.Map<ProgressObserver,TracerFactory.TaskData> PROGRESS_OBSERVERS

EMPTY_INSTANTIATOR_TRACER

public static final IInstantiatorTracer EMPTY_INSTANTIATOR_TRACER

defaultFactory

private static TracerFactory defaultFactory

instances

private static java.util.Map<java.lang.Long,TracerFactory> instances

Constructor Detail

TracerFactory

public TracerFactory()

Method Detail

getDefaultInstance

public static TracerFactory getDefaultInstance()

Returns the default instance.

Returns:

the default instance

setDefaultInstance

public static void setDefaultInstance(TracerFactory factory)

Defines the default instance.

Parameters:

factory - the new default instance (ignored if null)

setInstance

public static void setInstance(TracerFactory newInstance)

Defines a new tracer factory for the current thread.

Parameters:

newInstance - the new tracer factory (null deletes a previously defined instance)

getInstance

public static TracerFactory getInstance()

Returns the tracer factory for the current thread.

Returns:

the current tracer factory, if there is none defined return defaultFactory

createTemplateLanguageTracerImpl

public abstract ITracer createTemplateLanguageTracerImpl()

Creates a tracer for the VIL template language.

Returns:

a tracer instance for the VIL template language (null will lead to the corresponding result by DEFAULT)

createBuildLanguageTracerImpl

public abstract ITracer createBuildLanguageTracerImpl()

Creates a tracer for the VIL build language.

Returns:

a tracer instance for the VIL build language (null will lead to the corresponding result by DEFAULT)

createInstantiatorTracerImpl

public abstract IInstantiatorTracer createInstantiatorTracerImpl()

Creates a tracer for instantiators, i.e., to send messages to the VIL output.

Returns:

the instantiator tracer

createTemplateLanguageTracer

public static ITracer createTemplateLanguageTracer()

Creates a tracer for the VIL template language.

Returns:

a tracer instance for the VIL template language

createBuildLanguageTracer

public static ITracer createBuildLanguageTracer()

Creates a tracer for the VIL build language.

Returns:

a tracer instance for the VIL build language

createInstantiatorTracer

public static IInstantiatorTracer createInstantiatorTracer()

Creates a tracer for instantiators.

Returns:

a tracer for instantiators

registerBuildLanguageTracer

public static void registerBuildLanguageTracer(ITracer tracer)

Registers a build language tracer along with the current thread.

Parameters:

tracer - the tracer, ignored if null

See Also:

unregisterBuildLanguageTracer(net.ssehub.easy.instantiation.core.model.buildlangModel.ITracer)

unregisterBuildLanguageTracer

public static void unregisterBuildLanguageTracer(ITracer tracer)

Unregisters a build language tracer from the current thread.

Parameters:

tracer - the tracer, ignored if null

See Also:

registerBuildLanguageTracer(net.ssehub.easy.instantiation.core.model.buildlangModel.ITracer)

getRegisteredBuildLanguageTracer

public static ITracer getRegisteredBuildLanguageTracer()

Returns the currently registered build language tracer for the current thread.

Returns:

the currently registered build language tracer or null if there is none

registerTemplateLanguageTracer

public static void registerTemplateLanguageTracer(ITracer tracer)

Registers a template language tracer along with the current thread.

Parameters:

tracer - the tracer, ignored if null

See Also:

unregisterTemplateLanguageTracer(net.ssehub.easy.instantiation.core.model.templateModel.ITracer)

unregisterTemplateLanguageTracer

public static void unregisterTemplateLanguageTracer(ITracer tracer)

Unregisters a template language tracer from the current thread.

Parameters:

tracer - the tracer, ignored if null

See Also:

registerTemplateLanguageTracer(net.ssehub.easy.instantiation.core.model.templateModel.ITracer)

getRegisteredTemplateLanguageTracer

public static ITracer getRegisteredTemplateLanguageTracer()

Returns the currently registered template language tracer for the current thread.

Returns:

the currently registered template language tracer or null if there is none

progress

public static void progress(int actual,
                            int max,
                            java.lang.String description)

Notifies the tracer about the actual progress in order to inform the user.

Parameters:

actual - the actual step (negative disables display)

max - the maximum number of steps (may vary over time, negative disables display)

description - an optional description of the step (may be null)

registerProgressObserver

public static void registerProgressObserver(ProgressObserver observer)

Registers the given progress reserver.

Parameters:

observer - the observer (ignored if null)

unregisterProgressObserver

public static void unregisterProgressObserver(ProgressObserver observer)

Unregisters the given progress observer.

Parameters:

observer - the progress observer (ignored if null)