Java Doc for SubflowState.java in  » Workflow-Engines » spring-webflow-1.0.4 » org » springframework » webflow » engine » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Workflow Engines » spring webflow 1.0.4 » org.springframework.webflow.engine 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.webflow.engine.AnnotatedObject
      org.springframework.webflow.engine.State
         org.springframework.webflow.engine.TransitionableState
            org.springframework.webflow.engine.SubflowState

SubflowState
public class SubflowState extends TransitionableState (Code)
A transitionable state that spawns a subflow when executed. When the subflow this state spawns ends, the ending result is used as grounds for a state transition out of this state.

A subflow state may be configured to map input data from its flow -- acting as the parent flow -- down to the subflow when the subflow is spawned. In addition, output data produced by the subflow may be mapped up to the parent flow when the subflow ends and the parent flow resumes. See the FlowAttributeMapper interface definition for more information on how to do this. The logic for ending a subflow is located in the EndState implementation.
See Also:   org.springframework.webflow.engine.FlowAttributeMapper
See Also:   org.springframework.webflow.engine.EndState
author:
   Keith Donald
author:
   Erwin Vervaet




Constructor Summary
public  SubflowState(Flow flow, String id, Flow subflow)
     Create a new subflow state.
Parameters:
  flow - the owning flow
Parameters:
  id - the state identifier (must be unique to the flow)
Parameters:
  subflow - the subflow to spawn
throws:
  IllegalArgumentException - when this state cannot be added to givenflow, e.g.

Method Summary
protected  voidappendToString(ToStringCreator creator)
    
protected  MutableAttributeMapcreateSubflowInput(RequestContext context)
     Create the input data map for the spawned subflow session.
protected  ViewSelectiondoEnter(RequestControlContext context)
     Specialization of State's doEnter template method that executes behaviour specific to this state type in polymorphic fashion.
public  FlowAttributeMappergetAttributeMapper()
     Returns the attribute mapper used to map data between the parent and child flow, or null if no mapping is needed.
public  FlowgetSubflow()
     Returns the subflow spawned by this state.
public  ViewSelectiononEvent(RequestControlContext context)
     Called on completion of the subflow to handle the subflow result event as determined by the end state reached by the subflow.
public  voidsetAttributeMapper(FlowAttributeMapper attributeMapper)
     Set the attribute mapper used to map model data between the parent and child flow.


Constructor Detail
SubflowState
public SubflowState(Flow flow, String id, Flow subflow) throws IllegalArgumentException(Code)
Create a new subflow state.
Parameters:
  flow - the owning flow
Parameters:
  id - the state identifier (must be unique to the flow)
Parameters:
  subflow - the subflow to spawn
throws:
  IllegalArgumentException - when this state cannot be added to givenflow, e.g. because the id is not unique
See Also:   SubflowState.setAttributeMapper(FlowAttributeMapper)




Method Detail
appendToString
protected void appendToString(ToStringCreator creator)(Code)



createSubflowInput
protected MutableAttributeMap createSubflowInput(RequestContext context)(Code)
Create the input data map for the spawned subflow session. The returned map will be passed to Flow.start(RequestControlContextMutableAttributeMap) .



doEnter
protected ViewSelection doEnter(RequestControlContext context) throws FlowExecutionException(Code)
Specialization of State's doEnter template method that executes behaviour specific to this state type in polymorphic fashion.

Entering this state, creates the subflow input map and spawns the subflow in the current flow execution.
Parameters:
  context - the control context for the currently executing flow, usedby this state to manipulate the flow execution a view selection containing model and view information needed torender the results of the state execution
throws:
  FlowExecutionException - if an exception occurs in this state




getAttributeMapper
public FlowAttributeMapper getAttributeMapper()(Code)
Returns the attribute mapper used to map data between the parent and child flow, or null if no mapping is needed.



getSubflow
public Flow getSubflow()(Code)
Returns the subflow spawned by this state.



onEvent
public ViewSelection onEvent(RequestControlContext context)(Code)
Called on completion of the subflow to handle the subflow result event as determined by the end state reached by the subflow.



setAttributeMapper
public void setAttributeMapper(FlowAttributeMapper attributeMapper)(Code)
Set the attribute mapper used to map model data between the parent and child flow. Can be null if no mapping is needed.



Methods inherited from org.springframework.webflow.engine.TransitionableState
protected void appendToString(ToStringCreator creator)(Code)(Java Doc)
public void exit(RequestControlContext context)(Code)(Java Doc)
public ActionList getExitActionList()(Code)(Java Doc)
public Transition getRequiredTransition(RequestContext context) throws NoMatchingTransitionException(Code)(Java Doc)
public TransitionSet getTransitionSet()(Code)(Java Doc)
public TransitionDefinition[] getTransitions()(Code)(Java Doc)
public ViewSelection onEvent(RequestControlContext context) throws NoMatchingTransitionException(Code)(Java Doc)
public ViewSelection reenter(RequestControlContext context)(Code)(Java Doc)

Fields inherited from org.springframework.webflow.engine.State
final protected Log logger(Code)(Java Doc)

Methods inherited from org.springframework.webflow.engine.State
protected void appendToString(ToStringCreator creator)(Code)(Java Doc)
abstract protected ViewSelection doEnter(RequestControlContext context) throws FlowExecutionException(Code)(Java Doc)
final public ViewSelection enter(RequestControlContext context) throws FlowExecutionException(Code)(Java Doc)
public boolean equals(Object o)(Code)(Java Doc)
public ActionList getEntryActionList()(Code)(Java Doc)
public FlowExecutionExceptionHandlerSet getExceptionHandlerSet()(Code)(Java Doc)
public Flow getFlow()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public FlowDefinition getOwner()(Code)(Java Doc)
public ViewSelection handleException(FlowExecutionException exception, RequestControlContext context)(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isStartState()(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Fields inherited from org.springframework.webflow.engine.AnnotatedObject
final public static String CAPTION_PROPERTY(Code)(Java Doc)
final public static String DESCRIPTION_PROPERTY(Code)(Java Doc)

Methods inherited from org.springframework.webflow.engine.AnnotatedObject
public MutableAttributeMap getAttributeMap()(Code)(Java Doc)
public AttributeMap getAttributes()(Code)(Java Doc)
public String getCaption()(Code)(Java Doc)
public String getDescription()(Code)(Java Doc)
public void setCaption(String caption)(Code)(Java Doc)
public void setDescription(String description)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.