org.apache.commons.monitoring.reporting
Class AbstractRenderer

java.lang.Object
  org.apache.commons.monitoring.reporting.AbstractRenderer

All Implemented Interfaces:

Renderer

Direct Known Subclasses:

FlotRenderer, HtmlRenderer, JsonRenderer, TxtRenderer, XmlRenderer

public abstract class AbstractRenderer
extends java.lang.Object
implements Renderer

Render a collection of monitor for reporting

Author:

Nicolas De Loof

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.commons.monitoring.reporting.Renderer

Renderer.Options

Field Summary

protected static java.lang.String	MONITORS
protected static java.lang.String	ROLES

Fields inherited from interface org.apache.commons.monitoring.reporting.Renderer

DEFAULT_ROLES

Constructor Summary

AbstractRenderer(java.lang.String contentType)

Method Summary

java.lang.String	getContentType()
protected java.util.List<StatValue>	getOrderedStatValues(Monitor monitor, Renderer.Options options)
protected java.util.List<Role>	getRoles(java.util.Collection<Monitor> monitors, Renderer.Options options)
protected void	hasNext(Context ctx, java.lang.Class<?> type)
protected boolean	isDetatched(Monitor monitor)
protected void	prepareRendering(Context ctx, java.util.Collection<Monitor> monitors, Renderer.Options options)
void	render(Context ctx, java.util.Collection<Monitor> monitors, Renderer.Options options)
protected abstract void	render(Context ctx, Monitor.Key key)
protected void	render(Context ctx, Monitor monitor, Renderer.Options options)
protected void	render(Context ctx, Monitor monitor, Renderer.Options options, java.util.List<java.lang.String> roles)
protected void	render(Context ctx, StatValue value, Renderer.Options options)
protected void	render(Context ctx, StatValue value, java.lang.String attribute, java.lang.Number number, Renderer.Options options)
protected void	render(Context ctx, StatValue value, java.lang.String attribute, java.lang.Number number, Renderer.Options options, int ratio) Render a StatValue attribute
protected abstract void	renderDetached(Context ctx, Detachable detached, Renderer.Options options)
protected void	renderMissingValue(Context ctx, Role role) Render an expected value not supported by the current monitor
protected void	renderNaN(Context ctx)
protected void	renderStatValues(Context ctx, Monitor monitor, Renderer.Options options)
protected void	renderStatValues(Context ctx, Monitor monitor, Renderer.Options options, java.util.List<Role> roles)

Methods inherited from class java.lang.Object

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

Field Detail

MONITORS

protected static final java.lang.String MONITORS

See Also:

Constant Field Values

ROLES

protected static final java.lang.String ROLES

See Also:

Constant Field Values

Constructor Detail

AbstractRenderer

public AbstractRenderer(java.lang.String contentType)

Method Detail

render

public void render(Context ctx,
                   java.util.Collection<Monitor> monitors,
                   Renderer.Options options)

Specified by:

render in interface Renderer

prepareRendering

protected void prepareRendering(Context ctx,
                                java.util.Collection<Monitor> monitors,
                                Renderer.Options options)

hasNext

protected void hasNext(Context ctx,
                       java.lang.Class<?> type)

render

protected void render(Context ctx,
                      Monitor monitor,
                      Renderer.Options options,
                      java.util.List<java.lang.String> roles)

render

protected void render(Context ctx,
                      Monitor monitor,
                      Renderer.Options options)

isDetatched

protected boolean isDetatched(Monitor monitor)

renderDetached

protected abstract void renderDetached(Context ctx,
                                       Detachable detached,
                                       Renderer.Options options)

renderStatValues

protected void renderStatValues(Context ctx,
                                Monitor monitor,
                                Renderer.Options options)

renderStatValues

protected void renderStatValues(Context ctx,
                                Monitor monitor,
                                Renderer.Options options,
                                java.util.List<Role> roles)

renderMissingValue

protected void renderMissingValue(Context ctx,
                                  Role role)

Render an expected value not supported by the current monitor

Parameters:

ctx -

role -

getOrderedStatValues

protected java.util.List<StatValue> getOrderedStatValues(Monitor monitor,
                                                         Renderer.Options options)

render

protected void render(Context ctx,
                      StatValue value,
                      Renderer.Options options)

render

protected abstract void render(Context ctx,
                               Monitor.Key key)

render

protected void render(Context ctx,
                      StatValue value,
                      java.lang.String attribute,
                      java.lang.Number number,
                      Renderer.Options options)

render

protected void render(Context ctx,
                      StatValue value,
                      java.lang.String attribute,
                      java.lang.Number number,
                      Renderer.Options options,
                      int ratio)

Render a StatValue attribute

Parameters:

ctx - output

value - the StatValue that hold data to be rendered

attribute - the StatValue attribute name to be rendered

number - the the StatValue attribute value to be rendered

ratio - the ratio between attribute unit and statValue unit (in power of 10)

options - the rendering options

renderNaN

protected void renderNaN(Context ctx)

getRoles

protected java.util.List<Role> getRoles(java.util.Collection<Monitor> monitors,
                                        Renderer.Options options)

Parameters:

monitors -

Returns:

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface Renderer