org.apache.turbine.modules
Class LayoutLoader

java.lang.Object
  java.util.Dictionary
      java.util.Hashtable
          org.apache.turbine.modules.GenericLoader
              org.apache.turbine.modules.LayoutLoader

All Implemented Interfaces:

java.lang.Cloneable, Loader, java.util.Map, java.io.Serializable

public class LayoutLoader

extends GenericLoader

implements Loader

The purpose of this class is to allow one to load and execute Layout modules.

Version:

$Id: LayoutLoader.java 534527 2007-05-02 16:10:59Z tv $

Author:

Dave Bryson, Henning P. Schmiedehausen

See Also:

Serialized Form

Method Summary

void	exec(RunData data, java.lang.String name) Attempts to load and execute the external layout.
Assembler	getAssembler(java.lang.String name) Pulls out an instance of the object by name.
static LayoutLoader	getInstance() The method through which this class is accessed.
Layout	getInstance(java.lang.String name) Pulls out an instance of the Layout by name.

Methods inherited from class org.apache.turbine.modules.GenericLoader

cache, getBasePackage, reload, setReload

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

exec

public void exec(RunData data,
                 java.lang.String name)
          throws java.lang.Exception

Attempts to load and execute the external layout.

Specified by:

exec in class GenericLoader

Parameters:

data - Turbine information.

name - Name of object that will execute the layout.

Throws:

java.lang.Exception - a generic exception.

getAssembler

public Assembler getAssembler(java.lang.String name)
                       throws java.lang.Exception

Pulls out an instance of the object by name. Name is just the single name of the object. This is equal to getInstance but returns an Assembler object and is needed to fulfil the Loader interface.

Specified by:

getAssembler in interface Loader

Parameters:

name - Name of object instance.

Returns:

A Layout with the specified name, or null.

Throws:

java.lang.Exception - a generic exception.

getInstance

public Layout getInstance(java.lang.String name)
                   throws java.lang.Exception

Pulls out an instance of the Layout by name. Name is just the single name of the Layout.

Parameters:

name - Name of requested Layout

Returns:

A Layout with the specified name, or null.

Throws:

java.lang.Exception - a generic exception.

getInstance

public static LayoutLoader getInstance()

The method through which this class is accessed.

Returns:

The single instance of this class.