org.apache.creadur.whisker.out.velocity

Class VelocityReports

java.lang.Object

org.apache.creadur.whisker.out.velocity.VelocityReports

All Implemented Interfaces:

org.apache.velocity.runtime.log.LogChute

public class VelocityReports
extends Object
implements org.apache.velocity.runtime.log.LogChute

Wraps velocity engine.

Field Summary

Fields inherited from interface org.apache.velocity.runtime.log.LogChute

DEBUG_ID, DEBUG_PREFIX, ERROR_ID, ERROR_PREFIX, INFO_ID, INFO_PREFIX, TRACE_ID, TRACE_PREFIX, WARN_ID, WARN_PREFIX

Constructor Summary

Constructors

Constructor and Description
VelocityReports(ResultWriterFactory writerFactory, org.apache.commons.logging.Log log) Constructs a reporter using Apache Velocity.

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(Descriptor work, Configuration configuration) Reports on work.
void	generateTemplate(Collection<Directory> withBase) Generates template.
void	init(org.apache.velocity.runtime.RuntimeServices services) Unused.
boolean	isLevelEnabled(int level) Indicates whether logging is enabled.
void	log(int level, String message) Logs a message.
void	log(int level, String message, Throwable throwable) Logs a message from Velocity.
void	report(Collection<Directory> directories) Generates a directory report.
void	validate(LicenseAnalyst analyst) Reports on analysis.

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityReports

public VelocityReports(ResultWriterFactory writerFactory,
               org.apache.commons.logging.Log log)

Constructs a reporter using Apache Velocity.

Parameters:

writerFactory - not null

log - not null

Method Detail

init

public final void init(org.apache.velocity.runtime.RuntimeServices services)

Unused.

Specified by:

init in interface org.apache.velocity.runtime.log.LogChute

Parameters:

services - unused

See Also:

LogChute.init(RuntimeServices)

isLevelEnabled

public final boolean isLevelEnabled(int level)

Indicates whether logging is enabled.

Specified by:

isLevelEnabled in interface org.apache.velocity.runtime.log.LogChute

Parameters:

level - at this level

Returns:

true when log level is enabled, false otherwise

See Also:

LogChute.isLevelEnabled(int)

log

public final void log(int level,
       String message)

Logs a message.

Specified by:

log in interface org.apache.velocity.runtime.log.LogChute

Parameters:

level - at level

message - possibly null

See Also:

LogChute.log(int, String)

log

public final void log(int level,
       String message,
       Throwable throwable)

Logs a message from Velocity.

Specified by:

log in interface org.apache.velocity.runtime.log.LogChute

Parameters:

level - log level

message - possibly null

throwable - possibly null

See Also:

LogChute.log(int, String, Throwable)

generate

public final void generate(Descriptor work,
            Configuration configuration)
                    throws Exception

Reports on work.

Parameters:

work - not null

configuration - not null

Throws:

Exception - when generation fails

report

public final void report(Collection<Directory> directories)
                  throws Exception

Generates a directory report.

Parameters:

directories - not null

Throws:

Exception - when reporting fails

validate

public final void validate(LicenseAnalyst analyst)
                    throws Exception

Reports on analysis.

Parameters:

analyst - not null

Throws:

Exception - when validation fails

generateTemplate

public final void generateTemplate(Collection<Directory> withBase)
                            throws Exception

Generates template.

Parameters:

withBase - not null

Throws:

Exception - when generation fails