com.massa.mrules.extensions.dsl.doc.html

Class DslHtmlDocGen

java.lang.Object

com.massa.dsl.doc.DslDocGen

com.massa.mrules.extensions.dsl.doc.html.DslHtmlDocGen

All Implemented Interfaces:

RenderingDataBuilder

public class DslHtmlDocGen
extends DslDocGen
implements RenderingDataBuilder

Main dsl-doc generator for html rendering.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DslHtmlDocGen.DefaultRenderable Default renderable based on Object to render class name to identify the rendering template.
static class	DslHtmlDocGen.RenderingData Rendering data of this rendering implementation, containing only the template's name.b

Field Summary

Fields

Modifier and Type	Field and Description
static TemplatesHolder<LexerBlock>	BLOCK_TEMPLATES
static TemplatesHolder<Lexer>	LEXER_TEMPLATES
static TemplatesHolder<LexerMatcher>	MATCHER_TEMPLATES

Fields inherited from class com.massa.dsl.doc.DslDocGen

BLOCK_HANDLERS, LEXER_HANDLERS, MATCHER_HANDLERS

Constructor Summary

Constructors

Constructor and Description
DslHtmlDocGen(Grammar g)

Method Summary

Modifier and Type	Method and Description
Renderable	buildRenderable(Grammar grammar, Object toRender) Returns an instance of DslHtmlDocGen.DefaultRenderable to render the object.
Object	buildRenderingData(Grammar grammar, LexerBlock block, LexerParser lexerParser) Builds information to render a block
Object	buildRenderingData(Grammar grammar, Lexer lexer, LexerParser lexerParser, boolean anonymous) Builds information to render a lexer
Object	buildRenderingData(Grammar grammar, LexerMatcher matcher, LexerParser lexerParser, LexerMatcherHandler.Mode mode) Builds information to render a matcher
org.jtwig.environment.EnvironmentConfiguration	createJtwigConfiguration()
protected RenderingDataBuilder	getRenderingDataBuilder() Allows to deport the creation of redering data in the implementing class.
protected SyntaxicScheme	newSyntaxicScheme()
protected void	render(HashMap<String,Object> model, OutputStream os) Responsible of the rendering task into the output stream.

Methods inherited from class com.massa.dsl.doc.DslDocGen

generate, generateHeader, getModel

Methods inherited from class java.lang.Object

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

Field Detail

BLOCK_TEMPLATES

public static final TemplatesHolder<LexerBlock> BLOCK_TEMPLATES

LEXER_TEMPLATES

public static final TemplatesHolder<Lexer> LEXER_TEMPLATES

MATCHER_TEMPLATES

public static final TemplatesHolder<LexerMatcher> MATCHER_TEMPLATES

Constructor Detail

DslHtmlDocGen

public DslHtmlDocGen(Grammar g)
              throws UtilsException

Throws:

UtilsException

Method Detail

createJtwigConfiguration

public org.jtwig.environment.EnvironmentConfiguration createJtwigConfiguration()

newSyntaxicScheme

protected SyntaxicScheme newSyntaxicScheme()

Specified by:

newSyntaxicScheme in class DslDocGen

Returns:

new instance of a SyntaxicScheme dedicated to this type of rendering

render

protected void render(HashMap<String,Object> model,
                      OutputStream os)

Description copied from class: DslDocGen

Responsible of the rendering task into the output stream.

Specified by:

render in class DslDocGen

getRenderingDataBuilder

protected RenderingDataBuilder getRenderingDataBuilder()

Description copied from class: DslDocGen

Allows to deport the creation of redering data in the implementing class. This data will we stored automatically in the bean.

Specified by:

getRenderingDataBuilder in class DslDocGen

buildRenderingData

public Object buildRenderingData(Grammar grammar,
                                 Lexer lexer,
                                 LexerParser lexerParser,
                                 boolean anonymous)

Description copied from interface: RenderingDataBuilder

Builds information to render a lexer

Specified by:

buildRenderingData in interface RenderingDataBuilder

buildRenderingData

public Object buildRenderingData(Grammar grammar,
                                 LexerBlock block,
                                 LexerParser lexerParser)

Description copied from interface: RenderingDataBuilder

Builds information to render a block

Specified by:

buildRenderingData in interface RenderingDataBuilder

buildRenderingData

public Object buildRenderingData(Grammar grammar,
                                 LexerMatcher matcher,
                                 LexerParser lexerParser,
                                 LexerMatcherHandler.Mode mode)

Description copied from interface: RenderingDataBuilder

Builds information to render a matcher

Specified by:

buildRenderingData in interface RenderingDataBuilder

buildRenderable

public Renderable buildRenderable(Grammar grammar,
                                  Object toRender)

Returns an instance of DslHtmlDocGen.DefaultRenderable to render the object.

Specified by:

buildRenderable in interface RenderingDataBuilder