Package org.apache.creadur.whisker.out.velocity

Class VelocityEngine

java.lang.Object

org.apache.creadur.whisker.app.AbstractEngine

org.apache.creadur.whisker.out.velocity.VelocityEngine

public class VelocityEngine
extends AbstractEngine

Uses Apache Velocity to implement AbstractEngine.

See Also:

• Apache Velocity

Constructor Summary

Constructors

Constructor	Description
VelocityEngine(org.apache.commons.logging.Log log)	Constructs an engine running on Apache Velocity.

Method Summary

Modifier and Type	Method	Description
final AbstractEngine	generate(Descriptor work, ResultWriterFactory writerFactory, Configuration configuration)	Generates documents, and writes results using given factory.
final AbstractEngine	report(Collection<Directory> directories, ResultWriterFactory writerFactory, Configuration configuration)	Generates a directories report, and writes result using given factory.
final AbstractEngine	skeleton(Collection<Directory> withBase, ResultWriterFactory writerFactory, Configuration configuration)	Generates a template, and writes result using given factory.
final AbstractEngine	validate(LicenseAnalyst analyst, ResultWriterFactory writerFactory, Configuration configuration)	Generates a validation report, and writes result using given factory.

Methods inherited from class java.lang.Object

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

Constructor Details

VelocityEngine

public VelocityEngine(org.apache.commons.logging.Log log)

Constructs an engine running on Apache Velocity.

Parameters:

log - not null

Method Details

skeleton

public final AbstractEngine skeleton(Collection<Directory> withBase,
 ResultWriterFactory writerFactory,
 Configuration configuration)
                              throws Exception

Generates a template, and writes result using given factory.

Specified by:

skeleton in class AbstractEngine

Parameters:

withBase - not null

writerFactory - not null

configuration - not null

Returns:

this engine, not null

Throws:

Exception - when generation fails

See Also:

• AbstractEngine.skeleton(Collection, ResultWriterFactory, Configuration)

validate

public final AbstractEngine validate(LicenseAnalyst analyst,
 ResultWriterFactory writerFactory,
 Configuration configuration)
                              throws Exception

Generates a validation report, and writes result using given factory.

Specified by:

validate in class AbstractEngine

Parameters:

analyst - not null

writerFactory - not null

configuration - not null

Returns:

this, not null

Throws:

Exception - when validation fails

See Also:

• AbstractEngine.validate(LicenseAnalyst, ResultWriterFactory, Configuration)

report

public final AbstractEngine report(Collection<Directory> directories,
 ResultWriterFactory writerFactory,
 Configuration configuration)
                            throws Exception

Generates a directories report, and writes result using given factory.

Specified by:

report in class AbstractEngine

Parameters:

directories - not null

writerFactory - not null

configuration - not null

Returns:

this, not null

Throws:

Exception - when reporting fails

See Also:

• AbstractEngine.report(java.util.Collection, ResultWriterFactory, Configuration)

generate

public final AbstractEngine generate(Descriptor work,
 ResultWriterFactory writerFactory,
 Configuration configuration)
                              throws Exception

Generates documents, and writes results using given factory.

Specified by:

generate in class AbstractEngine

Parameters:

work - not null

writerFactory - not null

configuration - not null

Returns:

this, not null

Throws:

Exception - when generation fails.

See Also:

• AbstractEngine.generate(Descriptor, ResultWriterFactory, Configuration)