org.xmlactions.action

Class Action

java.lang.Object

org.xmlactions.action.Action

public class Action
extends java.lang.Object

Parses pages pulling out the IPageAction tags, which are used to call java code, insert data and other such actions.

Field Summary

Fields

Modifier and Type	Field and Description
static char[][]	EMPTY_NAMESPACE
static char[][]	nameSpaces

Constructor Summary

Constructors

Constructor and Description
Action()
Action(java.lang.String nameSpace)
Action(java.lang.String rootPath, java.lang.String pageName, char[][] nameSpaces)
Action(java.lang.String rootPath, java.lang.String pageName, java.lang.String nameSpace)

Method Summary

Modifier and Type	Method and Description
void	addEmptyNameSpace()
void	addNameSpace(char[] nameSpace) Add this namespace to the static list of namespaces [] [] If this namespace already exists in the list then it wont be added.
void	addNameSpace(java.lang.String nameSpace) Add this namespace to the static list of namespaces [] [] If this namespace already exists in the list then it wont be added.
void	addNameSpaces(char[][] newNameSpaces)
void	addNameSpaces(java.util.List<java.lang.String> newNameSpaces)
java.util.List<ReplacementMarker>	findMarkers(java.lang.String page, char[][] nameSpaces, IExecContext execContext, java.lang.String actionMapName) Find and return a list of all the markers on the page that begin with the nameSpace.
java.util.List<ReplacementMarker>	findMarkers(java.lang.String page, IExecContext execContext, java.lang.String actionMapName) Find and return a list of all the xml nodes on the page.
char[][]	getNameSpaces()
java.lang.String	getPageName()
java.lang.String	getRootPath()
static java.lang.String	loadPage(java.lang.String rootPath, java.lang.String pageName)
java.lang.String	processPage(IExecContext execContext) Process the page replacing any actions and / or markers.
java.lang.String	processPage(IExecContext execContext, java.lang.String page)
BaseAction[]	processXML(IExecContext execContext, java.lang.String page) Process an XML
java.lang.String	replaceMarkers(IExecContext execContext, java.lang.String pageContent, java.util.List<ReplacementMarker> markers)
void	setNameSpaces(char[][] nameSpaces)
void	setPageName(java.lang.String pageName)
void	setRootPath(java.lang.String rootPath)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_NAMESPACE

public static char[][] EMPTY_NAMESPACE

nameSpaces

public static char[][] nameSpaces

Constructor Detail

Action

public Action()

Action

public Action(java.lang.String nameSpace)

Parameters:

nameSpace - the nameSpace preceeding the action, e.g <pager:code...> where pager is the nameSpace

Action

public Action(java.lang.String rootPath,
              java.lang.String pageName,
              java.lang.String nameSpace)

Parameters:

rootPath - the root path of the site

pageName - the name of the page to load, may include path elements

nameSpace - the nameSpace preceeding the action, e.g <pager:code...> where pager is the nameSpace

Action

public Action(java.lang.String rootPath,
              java.lang.String pageName,
              char[][] nameSpaces)

Parameters:

rootPath - the root path of the site

pageName - the name of the page to load, may include path elements

nameSpaces - the nameSpace preceeding the action, e.g <pager:code...> where pager is the nameSpace

Method Detail

processPage

public java.lang.String processPage(IExecContext execContext)
                             throws java.io.IOException,
                                    NestedActionException,
                                    java.lang.ClassNotFoundException,
                                    java.lang.InstantiationException,
                                    java.lang.IllegalAccessException,
                                    java.lang.reflect.InvocationTargetException,
                                    java.lang.NoSuchMethodException,
                                    BadXMLException

Process the page replacing any actions and / or markers. TODO add the markers replacement code. e.g. add code to replace ${...};

Throws:

java.io.IOException - , NestedPagerException, ClassNotFoundException, InstantiationException, IllegalAccessException, InvocationTargetException, NoSuchMethodException

NestedActionException

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

BadXMLException

processPage

public java.lang.String processPage(IExecContext execContext,
                                    java.lang.String page)
                             throws java.io.IOException,
                                    NestedActionException,
                                    java.lang.ClassNotFoundException,
                                    java.lang.InstantiationException,
                                    java.lang.IllegalAccessException,
                                    java.lang.reflect.InvocationTargetException,
                                    java.lang.NoSuchMethodException,
                                    BadXMLException

