Class DefaultX4OPhaseManager

java.lang.Object

org.x4o.xml.lang.phase.DefaultX4OPhaseManager

All Implemented Interfaces:

X4OPhaseManager, X4OPhaseManagerLocal

public class DefaultX4OPhaseManager
extends Object
implements X4OPhaseManagerLocal

X4OPhaseManager stores the X4OPhaseHandler and puts them in the right order. And will execute the phases when runPhases is called.

Version:

1.0 Jan 6, 2008

Author:

Willem Cazander

Constructor Summary

Constructors

Constructor	Description
DefaultX4OPhaseManager()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addX4OPhase(X4OPhase phase)	Adds an X4OPhaseHandler.
void	doReleasePhaseManual(X4OLanguageSession languageSession)	Run release phase manual if auto release is disabled by config.
List<X4OPhase>	getAllPhases()	Returns all the X4OPhaseHandlers.
List<X4OPhase>	getOrderedPhases(X4OPhaseType type)	Returns all the X4OPhaseHandlers in ordered list.
X4OPhase	getPhase(String phaseName)	Gets an X4OPhase object by the phaseName.
List<String>	getPhaseKeys()	Gets all the keys of the phases registrated whith this phase manager.
void	runPhases(X4OLanguageSession languageSession, X4OPhaseType type)	Runs all the phases in the right order.
void	runPhasesForElement(Element e, X4OPhaseType type, X4OPhase p)	Runs phase on single element.

Methods inherited from class Object

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

Constructor Details

DefaultX4OPhaseManager

public DefaultX4OPhaseManager()

Constructor.

Method Details

getPhase

public X4OPhase getPhase(String phaseName)

Description copied from interface: X4OPhaseManager

Gets an X4OPhase object by the phaseName.

Specified by:

getPhase in interface X4OPhaseManager

Parameters:

phaseName - The phaseName to lookup.

Returns:

The X4OPhase requested or null.

getPhaseKeys

public List<String> getPhaseKeys()

Description copied from interface: X4OPhaseManager

Gets all the keys of the phases registrated whith this phase manager.

Specified by:

getPhaseKeys in interface X4OPhaseManager

Returns:

The phase keys.

addX4OPhase

public void addX4OPhase(X4OPhase phase)

Adds an X4OPhaseHandler.

Specified by:

addX4OPhase in interface X4OPhaseManagerLocal

Parameters:

phase - The X4OPhaseHandler to add.

getAllPhases

public List<X4OPhase> getAllPhases()

Returns all the X4OPhaseHandlers.

Returns:

Returns all X4OPhaseHandlers.

getOrderedPhases

public List<X4OPhase> getOrderedPhases(X4OPhaseType type)

Returns all the X4OPhaseHandlers in ordered list.

Returns:

Returns all X4OPhaseHandler is order.

runPhases

public void runPhases(X4OLanguageSession languageSession,
 X4OPhaseType type)
               throws X4OPhaseException

Runs all the phases in the right order.

Specified by:

runPhases in interface X4OPhaseManager

Throws:

X4OPhaseException - When a running handlers throws one.

runPhasesForElement

public void runPhasesForElement(Element e,
 X4OPhaseType type,
 X4OPhase p)
                         throws X4OPhaseException

Runs phase on single element.

Specified by:

runPhasesForElement in interface X4OPhaseManager

Parameters:

e - The Element to process.

p - The phase to run.

Throws:

X4OPhaseException - When a running handlers throws one.

doReleasePhaseManual

public void doReleasePhaseManual(X4OLanguageSession languageSession)
                          throws X4OPhaseException

Run release phase manual if auto release is disabled by config.

Specified by:

doReleasePhaseManual in interface X4OPhaseManager

Parameters:

languageSession - The session to release.

Throws:

X4OPhaseException - When a running handlers throws one.