org.btrplace.btrpsl

Class ScriptBuilder

java.lang.Object

org.btrplace.btrpsl.ScriptBuilder

public class ScriptBuilder
extends Object

Build scripts from textual descriptions. For file based parsing, a LRU cache is used to prevent useless parsing. If the last modification date of the script has not changed since its last parsing, the cached version is returned.

Author:

Fabien Hermenier

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CACHE_SIZE
static String	EXTENSION
static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
ScriptBuilder(int cacheSize, Model mo) Make a new builder.
ScriptBuilder(Model mo) Make a new builder with a default cache size.

Method Summary

Modifier and Type	Method and Description
Script	build(File f) Build a script from a file.
Script	build(String description) Build a script from a String.
ConstraintsCatalog	getConstraintsCatalog() Get the used catalog of constraints.
Includes	getIncludes() Get the possibles scripts that can be included
NamingService<Node>	getNamingServiceNodes() Get the naming service that is used to create Nodes.
NamingService<VM>	getNamingServiceVMs() Get the naming service that is used to create VMs.
TemplateFactory	getTemplateFactory() Get the template factory used to instantiate elements when needed.
void	setConstraintsCatalog(ConstraintsCatalog c) Set the catalog of constraints to use.
void	setErrorReporterBuilder(ErrorReporterBuilder b) Indicate the ErrorReporter to instantiate before parsing a script.
void	setIncludes(Includes incs) Set the include library.
void	setTemplateFactory(TemplateFactory f) Set the factory to use to instantiate elements from template.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHE_SIZE

public static final int DEFAULT_CACHE_SIZE

See Also:

Constant Field Values

LOGGER

public static final org.slf4j.Logger LOGGER

EXTENSION

public static final String EXTENSION

See Also:

Constant Field Values

Constructor Detail

ScriptBuilder

public ScriptBuilder(Model mo)

Make a new builder with a default cache size.

Parameters:

mo - the model to rely on

ScriptBuilder

public ScriptBuilder(int cacheSize,
                     Model mo)

Make a new builder.

Parameters:

cacheSize - the size of the cache

Method Detail

getIncludes

public Includes getIncludes()

Get the possibles scripts that can be included

Returns:

an includes.

setIncludes

public void setIncludes(Includes incs)

Set the include library.

Parameters:

incs - the library to add

build

public Script build(File f)
             throws ScriptBuilderException

Build a script from a file.

Parameters:

f - the file to parse

Returns:

the resulting script

Throws:

ScriptBuilderException - if an error occurred

build

public Script build(String description)
             throws ScriptBuilderException

Build a script from a String.

Parameters:

description - the description of the script

Returns:

the built script

Throws:

ScriptBuilderException - if an error occurred while building the script

setErrorReporterBuilder

public void setErrorReporterBuilder(ErrorReporterBuilder b)

Indicate the ErrorReporter to instantiate before parsing a script.

Parameters:

b - the builder to use

getNamingServiceVMs

public NamingService<VM> getNamingServiceVMs()

Get the naming service that is used to create VMs.

Returns:

the naming service provided at instantiation

getNamingServiceNodes

public NamingService<Node> getNamingServiceNodes()

Get the naming service that is used to create Nodes.

Returns:

the naming service provided at instantiation

getTemplateFactory

public TemplateFactory getTemplateFactory()

Get the template factory used to instantiate elements when needed.

Returns:

the current template factory

setTemplateFactory

public void setTemplateFactory(TemplateFactory f)

Set the factory to use to instantiate elements from template.

Parameters:

f - the factory to use

getConstraintsCatalog

public ConstraintsCatalog getConstraintsCatalog()

Get the used catalog of constraints.

Returns:

the current catalog

setConstraintsCatalog

public void setConstraintsCatalog(ConstraintsCatalog c)

Set the catalog of constraints to use.

Parameters:

c - the catalog to rely one