AbstractFlow (josef 3.2.5 API)

java.lang.Object
- org.josef.web.jsf.flow.AbstractFlowStep
- - org.josef.web.jsf.flow.AbstractFlow

Direct Known Subclasses:

BasicFlow, ComplexFlow, ComplexNestedFlow, ConditionalFlow, FlowWithDoubleSteps, RidiculouslyComplexFlow, RidiculouslyComplexNestedFlow, RidiculouslyComplexNestedNestedFlow
```
public abstract class AbstractFlow
extends AbstractFlowStep
```
Abstraction of a flow (actually it is a poor man's flow mechanism).
The design is based upon the design of a menu and a menu item where a menu extends a menu item. In this case, the flow extends a step and each flow contains a list of steps. Since a flow is also a step, a flow can contain both steps and other flows, just like you can have a menu with a nested menu.
Flows and FlowSteps are implemented as JSF Managed Beans. This makes them available from a JSF page. The way the different steps communicate is by a map which contains both input and output parameters. This looks like a very basic way to communicate but it actually makes the different steps independent of each other. It is also very easy to start a flow cleanly by emptying the map. It is still possible however to implement you own methods in concrete subclasses for communication purposes.
So what can you build with this flow mechanism? Wizards would be a great example. The flow does not have to be fixed though, as is normally the case for a wizard. It is really easy to hide steps, or add steps on the fly.
To create a flow, you should probably work bottom-up. First create the steps, then create the flow and then add the individual steps to the flow. Checkout The different flow examples in the josef-demo-web-primefaces project.

Version:

1.0 $Revision: 5791 $

Author:

Kees Schotanus

Constructor Summary

Constructors
Constructor and Description

AbstractFlow()
No argument constructor to make this flow a Java Bean.

AbstractFlow(String name)
Creates this flow from the supplied name.

Constructors
Constructor and Description
`AbstractFlow()` No argument constructor to make this flow a Java Bean.
`AbstractFlow(String name)` Creates this flow from the supplied name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStep(Class<? extends AbstractFlowStep> stepClass)` Adds an instance of the supplied stepClass as a step of this flow.
`void`	`back()` Goes back to the previous startable step.
`void`	`cleanStart()` Cleans data from a previous run and then starts this flow.
`void`	`finish()` Finishes the current step and continues with the next startable step.
`List<AbstractFlowStep>`	`getCurrentFlowPath()` Gets the current flow path.
`AbstractFlowStep`	`getCurrentStep()` Gets the current step.
`Integer`	`getIndexOfCurrentStep()` Gets the index of the current step.
`Object`	`getInputOutputParameter(String key)` Gets the input/output parameter with the supplied key.
`static List<AbstractFlowStep>`	`getLinearListOfFlowSteps(AbstractFlow flow)` Gets a linear list of flow steps.
`AbstractFlowStep`	`getNextStartableStep(int fromIndex)` Recursively gets the next startable step, starting from the supplied fromIndex position.
`AbstractFlowStep`	`getPreviousStartableStep(int fromIndex)` Recursively gets the previous startable step, starting from the supplied fromIndex position.
`List<AbstractFlowStep>`	`getSteps()` Gets all the steps of this flow.
`boolean`	`hasNextStartableStep(int fromIndex)` Recursively determines whether a next startable step exists.
`boolean`	`hasPreviousStartableStep(int fromIndex)` Recursively determines whether a previous startable step exists.
`Object`	`putInputOutputParameter(String key, Object inputOutputParameter)` Puts the supplied inputOutputParameter in the map of input/output parameters under the supplied key.
`void`	`setIndexOfCurrentStep(Integer indexOfCurrentStep)` Sets the index of the current step.
`void`	`start()` Starts the flow with the first startable step.
`String`	`toString()` Creates a String representation of this AbstractFlow.

Methods inherited from class org.josef.web.jsf.flow.AbstractFlowStep
getName, getParentFlow, getRootFlow, isStartable, isUserStartable, isVisible, setStartable, setUserStartable, setVisible

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbstractFlow
```
public AbstractFlow()
```
    No argument constructor to make this flow a Java Bean.
  - AbstractFlow
```
public AbstractFlow(String name)
```
    Creates this flow from the supplied name.
    
    Parameters:
    
    name - The name of this flow.
- Method Detail
  - getCurrentStep
```
public AbstractFlowStep getCurrentStep()
```
    Gets the current step.
    
    Returns:
    
    The current step or null when this flow has no current step.
  - getCurrentFlowPath
```
public List<AbstractFlowStep> getCurrentFlowPath()
```
    Gets the current flow path. The current flow consists of all the flows and flow steps that is currently used.
    
    Returns:
    
    The current flow path.
  - getIndexOfCurrentStep
```
public Integer getIndexOfCurrentStep()
```
    Gets the index of the current step.
    
    Returns:
    
    The index of the current step, which may be null when this flow has no current step.
  - setIndexOfCurrentStep
```
public void setIndexOfCurrentStep(Integer indexOfCurrentStep)
```
    Sets the index of the current step.
    
    Parameters:
    
    indexOfCurrentStep - The index of the current step.
    This parameter may be null.
    
    Throws:
    
    IllegalArgumentException - When the supplied indexOfCurrentStep is out of range.
  - addStep
```
public void addStep(Class<? extends AbstractFlowStep> stepClass)
```
    Adds an instance of the supplied stepClass as a step of this flow.
    
    Parameters:
    
    stepClass - The class of the step.
    
    Throws:
    
    NullPointerException - When the supplied stepClass is null.
  - getSteps
```
public List<AbstractFlowStep> getSteps()
```
    Gets all the steps of this flow.
    
    Returns:
    
    The steps of this flow.
    Currently the list is not cloned.
  - getLinearListOfFlowSteps
```
public static List<AbstractFlowStep> getLinearListOfFlowSteps(AbstractFlow flow)
```
    Gets a linear list of flow steps.
    The result is a sequential list of all steps that are part of the supplied flow. The resulting list only contains elements of type AbstractFlowStep so all elements of type AbstractFlow* are left out.
    
    Parameters:
    
    flow - The flow to create the list from.
    
    Returns:
    
    a linear list of flow steps.
  - getInputOutputParameter
```
public Object getInputOutputParameter(String key)
```
    Gets the input/output parameter with the supplied key.
    
    Overrides:
    
    getInputOutputParameter in class AbstractFlowStep
    
    Parameters:
    
    key - The key of the input/output parameter.
    
    Returns:
    
    The input/output parameter with the supplied key or null when no input/output parameter with the supplied key exists.
  - putInputOutputParameter
```
public Object putInputOutputParameter(String key,
                                      Object inputOutputParameter)
```
    Puts the supplied inputOutputParameter in the map of input/output parameters under the supplied key.
    
    Overrides:
    
    putInputOutputParameter in class AbstractFlowStep
    
    Parameters:
    
    key - The key of the input/output parameter.
    
    inputOutputParameter - The input/output parameter.
    
    Returns:
    
    The object previously stored under the supplied key or null when no key was previously stored or the key was stored but its value was null.
  - cleanStart
```
public void cleanStart()
```
    Cleans data from a previous run and then starts this flow.
  - start
```
public void start()
```
    Starts the flow with the first startable step.
    
    Specified by:
    
    start in class AbstractFlowStep
  - back
```
public void back()
```
    Goes back to the previous startable step.
    
    Overrides:
    
    back in class AbstractFlowStep
  - getPreviousStartableStep
```
public AbstractFlowStep getPreviousStartableStep(int fromIndex)
```
    Recursively gets the previous startable step, starting from the supplied fromIndex position.
    It also updates the indexes of all the flows that the returned step is contained in.
    
    Parameters:
    
    fromIndex - Index position to start searching from.
    
    Returns:
    
    The previous startable step or null when no such step exists.
    The returned step is always an actual AbstractFlowStep, not an AbstractFlow.
  - finish
```
public void finish()
```
    Finishes the current step and continues with the next startable step.
    
    Overrides:
    
    finish in class AbstractFlowStep
  - getNextStartableStep
```
public AbstractFlowStep getNextStartableStep(int fromIndex)
```
    Recursively gets the next startable step, starting from the supplied fromIndex position.
    It also updates the indexes of all the flows that the returned step is contained in.
    
    Parameters:
    
    fromIndex - Index position to start searching from.
    
    Returns:
    
    The next startable step or null when no such step exists.
    The returned step is always an actual AbstractFlowStep, not an AbstractFlow.
  - hasPreviousStartableStep
```
public boolean hasPreviousStartableStep(int fromIndex)
```
    Recursively determines whether a previous startable step exists.
    
    Parameters:
    
    fromIndex - Index position to start searching from.
    
    Returns:
    
    True when a previous startable step exists, otherwise false is returned.
  - hasNextStartableStep
```
public boolean hasNextStartableStep(int fromIndex)
```
    Recursively determines whether a next startable step exists.
    
    Parameters:
    
    fromIndex - Index position to start searching from.
    
    Returns:
    
    True when a next startable step exists, otherwise false is returned.
  - toString
```
public String toString()
```
    Creates a String representation of this AbstractFlow.
    
    Overrides:
    
    toString in class AbstractFlowStep
    
    Returns:
    
    A String representation of this AbstractFlow.

Class AbstractFlow

Constructor Summary

Method Summary

Methods inherited from class org.josef.web.jsf.flow.AbstractFlowStep

Methods inherited from class java.lang.Object

Constructor Detail

AbstractFlow

AbstractFlow

Method Detail

getCurrentStep

getCurrentFlowPath

getIndexOfCurrentStep

setIndexOfCurrentStep

addStep

getSteps

getLinearListOfFlowSteps

getInputOutputParameter

putInputOutputParameter

cleanStart

start

back

getPreviousStartableStep

finish

getNextStartableStep

hasPreviousStartableStep

hasNextStartableStep

toString