XmlFlowBuilder (Spring Web Flow 1.0.5 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.webflow.engine.builder.xml
Class XmlFlowBuilder

java.lang.Object
  org.springframework.webflow.engine.builder.BaseFlowBuilder
      org.springframework.webflow.engine.builder.xml.XmlFlowBuilder

All Implemented Interfaces:: FlowBuilder, ResourceHolder

public class XmlFlowBuilder
extends BaseFlowBuilder
implements ResourceHolder
extends BaseFlowBuilder
implements ResourceHolder

Flow builder that builds flows as defined in an XML document. The XML document should adhere to the following format:

     <?xml version="1.0" encoding="UTF-8"?>
     <flow xmlns="http://www.springframework.org/schema/webflow"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.springframework.org/schema/webflow
                               http://www.springframework.org/schema/webflow/spring-webflow-1.0.xsd">
         <!-- Define your states here -->
     </flow>

Consult the web flow XML schema for more information on the XML-based flow definition format.

This builder will setup a flow-local bean factory for the flow being constructed. That flow-local bean factory will be populated with XML bean definitions contained in files referenced using the "import" element. The flow-local bean factory will use the bean factory defing this flow builder as a parent. As such, the flow can access artifacts in either its flow-local bean factory or in the parent bean factory hierarchy, e.g. the bean factory of the dispatcher.

Author:: Erwin Vervaet, Keith Donald

Field Summary
`protected org.springframework.core.io.Resource`	`location` The resource from which the document element being parsed was read.

Constructor Summary
`XmlFlowBuilder(org.springframework.core.io.Resource location)` Create a new XML flow builder parsing the document at the specified location.
`XmlFlowBuilder(org.springframework.core.io.Resource location, FlowServiceLocator flowServiceLocator)` Create a new XML flow builder parsing the document at the specified location, using the provided service locator to access externally managed flow artifacts.

Method Summary
`void`	`buildEndActions()` Builds any end actions to execute when the flow ends.
`void`	`buildExceptionHandlers()` Creates and adds all exception handlers to the flow built by this builder.
`void`	`buildGlobalTransitions()` Builds any transitions shared by all states of the flow.
`void`	`buildInlineFlows()` Builds any "in-line" flows encapsulated by the flow.
`void`	`buildInputMapper()` Builds the input mapper responsible for mapping flow input on start.
`void`	`buildOutputMapper()` Builds the output mapper responsible for mapping flow output on end.
`void`	`buildStartActions()` Builds any start actions to execute when the flow starts.
`void`	`buildStates()` Builds the states of the flow.
`void`	`buildVariables()` Builds any variables initialized by the flow when it starts.
`protected org.springframework.beans.factory.BeanFactory`	`createLocalBeanFactory(Flow flow, org.springframework.core.io.Resource[] resources)` Create a bean factory serving as a local flow service registry.
`void`	`dispose()` Shutdown the builder, releasing any resources it holds.
`protected org.w3c.dom.Element`	`getChildElementByTagName(org.w3c.dom.Element ele, java.lang.String childEleName)` Utility method that returns the first child element identified by its name.
`protected org.w3c.dom.Document`	`getDocument()` Returns the DOM document parsed from the XML file.
`protected org.w3c.dom.Element`	`getDocumentElement()` Returns the root document element.
`protected FlowArtifactFactory`	`getFlowArtifactFactory()` Returns the artifact factory of the flow service locator local to this builder.
`protected FlowServiceLocator`	`getLocalFlowServiceLocator()` Returns the flow service locator local to this builder.
`org.springframework.core.io.Resource`	`getLocation()` Returns the resource from which the document element was loaded.
`org.springframework.core.io.Resource`	`getResource()` Returns the flow definition resource held by this holder.
`void`	`init(java.lang.String id, AttributeMap attributes)` Initialize this builder.
`protected boolean`	`nodeNameEquals(org.w3c.dom.Node node, java.lang.String desiredName)` Namespace-aware equals comparison.
`protected void`	`registerLocalBeans(Flow flow, org.springframework.beans.factory.config.ConfigurableBeanFactory beanFactory)` Register beans in the bean factory local to the flow definition being built.
`void`	`setDocumentLoader(DocumentLoader documentLoader)` Sets the loader that will load the XML-based flow definition document.
`void`	`setLocation(org.springframework.core.io.Resource location)` Sets the resource from which the document element was loaded.
`java.lang.String`	`toString()`

Methods inherited from class org.springframework.webflow.engine.builder.BaseFlowBuilder
`fromStringTo, fromStringTo, getFlow, getFlowServiceLocator, setFlow, setFlowServiceLocator`

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

Field Detail

location

protected org.springframework.core.io.Resource location

The resource from which the document element being parsed was read. Used as a location for relative resource lookup.

Constructor Detail

XmlFlowBuilder

public XmlFlowBuilder(org.springframework.core.io.Resource location)

Create a new XML flow builder parsing the document at the specified location.

Parameters:: location - the location of the XML-based flow definition resource

XmlFlowBuilder

public XmlFlowBuilder(org.springframework.core.io.Resource location,
                      FlowServiceLocator flowServiceLocator)

Create a new XML flow builder parsing the document at the specified location, using the provided service locator to access externally managed flow artifacts.

Parameters:: location - the location of the XML-based flow definition resource; flowServiceLocator - the locator for services needed by this builder to build its Flow

Method Detail

getLocation

public org.springframework.core.io.Resource getLocation()

Returns the resource from which the document element was loaded. This is used for location relative loading of other resources.

setLocation

public void setLocation(org.springframework.core.io.Resource location)

Sets the resource from which the document element was loaded. This is used for location relative loading of other resources.

setDocumentLoader

public void setDocumentLoader(DocumentLoader documentLoader)

Sets the loader that will load the XML-based flow definition document. Optional, defaults to DefaultDocumentLoader.

Parameters:: documentLoader - the document loader

toString

public java.lang.String toString()

Overrides:: toString in class java.lang.Object