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 org.apache.creadur.whisker.app.AbstractEngine
Uses Apache Velocity to implement AbstractEngine.
See Also:

  • 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 org.apache.creadur.whisker.app.AbstractEngine
    generate(org.apache.creadur.whisker.model.Descriptor work, org.apache.creadur.whisker.app.ResultWriterFactory writerFactory, org.apache.creadur.whisker.app.Configuration configuration)
    Generates documents, and writes results using given factory.
    final org.apache.creadur.whisker.app.AbstractEngine
    report(Collection<org.apache.creadur.whisker.scan.Directory> directories, org.apache.creadur.whisker.app.ResultWriterFactory writerFactory, org.apache.creadur.whisker.app.Configuration configuration)
    Generates a directories report, and writes result using given factory.
    final org.apache.creadur.whisker.app.AbstractEngine
    skeleton(Collection<org.apache.creadur.whisker.scan.Directory> withBase, org.apache.creadur.whisker.app.ResultWriterFactory writerFactory, org.apache.creadur.whisker.app.Configuration configuration)
    Generates a template, and writes result using given factory.
    final org.apache.creadur.whisker.app.AbstractEngine
    validate(org.apache.creadur.whisker.app.analysis.LicenseAnalyst analyst, org.apache.creadur.whisker.app.ResultWriterFactory writerFactory, org.apache.creadur.whisker.app.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 org.apache.creadur.whisker.app.AbstractEngine skeleton(Collection<org.apache.creadur.whisker.scan.Directory> withBase, org.apache.creadur.whisker.app.ResultWriterFactory writerFactory, org.apache.creadur.whisker.app.Configuration configuration) throws Exception
      Generates a template, and writes result using given factory.
      Specified by:
      skeleton in class org.apache.creadur.whisker.app.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 org.apache.creadur.whisker.app.AbstractEngine validate(org.apache.creadur.whisker.app.analysis.LicenseAnalyst analyst, org.apache.creadur.whisker.app.ResultWriterFactory writerFactory, org.apache.creadur.whisker.app.Configuration configuration) throws Exception
      Generates a validation report, and writes result using given factory.
      Specified by:
      validate in class org.apache.creadur.whisker.app.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 org.apache.creadur.whisker.app.AbstractEngine report(Collection<org.apache.creadur.whisker.scan.Directory> directories, org.apache.creadur.whisker.app.ResultWriterFactory writerFactory, org.apache.creadur.whisker.app.Configuration configuration) throws Exception
      Generates a directories report, and writes result using given factory.
      Specified by:
      report in class org.apache.creadur.whisker.app.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 org.apache.creadur.whisker.app.AbstractEngine generate(org.apache.creadur.whisker.model.Descriptor work, org.apache.creadur.whisker.app.ResultWriterFactory writerFactory, org.apache.creadur.whisker.app.Configuration configuration) throws Exception
      Generates documents, and writes results using given factory.
      Specified by:
      generate in class org.apache.creadur.whisker.app.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)