org.restlet.ext.freemarker
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.freemarker.TemplateRepresentation

public class TemplateRepresentation
extends OutputRepresentation

FreeMarker template representation. Useful for dynamic string-based representations.

Author:
Jerome Louvel
See Also:
FreeMarker home page

Field Summary
 
Fields inherited from class org.restlet.resource.Representation
UNKNOWN_SIZE
 
Constructor Summary
TemplateRepresentation(Representation templateRepresentation, Configuration config, MediaType mediaType)
          Constructor.
TemplateRepresentation(Representation templateRepresentation, Configuration config, java.lang.Object dataModel, MediaType mediaType)
          Constructor.
TemplateRepresentation(java.lang.String templateName, Configuration config, MediaType mediaType)
          Constructor.
TemplateRepresentation(java.lang.String templateName, Configuration config, java.lang.Object dataModel, MediaType mediaType)
          Constructor.
TemplateRepresentation(Template template, MediaType mediaType)
          Constructor.
TemplateRepresentation(Template template, java.lang.Object dataModel, MediaType mediaType)
          Constructor.
 
Method Summary
 java.lang.Object getDataModel()
          Returns the template's data model.
 java.lang.Object setDataModel(java.lang.Object dataModel)
          Sets the template's data model.
 java.lang.Object setDataModel(Request request, Response response)
          Sets the template's data model from a request/response pair.
 java.lang.Object 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,
                              Configuration config,
                              MediaType mediaType)
Constructor.

Parameters:
templateRepresentation - The FreeMarker template provided via a representation.
config - The FreeMarker configuration.
mediaType - The representation's media type.

TemplateRepresentation

public TemplateRepresentation(Representation templateRepresentation,
                              Configuration config,
                              java.lang.Object dataModel,
                              MediaType mediaType)
Constructor.

Parameters:
templateRepresentation - The FreeMarker template provided via a representation.
config - The FreeMarker configuration.
dataModel - The template's data model.
mediaType - The representation's media type.

TemplateRepresentation

public TemplateRepresentation(java.lang.String templateName,
                              Configuration config,
                              MediaType mediaType)
Constructor.

Parameters:
templateName - The FreeMarker template's name. The full path is resolved by the configuration.
config - The FreeMarker configuration.
mediaType - The representation's media type.

TemplateRepresentation

public TemplateRepresentation(java.lang.String templateName,
                              Configuration config,
                              java.lang.Object dataModel,
                              MediaType mediaType)
Constructor.

Parameters:
templateName - The FreeMarker template's name. The full path is resolved by the configuration.
config - The FreeMarker configuration.
dataModel - The template's data model.
mediaType - The representation's media type.

TemplateRepresentation

public TemplateRepresentation(Template template,
                              MediaType mediaType)
Constructor.

Parameters:
template - The FreeMarker template.
mediaType - The representation's media type.

TemplateRepresentation

public TemplateRepresentation(Template template,
                              java.lang.Object dataModel,
                              MediaType mediaType)
Constructor.

Parameters:
template - The FreeMarker template.
dataModel - The template's data model.
mediaType - The representation's media type.
Method Detail

getDataModel

public java.lang.Object getDataModel()
Returns the template's data model.

Returns:
The template's data model.

setDataModel

public java.lang.Object setDataModel(java.lang.Object dataModel)
Sets the template's data model.

Parameters:
dataModel - The template's data model.
Returns:
The template's data model.

setDataModel

public java.lang.Object 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.
Returns:
The template's data model.
See Also:
Resolver, Resolver.createResolver(Request, Response)

setDataModel

public java.lang.Object setDataModel(Resolver<java.lang.Object> resolver)
Sets the template's data model from a resolver.

Parameters:
resolver - The resolver.
Returns:
The template's data model.

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.