org.javasimon.console.action

Class DetailPlugin

java.lang.Object

org.javasimon.console.SimonConsolePlugin

org.javasimon.console.action.DetailPlugin

Direct Known Subclasses:

CallTreeDetailPlugin, QuantilesDetailPlugin, TimelineDetailPlugin

public abstract class DetailPlugin
extends SimonConsolePlugin

Base class for Detail plugins.

Author:

gquintana

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DetailPlugin(String id, String label)

Method Summary

Methods

Modifier and Type	Method and Description
DetailHtmlBuilder	executeHtml(ActionContext context, DetailHtmlBuilder htmlBuilder, StringifierFactory htmlStringifierFactory, Simon simon) Callback for flat HTML rendering.
ObjectJS	executeJson(ActionContext context, StringifierFactory jsonStringifierFactory, Simon simon) Callback for flat JSON rendering.
boolean	supports(Simon simon) Indicates this plugin applies to this kind of Simon.

Methods inherited from class org.javasimon.console.SimonConsolePlugin

addResource, getActionBindings, getId, getLabel, getResources, getResources, toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

DetailPlugin

protected DetailPlugin(String id,
            String label)

Method Detail

supports

public boolean supports(Simon simon)

Indicates this plugin applies to this kind of Simon.

Parameters:

simon - Simon

Returns:

true if plugin can be executed

executeHtml

public DetailHtmlBuilder executeHtml(ActionContext context,
                            DetailHtmlBuilder htmlBuilder,
                            StringifierFactory htmlStringifierFactory,
                            Simon simon)
                              throws IOException

Callback for flat HTML rendering.

Parameters:

context - Context (Request, parameters...)

htmlBuilder - HTML Builder (Response generation helper)

simon - Simon to render.

Throws:

IOException

executeJson

public ObjectJS executeJson(ActionContext context,
                   StringifierFactory jsonStringifierFactory,
                   Simon simon)

Callback for flat JSON rendering.

Parameters:

context - Context (Request, parameters...)

simon - Simon to render