net.sf.layoutParser.build

Class LayoutBuilder

java.lang.Object

net.sf.layoutParser.build.LayoutBuilder

All Implemented Interfaces:

Builder

public class LayoutBuilder
extends Object
implements Builder

Director part of the Builder pattern.
This class is responsible for building all the layouts 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	LISTENER "listener"
static String	RESOURCE "resource"

Method Summary

Methods

Modifier and Type	Method and Description
void	build(NodeList nodes) Parse and instantiate all layouts contained in the nodes. After all the layouts are parsed, it goes through all layouts, and checks if there's a ListTO in them. If there is, then the object is referenced in the ListTO.
XPathExpression	getExpression() Must return the XPath expression that is to be used to fetch the data for the builder.
static LayoutBuilder	getInstance() Plain instantiation method.
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

RESOURCE

public static final String RESOURCE

"resource"

See Also:

Constant Field Values

LISTENER

public static final String LISTENER

"listener"

See Also:

Constant Field Values

Method Detail

getInstance

public static LayoutBuilder getInstance()

Plain instantiation method.

Returns:

A instance of this object.

build

public void build(NodeList nodes)
           throws BuilderException

Parse and instantiate all layouts contained in the nodes.
After all the layouts are parsed, it goes through all layouts, and checks if there's a ListTO in them.
If there is, then the object is referenced in the ListTO.

Specified by:

build in interface Builder

Parameters:

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

Throws:

BuilderException - In case of any exceptions occurs while the method is being called.

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.