org.xmlactions.action.actions

Class BaseAction

java.lang.Object

org.xmlactions.action.actions.BaseAction

Direct Known Subclasses:

Attributes, BaseFormAction, BaseStorageField, Bean, Bean, BeanToXml, Button, CodeAction, CodeAction, CodeCallHandler, CodePopulator, ContentTypeAction, Creator, Database, DateFormatterAction, DBInsert, DbSpecific, DebugAction, DeleteRecord, DoProcessPageForPreview, DoReset, DoSavePage, DoUpload, EchoAction, ElseAction, ElseIfAction, EvalAction, Function, GetAction, HttpAction, IfAction, InsertAction, InsertIntoAction, InsertRecord, JasperReportHandler, JSONGetAction, KeyValue, KeyValue, Link, ListPopulator, LogAction, MapperAttribute, MapperElement, Namespace, NavigatorToggleBranch, Param, Param, PkCreate, Populator, Populator, PresentationFormAction, ProcessCallbackPhone, Property, PropertyAlias, PropsAction, PutAction, RangeAction, RemoveAction, SaveRecordAction, ScriptAction, Sql, SqlPopulator, Storage, SubmitFormAction, TablePath, Text, TextCutAction, TextFormatterAction, TextReplaceAction, TransformAction, UpdateRecord, Xml, XmlToBean

public abstract class BaseAction
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHILD setter / getter name = child
static java.lang.String	CONTENT setter / getter name = content

Constructor Summary

Constructors

Constructor and Description
BaseAction()

Method Summary

Modifier and Type	Method and Description
void	addChild(BaseAction action)
void	clearActions()
java.lang.StringBuilder	doReplace(java.lang.String srcContent)
java.lang.String	doReplace(java.lang.String srcContent, java.lang.String replacementContent, int start, int end)
abstract java.lang.String	execute(IExecContext execContext) Executes an action
java.util.List<BaseAction>	getActions()
BaseAction	getChild() Get the last child in the list or null if there are no actions/elements in the list.
java.lang.String	getContent()
java.lang.String	getFirstValueFound(java.lang.String propertyName)
BaseAction	getParent()
java.lang.String	getReplacementContent()
ReplacementMarker	getReplacementMarker()
boolean	isUsedForDisplay()
void	processAction(java.lang.String pageContent, BaseAction action, IExecContext execContext)
void	setAction(BaseAction action)
void	setActions(java.util.List<BaseAction> actions)
void	setChild(BaseAction action)
void	setContent(java.lang.String content)
void	setParent(BaseAction parent)
void	setReplacementContent(java.lang.String replacementContent)
void	setReplacementMarker(ReplacementMarker replacementMarker)
void	setUsedForDisplay(boolean usedForDisplay)

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT

public static final java.lang.String CONTENT

setter / getter name = content

See Also:

Constant Field Values

CHILD

public static final java.lang.String CHILD

setter / getter name = child

See Also:

Constant Field Values

Constructor Detail

BaseAction

public BaseAction()

Method Detail

execute

public abstract java.lang.String execute(IExecContext execContext)
                                  throws java.lang.Exception

Executes an action

Parameters:

execContext - the application execution context

Returns:

a String for replacement and to execute any child actions, else null to skip over child actions.

Throws:

java.lang.Exception

getActions

public java.util.List<BaseAction> getActions()

setActions

public void setActions(java.util.List<BaseAction> actions)

clearActions

public void clearActions()

setAction

public void setAction(BaseAction action)

setChild

public void setChild(BaseAction action)

addChild

public void addChild(BaseAction action)

getChild

public BaseAction getChild()

Get the last child in the list or null if there are no actions/elements in the list.

Returns:

last child or null if the list is empty.

setContent

public void setContent(java.lang.String content)

getContent

public java.lang.String getContent()

getReplacementContent

public java.lang.String getReplacementContent()

setReplacementContent

public void setReplacementContent(java.lang.String replacementContent)

getReplacementMarker

public ReplacementMarker getReplacementMarker()

setReplacementMarker

public void setReplacementMarker(ReplacementMarker replacementMarker)

processAction

public void processAction(java.lang.String pageContent,
                          BaseAction action,
                          IExecContext execContext)
                   throws java.lang.Exception

Throws:

java.lang.Exception

doReplace

public java.lang.StringBuilder doReplace(java.lang.String srcContent)

doReplace

public java.lang.String doReplace(java.lang.String srcContent,
                                  java.lang.String replacementContent,
                                  int start,
                                  int end)

setUsedForDisplay

public void setUsedForDisplay(boolean usedForDisplay)

isUsedForDisplay

public boolean isUsedForDisplay()

Returns:

true if this action should be replaced on to the page

setParent

public void setParent(BaseAction parent)

getParent

public BaseAction getParent()

getFirstValueFound

public java.lang.String getFirstValueFound(java.lang.String propertyName)