org.springframework.xd.dirt.job.dsl

Class JobSpecification

java.lang.Object

org.springframework.xd.dirt.job.dsl.AstNode

org.springframework.xd.dirt.job.dsl.JobSpecification

public class JobSpecification
extends AstNode

The root AST node for any AST parsed from a job specification. Andy Clement

Field Summary

Fields inherited from class org.springframework.xd.dirt.job.dsl.AstNode

endpos, startpos

Constructor Summary

Constructors

Constructor and Description
JobSpecification(java.lang.String jobDefinitionText, JobNode jobNode, ArgumentNode[] globalOptions)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	format() Pretty print the text for this job specification, including appropriate newlines and indentation.
java.util.Map<java.lang.String,java.lang.String>	getGlobalOptionsMap()
JobDefinition	getJobDefinition(java.lang.String jobName)
java.util.List<JobDefinition>	getJobDefinitions() A shortcut (avoiding traversing the tree) that returns the list of all job definitions inlined somewhere in this AST.
java.lang.String	getJobDefinitionText()
JobNode	getJobNode()
java.util.List<JobReference>	getJobReferences() A shortcut (avoiding traversing the tree) that returns the list of all job references somewhere in this AST (references in transitions do not count).
java.lang.String	stringify(boolean includePositionInfo)
Graph	toGraph()
java.lang.String	toXML(java.lang.String batchJobId)
java.lang.String	toXML(java.lang.String batchJobId, boolean prettyPrint)
void	validate(JobDefinitionRepository jobDefinitionRepository) Performs validation of the AST.

Methods inherited from class org.springframework.xd.dirt.job.dsl.AstNode

format, getEndPos, getStartPos, stringify

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobSpecification

public JobSpecification(java.lang.String jobDefinitionText,
                JobNode jobNode,
                ArgumentNode[] globalOptions)

Method Detail

getGlobalOptionsMap

public java.util.Map<java.lang.String,java.lang.String> getGlobalOptionsMap()

stringify

public java.lang.String stringify(boolean includePositionInfo)

Specified by:

stringify in class AstNode

Returns:

a string representation of the AST. Useful for debugging/testing.

getJobDefinitionText

public java.lang.String getJobDefinitionText()

getJobNode

public JobNode getJobNode()

getJobDefinitions

public java.util.List<JobDefinition> getJobDefinitions()

A shortcut (avoiding traversing the tree) that returns the list of all job definitions inlined somewhere in this AST. Computed on demand.

Returns:

a list of inlined job definitions defined in this AST

getJobReferences

public java.util.List<JobReference> getJobReferences()

A shortcut (avoiding traversing the tree) that returns the list of all job references somewhere in this AST (references in transitions do not count).

Returns:

a list of job references in this AST

validate

public void validate(JobDefinitionRepository jobDefinitionRepository)

Performs validation of the AST. Where the initial parse is about checking the syntactic structure, validation is about checking more semantic elements:

• Do the inline job definitions refer to valid job modules?
• Do the inline job definitions supply correct arguments?
• Do the job references point to valid job definitions?

Parameters:

jobDefinitionRepository - a repository to check job definitions against

Throws:

JobSpecificationException - if validation fails

toGraph

public Graph toGraph()

Returns:

this AST converted to a Graph form for display by Flo

toXML

public java.lang.String toXML(java.lang.String batchJobId)

Parameters:

batchJobId - the id that will be inserted into the XML document for the batch:job element

Returns:

this AST converted to an XML form

toXML

public java.lang.String toXML(java.lang.String batchJobId,
                     boolean prettyPrint)

Parameters:

batchJobId - the id that will be inserted into the XML document for the batch:job element

prettyPrint - determine if the XML should be human readable.

Returns:

this AST converted to an XML form

getJobDefinition

public JobDefinition getJobDefinition(java.lang.String jobName)

format

public java.lang.String format()

Pretty print the text for this job specification, including appropriate newlines and indentation.

Returns:

formatted job specification.