net.sf.layoutParser.build

Class PluginBuilder

java.lang.Object

net.sf.layoutParser.build.PluginBuilder

All Implemented Interfaces:

Builder

public class PluginBuilder
extends Object
implements Builder

Director part of the Builder pattern.
This class is responsible for building all the plugins for the framework. This includes
parsing the xml's into objects and delivering these objects to the LayoutCatalog.

This class is a singleton.

Since:

1.0

Author:

Mário Valentim Junior

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARSER "parser"

Constructor Summary

Constructors

Constructor and Description
PluginBuilder(AliasCatalog aliasCatalog, PluginCatalog pluginCatalog) Creates the plug-in builder with an alias catalog which will be queried for class alias and a plug-in catalog that will be populated with plug-ins.

Method Summary

Methods

Modifier and Type	Method and Description
void	build(NodeList nodes) Parses all the nodes instantiating the plugins and put them into the LayoutCatalog.
XPathExpression	getExpression() Must return the XPath expression that is to be used to fetch the data for the builder.
ExceptionKey	getParseKey() It must return the key that is to be used for the exception in case of parsin error.

Methods inherited from class java.lang.Object

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

Field Detail

PARSER

public static final String PARSER

"parser"

See Also:

Constant Field Values

Constructor Detail

PluginBuilder

public PluginBuilder(AliasCatalog aliasCatalog,
             PluginCatalog pluginCatalog)

Creates the plug-in builder with an alias catalog which will be queried for class alias and a plug-in catalog that will be populated with plug-ins.

Parameters:

aliasCatalog - The alias catalog to be queried for class aliases.

pluginCatalog - The catalog to be populated with plug-ins.

Method Detail

build

public void build(NodeList nodes)
           throws BuilderException

Parses all the nodes instantiating the plugins and put them into the LayoutCatalog.

Specified by:

build in interface Builder

Parameters:

nodes - The nodes of the configuration document containing the plugins.

Throws:

BuilderException - In case of:

• Either "class" or "parser" property of the typeHandler tag, can't be instantiated because of ClassNotFoundException
• Either "class" or "parser" property of the typeHandler tag, can't be instantiated because of InstantiationException
• Either "class" or "parser" property of the typeHandler tag, can't be instantiated because of IllegalAccessException

getExpression

public XPathExpression getExpression()

Description copied from interface: Builder

Must return the XPath expression that is to be used to fetch the data for the builder.

Specified by:

getExpression in interface Builder

Returns:

The XPath expression to be used.

getParseKey

public ExceptionKey getParseKey()

Description copied from interface: Builder

It must return the key that is to be used for the exception in case of parsin error.

Specified by:

getParseKey in interface Builder

Returns:

The key to be used.