Package org.restlet.ext.velocity

Class TemplateRepresentation

  • public class TemplateRepresentation
extends org.restlet.representation.WriterRepresentation
    Velocity template representation. Useful for dynamic string-based representations.
    Author:
    Jerome Louvel
    See Also:
    Velocity home page

    • Field Summary

      • Fields inherited from class org.restlet.representation.Representation

        UNKNOWN_SIZE

    • Constructor Summary

      Constructors 
      Constructor Description
      TemplateRepresentation​(java.lang.String templateName, java.util.Map<java.lang.String,​java.lang.Object> dataModel, org.restlet.data.MediaType mediaType)
      Constructor.
      TemplateRepresentation​(java.lang.String templateName, org.restlet.data.MediaType mediaType)
      Constructor.
      TemplateRepresentation​(Template template, java.util.Map<java.lang.String,​java.lang.Object> dataModel, org.restlet.data.MediaType mediaType)
      Constructor.
      TemplateRepresentation​(Template template, org.restlet.data.MediaType mediaType)
      Constructor.
      TemplateRepresentation​(org.restlet.representation.Representation templateRepresentation, java.util.Map<java.lang.String,​java.lang.Object> dataModel, org.restlet.data.MediaType mediaType)
      Constructor based on a Velocity 'encoded' representation.
      TemplateRepresentation​(org.restlet.representation.Representation templateRepresentation, org.restlet.data.MediaType mediaType)
      Constructor based on a Velocity 'encoded' representation.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      VelocityEngine getEngine()
      Returns the Velocity engine.
      Template getTemplate()
      Returns the Velocity template.
      void setDataModel​(java.util.Map<java.lang.String,​java.lang.Object> dataModel)
      Sets the template's data model.
      void setDataModel​(org.restlet.Request request, org.restlet.Response response)
      Sets the template's data model from a request/response pair.
      void setDataModel​(org.restlet.util.Resolver<java.lang.Object> resolver)
      Sets the template's data model from a resolver.
      void write​(java.io.Writer writer)
      Writes the datum as a stream of characters.

      • Methods inherited from class org.restlet.representation.WriterRepresentation

        getReader

      • Methods inherited from class org.restlet.representation.CharacterRepresentation

        getChannel, getStream, write, write

      • Methods inherited from class org.restlet.representation.Representation

        append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getRegistration, getSize, getText, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, release, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient

      • Methods inherited from class org.restlet.representation.RepresentationInfo

        getModificationDate, getTag, setModificationDate, setTag

      • Methods inherited from class org.restlet.representation.Variant

        createClientInfo, equals, getCharacterSet, getEncodings, getLanguages, getLocationRef, getMediaType, hashCode, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • TemplateRepresentation

        public TemplateRepresentation​(org.restlet.representation.Representation templateRepresentation,
                              java.util.Map<java.lang.String,​java.lang.Object> dataModel,
                              org.restlet.data.MediaType mediaType)
                       throws ResourceNotFoundException,
                              ParseErrorException,
                              java.io.IOException
        Constructor based on a Velocity 'encoded' representation.
        Parameters:
        templateRepresentation - The representation to 'decode'.
        dataModel - The Velocity template's data model.
        mediaType - The representation's media type.
        Throws:
        java.io.IOException
        ParseErrorException
        ResourceNotFoundException

      • TemplateRepresentation

        public TemplateRepresentation​(org.restlet.representation.Representation templateRepresentation,
                              org.restlet.data.MediaType mediaType)
                       throws ResourceNotFoundException,
                              ParseErrorException,
                              java.io.IOException
        Constructor based on a Velocity 'encoded' representation.
        Parameters:
        templateRepresentation - The representation to 'decode'.
        mediaType - The representation's media type.
        Throws:
        java.io.IOException
        ParseErrorException
        ResourceNotFoundException

      • TemplateRepresentation

        public TemplateRepresentation​(java.lang.String templateName,
                              java.util.Map<java.lang.String,​java.lang.Object> dataModel,
                              org.restlet.data.MediaType mediaType)
        Constructor.
        Parameters:
        templateName - The Velocity template's name. The actual template is retrieved using the Velocity configuration.
        dataModel - The Velocity template's data model.
        mediaType - The representation's media type.

      • TemplateRepresentation

        public TemplateRepresentation​(java.lang.String templateName,
                              org.restlet.data.MediaType mediaType)
        Constructor.
        Parameters:
        templateName - The Velocity template's name. The full path is resolved by the configuration.
        mediaType - The representation's media type.

      • TemplateRepresentation

        public TemplateRepresentation​(Template template,
                              java.util.Map<java.lang.String,​java.lang.Object> dataModel,
                              org.restlet.data.MediaType mediaType)
        Constructor.
        Parameters:
        template - The Velocity template.
        dataModel - The Velocity template's data model.
        mediaType - The representation's media type.

      • TemplateRepresentation

        public TemplateRepresentation​(Template template,
                              org.restlet.data.MediaType mediaType)
        Constructor.
        Parameters:
        template - The Velocity template.
        mediaType - The representation's media type.

    • Method Detail

      • getEngine

        public VelocityEngine getEngine()
        Returns the Velocity engine.
        Returns:
        The Velocity engine.

      • getTemplate

        public Template getTemplate()
        Returns the Velocity template.
        Returns:
        The Velocity template.

      • setDataModel

        public void setDataModel​(java.util.Map<java.lang.String,​java.lang.Object> dataModel)
        Sets the template's data model.
        Parameters:
        dataModel - The template's data model.

      • setDataModel

        public void setDataModel​(org.restlet.Request request,
                         org.restlet.Response response)
        Sets the template's data model from a request/response pair. This default implementation uses a Resolver.
        Parameters:
        request - The request where data are located.
        response - The response where data are located.
        See Also:
        Resolver, Resolver.createResolver(Request, Response)

      • setDataModel

        public void setDataModel​(org.restlet.util.Resolver<java.lang.Object> resolver)
        Sets the template's data model from a resolver.
        Parameters:
        resolver - The resolver.

      • write

        public void write​(java.io.Writer writer)
           throws java.io.IOException
        Writes the datum as a stream of characters.
        Specified by:
        write in class org.restlet.representation.Representation
        Parameters:
        writer - The writer to use when writing.
        Throws:
        java.io.IOException