de.matthias_burbach.flux
Class PageEventActionMappingGenerator

java.lang.Object
  extended byde.matthias_burbach.flux.AbstractActionMappingGenerator
      extended byde.matthias_burbach.flux.PageEventActionMappingGenerator
All Implemented Interfaces:
ActionMappingGenerator

public class PageEventActionMappingGenerator
extends AbstractActionMappingGenerator

Generates an event dispatcher action mapping for each UML state with stereotype 'Page'.

Author:
Matthias Burbach

Field Summary
 
Fields inherited from class de.matthias_burbach.flux.AbstractActionMappingGenerator
settings
 
Constructor Summary
PageEventActionMappingGenerator()
           
 
Method Summary
 void begin(StateMachine stateMachine, org.jdom.Document oldDocument, org.jdom.Element oldActionMappingsElement, org.jdom.Document newDocument, org.jdom.Element newActionMappingsElement)
          Introduces the <action> elements generated by this generator with the comment <--Page Events-->.
 void generate(StateMachine stateMachine, State state, org.jdom.Document oldDocument, org.jdom.Element oldActionMappingsElement, org.jdom.Document newDocument, org.jdom.Element newActionMappingsElement)
          Generates the event dispatcher mapping that maps requests from a page to the page event that is encoded as HTTP request parameter (with syntax 'action=%EVENT%' or '%EVENT%.x').
protected  void generatePageDevariationActionMapping(StateMachine stateMachine, State state, org.jdom.Document oldDocument, org.jdom.Element oldActionMappingsElement, org.jdom.Document newDocument, org.jdom.Element newActionMappingsElement, java.lang.String variableName, java.lang.String variableValue)
           
protected  void generatePageEventActionMapping(StateMachine stateMachine, State state, org.jdom.Document oldDocument, org.jdom.Element oldActionMappingsElement, org.jdom.Document newDocument, org.jdom.Element newActionMappingsElement)
           
protected  java.lang.String getForwardToPhysicalPage(State state)
          Derives the default forward path to the physical page resource (JSP) that implements the state of stereotype 'Page'.
 
Methods inherited from class de.matthias_burbach.flux.AbstractActionMappingGenerator
end, generateForward, generateForward, generateForwards, generateProperty, getActionMappingElementForPath, getBasePath, getBasePathExtension, getDefaultName, getDefaultPackage, getDefaultType, getForwardElementForName, getForwardPath, getForwardPathPrefix, getForwardPathSuffix, getNamePartOfBasePath, setSettings
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageEventActionMappingGenerator

public PageEventActionMappingGenerator()
Method Detail

begin

public void begin(StateMachine stateMachine,
                  org.jdom.Document oldDocument,
                  org.jdom.Element oldActionMappingsElement,
                  org.jdom.Document newDocument,
                  org.jdom.Element newActionMappingsElement)
Introduces the <action> elements generated by this generator with the comment <--Page Events-->.

Specified by:
begin in interface ActionMappingGenerator
Overrides:
begin in class AbstractActionMappingGenerator

generate

public void generate(StateMachine stateMachine,
                     State state,
                     org.jdom.Document oldDocument,
                     org.jdom.Element oldActionMappingsElement,
                     org.jdom.Document newDocument,
                     org.jdom.Element newActionMappingsElement)
              throws java.lang.Exception
Generates the event dispatcher mapping that maps requests from a page to the page event that is encoded as HTTP request parameter (with syntax 'action=%EVENT%' or '%EVENT%.x').

Preserves all attributes from the previous version of the element except the disallowed forward, include and input attributes and the type attribute, which must not be manually changed because the framework class specified by the settings property 'DispatcherAction' is used for it.

Generates nested <forward> elements to dispatch to the events and preserves all other child elements (like <set-property>, e. g.) from the previous version.

For a description of the parameters see generate(StateMachine, State, Document, Element, Document, Element)

Specified by:
generate in interface ActionMappingGenerator
Overrides:
generate in class AbstractActionMappingGenerator
Throws:
java.lang.Exception

generatePageDevariationActionMapping

protected void generatePageDevariationActionMapping(StateMachine stateMachine,
                                                    State state,
                                                    org.jdom.Document oldDocument,
                                                    org.jdom.Element oldActionMappingsElement,
                                                    org.jdom.Document newDocument,
                                                    org.jdom.Element newActionMappingsElement,
                                                    java.lang.String variableName,
                                                    java.lang.String variableValue)
                                             throws java.lang.Exception
Throws:
java.lang.Exception

getForwardToPhysicalPage

protected java.lang.String getForwardToPhysicalPage(State state)
Derives the default forward path to the physical page resource (JSP) that implements the state of stereotype 'Page'.

Parameters:
state - the state to derive the physical forward path from
Returns:
the path to the physical page resource (JSP)

generatePageEventActionMapping

protected void generatePageEventActionMapping(StateMachine stateMachine,
                                              State state,
                                              org.jdom.Document oldDocument,
                                              org.jdom.Element oldActionMappingsElement,
                                              org.jdom.Document newDocument,
                                              org.jdom.Element newActionMappingsElement)
                                       throws java.lang.Exception
Throws:
java.lang.Exception