com.vladium.emma

类 Processor

java.lang.Object

com.vladium.emma.Processor

直接已知子类:

CtlProcessor, InstrProcessor, MergeProcessor, ReportProcessor, RunProcessor

public abstract class Processor
extends java.lang.Object

A Processor is a bean-like object that encapsulates the core functionality of a "tool" in our tool set. All our command line tools and ANT tasks are mere front-end shells that accept user input before passing it on to an instance of some core processor. Processors are designed for programmatic integration with new/external tools.

Processor lifecycle model is as follows:

1. an instance is acquired using create() factory method specific to each concrete Processor class;
2. the instance is configured using various set*() methods. Note that Processor attributes vary regarding whether they are required or optional (have defaults);
3. the instance is executed via run().

A Processor instance is re-run()able (note that all state set via set set*() methods is retained through each run).

MT-safety: a Processor instance is safe for concurrent access from multiple concurrent threads (all public Processor methods are synchronized).

作者:

Vlad Roubtsov, (C) 2004

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	m_appName
protected Logger	m_log
protected IProperties	m_propertyOverrides

构造器概要

构造器

限定符	构造器和说明
protected	Processor()

方法概要

限定符和类型	方法和说明
protected abstract void	_run(IProperties toolProperties) This method is implemented by each concrete Processor class to perform tool-specific processing.
void	run() Executes this Processor's unit of work as the following sequence: calls validateState() to ensure all required attributes have been set; creates Processor-specific properties by combining app-global properties with property overrides for this Processor instance; pushes a new Logger on the thread-local stack and sets it as m_log field; calls _run(IProperties) with Processor-specific properties; pops the thread-local Logger stack and clears m_log.
void	setAppName(java.lang.String appName) Each processor traces its execution via logging calls to m_log.
void	setPropertyOverrides(IProperties overrides) Adds optional property overrides for this Processor instance.
void	setPropertyOverrides(java.util.Properties overrides) Adds optional property overrides for this Processor instance.
protected void	validateState() Validates attribute settings before each _run(IProperties).

从类继承的方法 java.lang.Object

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

字段详细资料

m_appName

protected java.lang.String m_appName

m_propertyOverrides

protected IProperties m_propertyOverrides

m_log

protected Logger m_log

构造器详细资料

Processor

protected Processor()

方法详细资料

run

public void run()

Executes this Processor's unit of work as the following sequence:

1. calls validateState() to ensure all required attributes have been set;
2. creates Processor-specific properties by combining app-global properties with property overrides for this Processor instance;
3. pushes a new Logger on the thread-local stack and sets it as m_log field;
4. calls _run(IProperties) with Processor-specific properties;
5. pops the thread-local Logger stack and clears m_log.

setAppName

public final void setAppName(java.lang.String appName)

Each processor traces its execution via logging calls to m_log. Trace output is prefixed with a string that can be customized via this setter.

参数:

appName - [null means no prefix in tracing]

setPropertyOverrides

public final void setPropertyOverrides(java.util.Properties overrides)

Adds optional property overrides for this Processor instance.

参数:

overrides - [may be null (unsets the previous overrides)]

setPropertyOverrides

public final void setPropertyOverrides(IProperties overrides)

Adds optional property overrides for this Processor instance. This method accepts our custom IProperties class and is used by stock tools. External tool integration can use setPropertyOverrides(Properties), which provides equivalent functionality.

参数:

overrides - [may be null (unsets the previous overrides)]

_run

protected abstract void _run(IProperties toolProperties)

This method is implemented by each concrete Processor class to perform tool-specific processing.

参数:

toolProperties - properties incorporating app-global setting and overrides set optionally via setPropertyOverrides(Properties) or setPropertyOverrides(IProperties) [never null]

validateState

protected void validateState()

Validates attribute settings before each _run(IProperties).

Overridden implementations should chain to super.validateState().

抛出:

java.lang.IllegalStateException - on invalid settings state (e.g., missing settings for required attributes)