to.etc.webapp.ajax.renderer

Class ObjectRenderer

java.lang.Object

to.etc.webapp.ajax.renderer.ObjectRenderer

Direct Known Subclasses:

JSONRenderer, XmlRenderer

public abstract class ObjectRenderer
extends Object

A basic object renderer which traverses an object tree and calls handler methods to render the object's components. This is the base class for the JSON and XML renderers.

Author:

Frits Jalvingh Created on Apr 6, 2006

Constructor Summary

Constructors

Constructor and Description
ObjectRenderer(RenderRegistry r, IndentWriter w)

Method Summary

Modifier and Type	Method and Description
RenderRegistry	getRegistry()
IndentWriter	getWriter()
protected boolean	isKnownObject(Object o)
void	print(byte[] bar)
void	render(Object o) This is the main entrypoint for the renderer.
protected void	renderArrayElement(Object o, Class<?> declaredType, int ix)
void	renderArrayEnd(Object l)
void	renderArrayStart(Object l)
void	renderListEnd(Collection<?> l, String name) Deprecated.
void	renderListStart(Collection<?> l, String name) Deprecated.
void	renderMapEnd(Map<?,?> l)
void	renderMapEntry(Object key, Object value, int itemnr, int maxitemnr)
void	renderMapStart(Map<?,?> l)
protected void	renderObjectAfterItem(int count, Object o, String name, Class<?> declaredType)
protected void	renderObjectBeforeItem(int count, Object o, String name, Class<?> declaredType)
abstract void	renderObjectEnd(Object o)
protected void	renderObjectMember(Object o, String name, Class<?> declaredType)
abstract void	renderObjectStart(Object o)
protected void	renderRoot(Object root)
protected void	renderSub(Object o)

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectRenderer

public ObjectRenderer(RenderRegistry r,
                      IndentWriter w)

Method Detail

getWriter

public final IndentWriter getWriter()

getRegistry

public final RenderRegistry getRegistry()

render

public final void render(Object o)
                  throws Exception

This is the main entrypoint for the renderer. It causes the object passed to be rendered.

Parameters:

o -

Throws:

Exception

renderRoot

protected void renderRoot(Object root)
                   throws Exception

Throws:

Exception

isKnownObject

protected boolean isKnownObject(Object o)

renderSub

protected void renderSub(Object o)
                  throws Exception

Throws:

Exception

print

public void print(byte[] bar)
           throws IOException

Throws:

IOException

renderListStart

@Deprecated
public void renderListStart(Collection<?> l,
                                        String name)
                                 throws Exception

Deprecated.

Throws:

Exception

renderListEnd

@Deprecated
public void renderListEnd(Collection<?> l,
                                      String name)
                               throws Exception

Deprecated.

Throws:

Exception

renderArrayStart

public void renderArrayStart(Object l)
                      throws Exception

Throws:

Exception

renderArrayEnd

public void renderArrayEnd(Object l)
                    throws Exception

Throws:

Exception

renderMapStart

public void renderMapStart(Map<?,?> l)
                    throws Exception

Throws:

Exception

renderMapEnd

public void renderMapEnd(Map<?,?> l)
                  throws Exception

Throws:

Exception

renderMapEntry

public void renderMapEntry(Object key,
                           Object value,
                           int itemnr,
                           int maxitemnr)
                    throws Exception

Throws:

Exception

renderObjectStart

public abstract void renderObjectStart(Object o)
                                throws Exception

Throws:

Exception

renderObjectEnd

public abstract void renderObjectEnd(Object o)
                              throws Exception

Throws:

Exception

renderArrayElement

protected void renderArrayElement(Object o,
                                  Class<?> declaredType,
                                  int ix)
                           throws Exception

Throws:

Exception

renderObjectMember

protected void renderObjectMember(Object o,
                                  String name,
                                  Class<?> declaredType)
                           throws Exception

Throws:

Exception

renderObjectBeforeItem

protected void renderObjectBeforeItem(int count,
                                      Object o,
                                      String name,
                                      Class<?> declaredType)
                               throws Exception

Throws:

Exception

renderObjectAfterItem

protected void renderObjectAfterItem(int count,
                                     Object o,
                                     String name,
                                     Class<?> declaredType)
                              throws Exception

Throws:

Exception