org.restlet.ext.velocity
Class TemplateRepresentation

java.lang.Object
  extended by org.restlet.resource.Variant
      extended by org.restlet.resource.Representation
          extended by org.restlet.resource.StreamRepresentation
              extended by org.restlet.resource.OutputRepresentation
                  extended by org.restlet.ext.velocity.TemplateRepresentation

public class TemplateRepresentation
extends OutputRepresentation

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.resource.Representation
UNKNOWN_SIZE
 
Constructor Summary
TemplateRepresentation(Representation templateRepresentation, java.util.Map<java.lang.String,java.lang.Object> dataModel, MediaType mediaType)
          Constructor based on a Velocity 'encoded' representation.
TemplateRepresentation(Representation templateRepresentation, MediaType mediaType)
          Constructor based on a Velocity 'encoded' representation.
TemplateRepresentation(java.lang.String templateName, java.util.Map<java.lang.String,java.lang.Object> dataModel, MediaType mediaType)
          Constructor.
TemplateRepresentation(java.lang.String templateName, MediaType mediaType)
          Constructor.
TemplateRepresentation(org.apache.velocity.Template template, java.util.Map<java.lang.String,java.lang.Object> dataModel, MediaType mediaType)
          Constructor.
TemplateRepresentation(org.apache.velocity.Template template, MediaType mediaType)
          Constructor.
 
Method Summary
 org.apache.velocity.app.VelocityEngine getEngine()
          Returns the Velocity engine.
 org.apache.velocity.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(Request request, Response response)
          Sets the template's data model from a request/response pair.
 void setDataModel(Resolver<java.lang.Object> resolver)
          Sets the template's data model from a resolver.
 void write(java.io.OutputStream outputStream)
          Writes the datum as a stream of bytes.
 
Methods inherited from class org.restlet.resource.OutputRepresentation
getStream, release
 
Methods inherited from class org.restlet.resource.StreamRepresentation
getChannel, getReader, write, write
 
Methods inherited from class org.restlet.resource.Representation
checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDownloadName, getExpirationDate, getModificationDate, getRange, getSize, getTag, getText, isAvailable, isDownloadable, isTransient, setAvailable, setDigest, setDownloadable, setDownloadName, setExpirationDate, setModificationDate, setRange, setSize, setTag, setTransient
 
Methods inherited from class org.restlet.resource.Variant
getCharacterSet, getEncodings, getIdentifier, getLanguages, getMediaType, setCharacterSet, setEncodings, setIdentifier, setIdentifier, setLanguages, setMediaType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TemplateRepresentation

public TemplateRepresentation(Representation templateRepresentation,
                              java.util.Map<java.lang.String,java.lang.Object> dataModel,
                              MediaType mediaType)
                       throws org.apache.velocity.exception.ResourceNotFoundException,
                              org.apache.velocity.exception.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
org.apache.velocity.exception.ParseErrorException
org.apache.velocity.exception.ResourceNotFoundException

TemplateRepresentation

public TemplateRepresentation(Representation templateRepresentation,
                              MediaType mediaType)
                       throws org.apache.velocity.exception.ResourceNotFoundException,
                              org.apache.velocity.exception.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
org.apache.velocity.exception.ParseErrorException
org.apache.velocity.exception.ResourceNotFoundException

TemplateRepresentation

public TemplateRepresentation(java.lang.String templateName,
                              java.util.Map<java.lang.String,java.lang.Object> dataModel,
                              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,
                              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(org.apache.velocity.Template template,
                              java.util.Map<java.lang.String,java.lang.Object> dataModel,
                              MediaType mediaType)
Constructor.

Parameters:
template - The Velocity template.
dataModel - The Velocity template's data model.
mediaType - The representation's media type.

TemplateRepresentation

public TemplateRepresentation(org.apache.velocity.Template template,
                              MediaType mediaType)
Constructor.

Parameters:
template - The Velocity template.
mediaType - The representation's media type.
Method Detail

getEngine

public org.apache.velocity.app.VelocityEngine getEngine()
Returns the Velocity engine.

Returns:
The Velocity engine.

getTemplate

public org.apache.velocity.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(Request request,
                         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(Resolver<java.lang.Object> resolver)
Sets the template's data model from a resolver.

Parameters:
resolver - The resolver.

write

public void write(java.io.OutputStream outputStream)
           throws java.io.IOException
Writes the datum as a stream of bytes.

Specified by:
write in class Representation
Parameters:
outputStream - The stream to use when writing.
Throws:
java.io.IOException


Copyright © 2005-2008 Noelios Technologies.