Package org.apache.creadur.whisker.app

Class AbstractEngine

java.lang.Object

org.apache.creadur.whisker.app.AbstractEngine

Direct Known Subclasses:

VelocityEngine

public abstract class AbstractEngine
extends Object

A pluggable template.

Constructor Summary

Constructors

Constructor	Description
AbstractEngine()

Method Summary

Modifier and Type	Method	Description
abstract AbstractEngine	generate(Descriptor work, ResultWriterFactory writerFactory, Configuration configuration)	Writes legal documents.
abstract AbstractEngine	report(Collection<Directory> directories, ResultWriterFactory writerFactory, Configuration configuration)	Writes a report describing the directories present.
abstract AbstractEngine	skeleton(Collection<Directory> withBase, ResultWriterFactory writerFactory, Configuration configuration)	Writes templates to help create meta-data.
abstract AbstractEngine	validate(LicenseAnalyst analyst, ResultWriterFactory writerFactory, Configuration configuration)	Reports validations.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEngine

public AbstractEngine()

Method Details

skeleton

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

Writes templates to help create meta-data.

Parameters:

withBase - from this base, not null

writerFactory - not null

configuration - not null

Returns:

this

Throws:

Exception - when creation fails

validate

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

Reports validations.

Parameters:

analyst - not null

writerFactory - not null

configuration - not null

Returns:

not null

Throws:

Exception - when report creation fails

report

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

Writes a report describing the directories present.

Parameters:

directories - not null

writerFactory - not null

configuration - not null

Returns:

this

Throws:

Exception - when report creation fails

generate

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

Writes legal documents.

Parameters:

work - not null

writerFactory - not null

configuration - not null

Returns:

this

Throws:

Exception - when report creation fails