Throws:

java.io.IOException

NestedActionException

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

BadXMLException

processXML

public BaseAction[] processXML(IExecContext execContext,
                               java.lang.String page)
                        throws java.io.IOException,
                               NestedActionException,
                               java.lang.ClassNotFoundException,
                               java.lang.InstantiationException,
                               java.lang.IllegalAccessException,
                               java.lang.reflect.InvocationTargetException,
                               java.lang.NoSuchMethodException,
                               BadXMLException

Process an XML

Returns:

an array of root actions, if size is 0 then no actions found.

Throws:

java.io.IOException - , NestedPagerException, ClassNotFoundException, InstantiationException, IllegalAccessException, InvocationTargetException, NoSuchMethodException

NestedActionException

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

BadXMLException

loadPage

public static java.lang.String loadPage(java.lang.String rootPath,
                                        java.lang.String pageName)
                                 throws java.io.IOException

Parameters:

rootPath - the root path of the site

pageName - the name of the page to load, may include path elements

Throws:

java.io.IOException

findMarkers

public java.util.List<ReplacementMarker> findMarkers(java.lang.String page,
                                                     char[][] nameSpaces,
                                                     IExecContext execContext,
                                                     java.lang.String actionMapName)
                                              throws java.lang.ClassNotFoundException,
                                                     java.lang.InstantiationException,
                                                     java.lang.IllegalAccessException,
                                                     java.lang.reflect.InvocationTargetException,
                                                     java.lang.NoSuchMethodException,
                                                     NestedActionException,
                                                     BadXMLException

Find and return a list of all the markers on the page that begin with the nameSpace.

Parameters:

page - the web page

nameSpaces - the name space of the markers we want to find.

execContext -

actionMapName -

Returns:

a list of ReplaceMarkers for each node found that uses the nameSpace

Throws:

java.lang.ClassNotFoundException - InstantiationException IllegalAccessException InvocationTargetException NoSuchMethodException NestedActionException BadXMLException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

NestedActionException

BadXMLException

findMarkers

public java.util.List<ReplacementMarker> findMarkers(java.lang.String page,
                                                     IExecContext execContext,
                                                     java.lang.String actionMapName)
                                              throws java.lang.ClassNotFoundException,
                                                     java.lang.InstantiationException,
                                                     java.lang.IllegalAccessException,
                                                     java.lang.reflect.InvocationTargetException,
                                                     java.lang.NoSuchMethodException,
                                                     NestedActionException,
                                                     BadXMLException

Find and return a list of all the xml nodes on the page.

Parameters:

page - the web page

Returns:

a list of ReplaceMarkers for each node found that uses the nameSpace

Throws:

java.lang.ClassNotFoundException - InstantiationException IllegalAccessException InvocationTargetException NoSuchMethodException NestedActionException BadXMLException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

NestedActionException

BadXMLException

replaceMarkers

public java.lang.String replaceMarkers(IExecContext execContext,
                                       java.lang.String pageContent,
                                       java.util.List<ReplacementMarker> markers)
                                throws NestedActionException

Throws:

NestedActionException

getRootPath

public java.lang.String getRootPath()

setRootPath

public void setRootPath(java.lang.String rootPath)

getPageName

public java.lang.String getPageName()

setPageName

public void setPageName(java.lang.String pageName)

getNameSpaces

public char[][] getNameSpaces()

setNameSpaces

public void setNameSpaces(char[][] nameSpaces)

addNameSpaces

public void addNameSpaces(java.util.List<java.lang.String> newNameSpaces)

addNameSpaces

public void addNameSpaces(char[][] newNameSpaces)

addEmptyNameSpace

public void addEmptyNameSpace()

addNameSpace

public void addNameSpace(java.lang.String nameSpace)

Add this namespace to the static list of namespaces [] [] If this namespace already exists in the list then it wont be added.

Parameters:

nameSpace - - the namespace to add

addNameSpace

public void addNameSpace(char[] nameSpace)

Add this namespace to the static list of namespaces [] [] If this namespace already exists in the list then it wont be added.

Parameters:

nameSpace - - the namespace to add