Uses of Class
fmpp.Engine

Packages that use Engine

Package	Description
fmpp	The very core, the foundation of FMPP.
fmpp.dataloaders	fmpp.DataLoader implementations.
fmpp.localdatabuilders	fmpp.LocalDataBuilder implementations.
fmpp.progresslisteners	fmpp.ProgressListener implementations.
fmpp.setting	FMPP settings.
fmpp.tdd	Textual Data Definition related classes.

Uses of Engine in fmpp

Methods in fmpp that return Engine

Modifier and Type	Method and Description
Engine	TemplateEnvironment.getEngine() Returns the FMPP engine object in use.

Methods in fmpp with parameters of type Engine

Modifier and Type	Method and Description
java.util.Map	LocalDataBuilder.build(Engine eng, TemplateEnvironment env) Returns the variables that could be added to the local data.
java.util.Map	TemplateDataModelBuilder.build(Engine e, freemarker.template.Template template, java.io.File src) Deprecated. Returns the top-level variables that will be available for the template.
void	ProgressListener.notifyProgressEvent(Engine engine, int event, java.io.File src, int pMode, java.lang.Throwable error, java.lang.Object param) Method called be the engine to notify events.

Constructors in fmpp with parameters of type Engine

Constructor and Description
ProcessingException(Engine e, java.io.File sourceFile, java.lang.Throwable cause)

Uses of Engine in fmpp.dataloaders

Fields in fmpp.dataloaders declared as Engine

Modifier and Type	Field and Description
protected Engine	FileDataLoader.engine

Methods in fmpp.dataloaders with parameters of type Engine

Modifier and Type	Method and Description
java.lang.Object	XmlDataLoader.load(Engine engine, java.util.List args)
java.lang.Object	NowDataLoader.load(Engine engine, java.util.List args)
java.lang.Object	HtmlUtilsDataLoader.load(Engine e, java.util.List args)
java.lang.Object	FileDataLoader.load(Engine engine, java.util.List args)
java.lang.Object	EvalDataLoader.load(Engine e, java.util.List args)
java.lang.Object	AntDataLoader.load(Engine eng, java.util.List args) Gets the Ant task object, and invoked AntDataLoader.load(Engine, List, Task).
freemarker.template.TemplateNodeModel	XmlDataLoader.load(Engine engine, java.util.List args, org.w3c.dom.Document preLoadedDoc)
java.lang.Object	AntTaskDataLoader.load(Engine eng, java.util.List args, org.apache.tools.ant.Task task)
java.lang.Object	AntPropertyDataLoader.load(Engine eng, java.util.List args, org.apache.tools.ant.Task task)
java.lang.Object	AntPropertiesDataLoader.load(Engine eng, java.util.List args, org.apache.tools.ant.Task task)
java.lang.Object	AntProjectDataLoader.load(Engine eng, java.util.List args, org.apache.tools.ant.Task task)
protected abstract java.lang.Object	AntDataLoader.load(Engine eng, java.util.List args, org.apache.tools.ant.Task task) Override this method to implement your Ant related data loader.
static org.w3c.dom.Document	XmlDataLoader.loadXmlFile(Engine engine, java.io.File xmlFile, boolean namespaceAware, boolean validate)
static org.w3c.dom.Document	XmlDataLoader.loadXmlFile(Engine engine, java.io.File xmlFile, boolean namespaceAware, boolean xincludeAware, boolean validate)

Uses of Engine in fmpp.localdatabuilders

Methods in fmpp.localdatabuilders with parameters of type Engine

Modifier and Type	Method and Description
java.util.Map	TddHashLocalDataBuilder.build(Engine eng)
protected abstract java.util.Map	CachingLocalDataBuilder.build(Engine eng) Override this method in your local data builder class.
java.util.Map	MapLocalDataBuilder.build(Engine eng, TemplateEnvironment env)
java.util.Map	CachingLocalDataBuilder.build(Engine eng, TemplateEnvironment env) Takes care of caching, and calls CachingLocalDataBuilder.build(Engine) if no cached result is available.
java.util.Map	BshLocalDataBuilder.build(Engine eng, TemplateEnvironment env)
void	CachingLocalDataBuilder.notifyProgressEvent(Engine engine, int event, java.io.File src, int pMode, java.lang.Throwable error, java.lang.Object param) Discards the cached result on ProgressListener.EVENT_END_PROCESSING_SESSION.

Uses of Engine in fmpp.progresslisteners

Methods in fmpp.progresslisteners with parameters of type Engine

Modifier and Type	Method and Description
void	TerseConsoleProgressListener.notifyProgressEvent(Engine engine, int event, java.io.File src, int pMode, java.lang.Throwable error, java.lang.Object param)
void	StatisticsProgressListener.notifyProgressEvent(Engine engine, int event, java.io.File src, int pMode, java.lang.Throwable error, java.lang.Object param)
void	LoggerProgressListener.notifyProgressEvent(Engine engine, int event, java.io.File src, int pMode, java.lang.Throwable error, java.lang.Object param)
void	ConsoleProgressListener.notifyProgressEvent(Engine engine, int event, java.io.File src, int pMode, java.lang.Throwable error, java.lang.Object param)
void	AntProgressListener.notifyProgressEvent(Engine engine, int event, java.io.File src, int pMode, java.lang.Throwable error, java.lang.Object param)

Uses of Engine in fmpp.setting

Methods in fmpp.setting with parameters of type Engine

Modifier and Type	Method and Description
protected void	Settings.doProcessing(Engine eng, java.io.File[] sources, java.io.File sourceFile, java.io.File outputFile) Executes the processing session(s) on the Engine level, using the already initialized Engine object.

Uses of Engine in fmpp.tdd

Methods in fmpp.tdd with parameters of type Engine

Modifier and Type	Method and Description
static DataLoader	TddUtil.getDataLoaderInstance(Engine eng, java.lang.String dlName) Resolves a data loader name to a data loader instance.
java.lang.Object	DataLoader.load(Engine e, java.util.List args)

Constructors in fmpp.tdd with parameters of type Engine

Constructor and Description
DataLoaderEvaluationEnvironment(Engine eng)