View Javadoc

1   /*
2    * Copyright 2006-2009 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.springframework.batch.core.configuration.xml;
17  
18  import java.util.Collection;
19  
20  import org.springframework.batch.core.job.flow.support.state.StepState;
21  import org.springframework.beans.factory.config.BeanDefinition;
22  import org.springframework.beans.factory.parsing.BeanComponentDefinition;
23  import org.springframework.beans.factory.support.AbstractBeanDefinition;
24  import org.springframework.beans.factory.support.BeanDefinitionBuilder;
25  import org.springframework.beans.factory.xml.ParserContext;
26  import org.w3c.dom.Element;
27  
28  /**
29   * Internal parser for the <step/> elements inside a job. A step element
30   * references a bean definition for a
31   * {@link org.springframework.batch.core.Step} and goes on to (optionally) list
32   * a set of transitions from that step to others with <next on="pattern"
33   * to="stepName"/>. Used by the {@link JobParser}.
34   * 
35   * @see JobParser
36   * 
37   * @author Dave Syer
38   * @author Thomas Risberg
39   * @since 2.0
40   */
41  public class InlineStepParser extends AbstractStepParser {
42  
43  	/**
44  	 * Parse the step and turn it into a list of transitions.
45  	 * 
46  	 * @param element the <step/gt; element to parse
47  	 * @param parserContext the parser context for the bean factory
48  	 * @param jobFactoryRef the reference to the {@link JobParserJobFactoryBean}
49  	 *        from the enclosing tag
50  	 * @return a collection of bean definitions for
51  	 *         {@link org.springframework.batch.core.job.flow.support.StateTransition}
52  	 *         instances objects
53  	 */
54  	public Collection<BeanDefinition> parse(Element element, ParserContext parserContext, String jobFactoryRef) {
55  
56  		BeanDefinitionBuilder stateBuilder = BeanDefinitionBuilder.genericBeanDefinition(StepState.class);
57  		String stepId = element.getAttribute(ID_ATTR);
58  
59  		AbstractBeanDefinition bd = parseStep(element, parserContext, jobFactoryRef);
60  		parserContext.registerBeanComponent(new BeanComponentDefinition(bd, stepId));
61  		stateBuilder.addConstructorArgReference(stepId);
62  
63  		return InlineFlowParser.getNextElements(parserContext, stepId, stateBuilder.getBeanDefinition(), element);
64  
65  	}
66  
67  }