io.neba.core.rendering

Class BeanRendererImpl

java.lang.Object

io.neba.core.rendering.BeanRendererImpl

All Implemented Interfaces:

io.neba.api.rendering.BeanRenderer

public class BeanRendererImpl
extends Object
implements io.neba.api.rendering.BeanRenderer

Renders an object using the provided view repository path, the object's class hierarchy and a provided viewHint to build possible template names for the object. Supports adding additional elements to the rendering context.

Example: For a class io.neba.MyModel implementing the interface io.neba.MyInterface, the renderer will attempt to resolve the following templates (in this particular order according to the ClassHierarchyIterator), if the repositoryPath is "/apps/views/" and the view hint is null:

1. /apps/views/io/neba/MyModel.vlt
2. /apps/views/io/neba/MyInterface.vlt
3. /java/lang/Object.vlt

The first view found is used to render the object.

Likewise, when rendering with a viewhint, e.g. "teaser", the following views would be resolved:

1. /apps/views/io/neba/MyModel-teaser.vlt
2. /apps/views/io/neba/MyInterface-teaser.vlt
3. /java/lang/Object-teaser.vlt

TODO: Performance optimization: Caching of failed lookups and hierarchy iteration.

Author:

Olaf Otto

Constructor Summary

Constructors

Constructor and Description
BeanRendererImpl(String repositoryPath, org.apache.velocity.app.VelocityEngine engine, List<org.apache.sling.scripting.api.BindingsValuesProvider> bindingsValuesProviders)

Method Summary

Methods

Modifier and Type	Method and Description
String	createTemplateName(String viewHint, Class<?> type)
String	render(Object bean)
String	render(Object bean, Map<String,Object> context)
String	render(Object bean, String viewHint)
String	render(Object bean, String viewHint, Map<String,Object> additionalContextElements)
String	renderInternal(Object object, String templatePath, Map<String,Object> additionalContextElements)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BeanRendererImpl

public BeanRendererImpl(String repositoryPath,
                org.apache.velocity.app.VelocityEngine engine,
                List<org.apache.sling.scripting.api.BindingsValuesProvider> bindingsValuesProviders)

Method Detail

render

public String render(Object bean,
            String viewHint,
            Map<String,Object> additionalContextElements)

Specified by:

render in interface io.neba.api.rendering.BeanRenderer

renderInternal

public String renderInternal(Object object,
                    String templatePath,
                    Map<String,Object> additionalContextElements)

createTemplateName

public String createTemplateName(String viewHint,
                        Class<?> type)

render

public String render(Object bean)

Specified by:

render in interface io.neba.api.rendering.BeanRenderer

render

public String render(Object bean,
            Map<String,Object> context)

Specified by:

render in interface io.neba.api.rendering.BeanRenderer

render

public String render(Object bean,
            String viewHint)

Specified by:

render in interface io.neba.api.rendering.BeanRenderer