org.sweble.wikitext.engine

Class WtEngineImpl

java.lang.Object

org.sweble.wikitext.engine.WtEngineImpl

All Implemented Interfaces:

WtEngine

public class WtEngineImpl
extends Object
implements WtEngine

Constructor Summary

Constructors

Constructor and Description
WtEngineImpl(WikiConfig wikiConfig)

Method Summary

Modifier and Type	Method and Description
protected EngProcessedPage	expand(ExpansionCallback callback, PageId pageId, WtPreproWikitextPage ppAst, WtEntityMap entityMap, boolean forInclusion, Map<String,WtNodeList> arguments, ExpansionFrame rootFrame, ExpansionFrame parentFrame)
EngProcessedPage	expand(PageId pageId, String wikitext, boolean forInclusion, ExpansionCallback callback) Takes wikitext and expands the wikitext.
EngProcessedPage	expand(PageId pageId, String wikitext, ExpansionCallback callback) Takes wikitext and expands the wikitext.
ExpansionDebugHooks	getDebugHooks()
WikiConfig	getWikiConfig()
boolean	isCatchAll()
boolean	isNoRedirect()
boolean	isTimingEnabled()
EngineNodeFactory	nf()
EngProcessedPage	parse(PageId pageId, String wikitext, ExpansionCallback callback) Takes wikitext and parses the wikitext for viewing.
EngProcessedPage	parseAndPostprocess(PageId pageId, String wikitext, ExpansionCallback callback) Takes wikitext and parses the wikitext for viewing.
EngProcessedPage	postprocess(PageId pageId, String wikitext, ExpansionCallback callback) Takes wikitext and parses the wikitext for viewing.
EngProcessedPage	postprocessPpOrExpAst(PageId pageId, WtPreproWikitextPage pprAst) Takes an AST after preprocessing or after expansion and performs the following steps: Parsing Entity substitution Postprocessing
EngProcessedPage	preprocess(PageId pageId, String wikitext, boolean forInclusion, ExpansionCallback callback) Takes wikitext and preprocesses the wikitext (without performing expansion).
protected EngProcessedPage	preprocessAndExpand(ExpansionCallback callback, PageId pageId, String wikitext, boolean forInclusion, WtEntityMap entityMap, Map<String,WtNodeList> arguments, ExpansionFrame rootFrame, ExpansionFrame parentFrame) This function is only called by preprocessor frames to pull in pages for transclusion or redirection.
void	setCatchAll(boolean catchAll)
void	setDebugHooks(ExpansionDebugHooks hooks)
void	setNoRedirect(boolean noRedirect)
void	setTimingEnabled(boolean timingEnabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

WtEngineImpl

public WtEngineImpl(WikiConfig wikiConfig)

Method Detail

setDebugHooks

public void setDebugHooks(ExpansionDebugHooks hooks)

Specified by:

setDebugHooks in interface WtEngine

setNoRedirect

public void setNoRedirect(boolean noRedirect)

Specified by:

setNoRedirect in interface WtEngine

setTimingEnabled

public void setTimingEnabled(boolean timingEnabled)

Specified by:

setTimingEnabled in interface WtEngine

setCatchAll

public void setCatchAll(boolean catchAll)

Specified by:

setCatchAll in interface WtEngine

getWikiConfig

public WikiConfig getWikiConfig()

Specified by:

getWikiConfig in interface WtEngine

getDebugHooks

public ExpansionDebugHooks getDebugHooks()

Specified by:

getDebugHooks in interface WtEngine

isNoRedirect

public boolean isNoRedirect()

Specified by:

isNoRedirect in interface WtEngine

isTimingEnabled

public boolean isTimingEnabled()

Specified by:

isTimingEnabled in interface WtEngine

isCatchAll

public boolean isCatchAll()

Specified by:

isCatchAll in interface WtEngine

nf

public EngineNodeFactory nf()

Specified by:

nf in interface WtEngine

preprocess

public EngProcessedPage preprocess(PageId pageId,
                                   String wikitext,
                                   boolean forInclusion,
                                   ExpansionCallback callback)
                            throws EngineException

Takes wikitext and preprocesses the wikitext (without performing expansion). The following steps are performed:

• Validation
• Preprocessing (for inclusion/viewing)
• Entity substitution
• Optional: Expansion

Specified by:

preprocess in interface WtEngine

Throws:

EngineException

expand

public EngProcessedPage expand(PageId pageId,
                               String wikitext,
                               ExpansionCallback callback)
                        throws EngineException

Takes wikitext and expands the wikitext. The following steps are performed:

• Validation
• Preprocessing (for viewing)
• Entity substitution
• Expansion

Specified by:

expand in interface WtEngine

Throws:

EngineException

expand

public EngProcessedPage expand(PageId pageId,
                               String wikitext,
                               boolean forInclusion,
                               ExpansionCallback callback)
                        throws EngineException

Takes wikitext and expands the wikitext. The following steps are performed:

• Validation
• Preprocessing (for viewing)
• Entity substitution
• Expansion

Specified by:

expand in interface WtEngine

Throws:

EngineException

parse

public EngProcessedPage parse(PageId pageId,
                              String wikitext,
                              ExpansionCallback callback)
                       throws EngineException

Takes wikitext and parses the wikitext for viewing. The following steps are performed:

• Validation
• Preprocessing (for viewing)
• Entity substitution
• Optional: Expansion
• Parsing
• Entity substitution

Specified by:

parse in interface WtEngine

Throws:

EngineException

parseAndPostprocess

public EngProcessedPage parseAndPostprocess(PageId pageId,
                                            String wikitext,
                                            ExpansionCallback callback)
                                     throws EngineException

Takes wikitext and parses the wikitext for viewing. The following steps are performed:

• Parsing
• Postprocessing

Throws:

EngineException

postprocess

public EngProcessedPage postprocess(PageId pageId,
                                    String wikitext,
                                    ExpansionCallback callback)
                             throws EngineException

Takes wikitext and parses the wikitext for viewing. The following steps are performed:

• Validation
• Preprocessing (for viewing)
• Entity substitution
• Optional: Expansion
• Parsing
• Entity substitution
• Postprocessing

Specified by:

postprocess in interface WtEngine

Throws:

EngineException

postprocessPpOrExpAst

public EngProcessedPage postprocessPpOrExpAst(PageId pageId,
                                              WtPreproWikitextPage pprAst)
                                       throws EngineException

Takes an AST after preprocessing or after expansion and performs the following steps:

• Parsing
• Entity substitution
• Postprocessing

Specified by:

postprocessPpOrExpAst in interface WtEngine

Throws:

EngineException

preprocessAndExpand

protected EngProcessedPage preprocessAndExpand(ExpansionCallback callback,
                                               PageId pageId,
                                               String wikitext,
                                               boolean forInclusion,
                                               WtEntityMap entityMap,
                                               Map<String,WtNodeList> arguments,
                                               ExpansionFrame rootFrame,
                                               ExpansionFrame parentFrame)
                                        throws EngineException

This function is only called by preprocessor frames to pull in pages for transclusion or redirection. It takes wikitext and parses the wikitext for inclusion or viewing. The following steps are performed:

• Validation
• Preprocessing (for inclusion/viewing)
• Entity substitution
• Expansion

Throws:

EngineException

expand

protected EngProcessedPage expand(ExpansionCallback callback,
                                  PageId pageId,
                                  WtPreproWikitextPage ppAst,
                                  WtEntityMap entityMap,
                                  boolean forInclusion,
                                  Map<String,WtNodeList> arguments,
                                  ExpansionFrame rootFrame,
                                  ExpansionFrame parentFrame)
                           throws EngineException

Throws:

EngineException