Package org.alfresco.service.cmr.repository

Interface TemplateProcessor

  • All Superinterfaces:
    org.alfresco.processor.Processor
    All Known Implementing Classes:
    FreeMarkerProcessor, XSLTProcessor
    public interface TemplateProcessor
extends org.alfresco.processor.Processor
    Interface to be implemented by template engine wrapper classes. The developer is responsible for interfacing to an appropriate template engine, using the supplied data model as input to the template and directing the output to the Writer stream.
    Author:
    Kevin Roast

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void process​(java.lang.String template, java.lang.Object model, java.io.Writer out)
      Process a template against the supplied data model and write to the out.
      void process​(java.lang.String template, java.lang.Object model, java.io.Writer out, java.util.Locale locale)
      Process a template in the given locale against the supplied data model and write to the out.
      void processString​(java.lang.String template, java.lang.Object model, java.io.Writer out)
      Process a string template against the supplied data model and write to the out.

      • Methods inherited from interface org.alfresco.processor.Processor

        getExtension, getName, registerProcessorExtension

    • Method Detail

      • process

        void process​(java.lang.String template,
             java.lang.Object model,
             java.io.Writer out)
        Process a template against the supplied data model and write to the out.
        Parameters:
        template - Template name/path
        model - Object model to process template against
        out - Writer object to send output too

      • process

        void process​(java.lang.String template,
             java.lang.Object model,
             java.io.Writer out,
             java.util.Locale locale)
        Process a template in the given locale against the supplied data model and write to the out.
        Parameters:
        template - Template name/path
        model - Object model to process template against
        out - Writer object to send output too
        locale - The Locale to process the template in

      • processString

        void processString​(java.lang.String template,
                   java.lang.Object model,
                   java.io.Writer out)
        Process a string template against the supplied data model and write to the out.
        Parameters:
        template - Template string
        model - Object model to process template against
        out - Writer object to send output too