org.apache.clerezza.platform.typerendering

Interface TypeRenderlet

All Known Implementing Classes:

SspTypeRenderlet

public interface TypeRenderlet

A typerenderlet creates a representation of resource described in a graph.

Author:

reto

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TypeRenderlet.RequestProperties A class repressing properties of the rendering request within which the TypeRenderlet is used.

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.MediaType	getMediaType()
String	getModePattern() The renderer may render resources in different modes.
UriRef	getRdfType()
void	render(GraphNode node, GraphNode context, Map<String,Object> sharedRenderingValues, CallbackRenderer callbackRenderer, TypeRenderlet.RequestProperties requestProperties, OutputStream os) Renders a node, possibly considering the context of the rendering request (e.g.

Method Detail

getRdfType

UriRef getRdfType()

Returns:

the rdf type rendered by this renderlet

getModePattern

String getModePattern()

The renderer may render resources in different modes. Such a mode is typically set when a renderlet calls back the renderer to delegate a referenced resource.

Returns:

a regex the mode must match

getMediaType

javax.ws.rs.core.MediaType getMediaType()

Returns:

the Media Type pattern this TypeRenderlet supports

render

void render(GraphNode node,
          GraphNode context,
          Map<String,Object> sharedRenderingValues,
          CallbackRenderer callbackRenderer,
          TypeRenderlet.RequestProperties requestProperties,
          OutputStream os)
            throws IOException

Renders a node, possibly considering the context of the rendering request (e.g. for which user the resource is rendered for) to a stream.

Parameters:

node - RDF resource to be rendered with the template.

context - RDF resource providing a rendering context, typically this contains a description of the user for which the resource is to be rendered

sharedRenderingValues - a map that can be used for sharing values across the different Renderlets involved in a rendering process

callbackRenderer - renderer for call backs.

requestProperties - properties of this rendering request

os - where the output will be written to.

Throws:

IOException