org.xchain.framework.jsl

Class TemplateSourceBuilder

java.lang.Object

org.xchain.framework.jsl.TemplateSourceBuilder

public class TemplateSourceBuilder
extends java.lang.Object

A utility class to build jsl template command classes.

Author:

Christian Trimble, Jason Rose, Josh Kennedy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateSourceBuilder.BodyMode
static class	TemplateSourceBuilder.Context The context for a sax template command.
static class	TemplateSourceBuilder.VirtualChainContext The context for a virtual chain method.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	ATTRIBUTE_VALUE_TEMPLATE_PATTERN
static java.lang.String	BASE_TEMPLATE_NAME
static java.lang.String	DYNAMIC_PART_REGEX
static java.util.regex.Pattern	ENCODING_PATTERN
static java.lang.String	ENCODING_REGEX
static java.lang.String	FIXED_PART_REGEX
static org.slf4j.Logger	log
static java.lang.String	TEMPLATE_PACKAGE

Constructor Summary

Constructors

Constructor and Description
TemplateSourceBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
void	appendAttributeValueTemplate(java.lang.String uri, java.lang.String localName, java.lang.String qName, java.lang.String attributeValueTemplate)
void	appendCharacters(java.lang.String characters) Appends code to output a static string to the handler as a characters(char[], int, int) event to the handler.
void	appendCommandCall()
void	appendContextEndPrefixMapping(java.lang.String prefix)
void	appendContextStartPrefixMapping(java.lang.String prefix, java.lang.String uri)
void	appendEndComment()
void	appendEndDynamicAttribute() Appends code for the end of a tag.
void	appendEndDynamicElement() Appends code for the end of a tag.
void	appendEndElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Appends code to send an end element event to the handler.
void	appendEndExcludeResultPrefix(java.lang.String prefix)
void	appendEndPrefixMapping(java.lang.String prefix)
void	appendIgnorableWhitespace(java.lang.String ignorableWhitespace)
void	appendStartComment()
void	appendStartDynamicAttribute(java.lang.String name, java.lang.String namespace) Appends code for the start of a tag.
void	appendStartDynamicElement(java.lang.String name, java.lang.String namespace) Appends code for the start of a tag.
void	appendStartElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Appends code to send a start element event to the handler.
void	appendStartExcludeResultPrefix(java.lang.String prefix)
void	appendStartPrefixMapping(java.lang.String prefix, java.lang.String uri)
void	appendValueOf(java.lang.String jxpath) Appends code to output an xpath to the handler as a characters(char[], int, int) event to the handler.
void	changeBodyMode(TemplateSourceBuilder.BodyMode newMode)
void	decrementIndent()
void	endEndElement()
SourceResult	endSource()
void	endStartElement()
void	endVirtualChain() Signals the end of a virtual chain.
void	incrementIndent()
java.lang.StringBuilder	indent(java.lang.StringBuilder builder)
int	nextCommandId()
static java.util.List<java.lang.String>	parseAttributeValueTemplate(java.lang.String attributeValueTemplate) Parses an attribute value template into fixed and dynamic parts.
TemplateSourceBuilder.Context	popContext()
void	pushContext(TemplateSourceBuilder.Context context)
void	startEndElement()
void	startSource(java.util.Map<java.lang.String,java.lang.String> transitionPrefixMapping, java.util.Set<java.lang.String> transitionExcludeResultPrefixSet, boolean excludeResultPrefixBoundary)
void	startStartElement()
void	startVirtualChain() Signals the start of a new virtual command.
static java.lang.String	stringConstant(java.lang.String source)

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.slf4j.Logger log

TEMPLATE_PACKAGE

public static final java.lang.String TEMPLATE_PACKAGE

See Also:

Constant Field Values

BASE_TEMPLATE_NAME

public static final java.lang.String BASE_TEMPLATE_NAME

See Also:

Constant Field Values

FIXED_PART_REGEX

public static final java.lang.String FIXED_PART_REGEX

See Also:

Constant Field Values

DYNAMIC_PART_REGEX

public static final java.lang.String DYNAMIC_PART_REGEX

See Also:

Constant Field Values

ENCODING_REGEX

public static final java.lang.String ENCODING_REGEX

See Also:

Constant Field Values

ATTRIBUTE_VALUE_TEMPLATE_PATTERN

public static java.util.regex.Pattern ATTRIBUTE_VALUE_TEMPLATE_PATTERN

ENCODING_PATTERN

public static java.util.regex.Pattern ENCODING_PATTERN

Constructor Detail

TemplateSourceBuilder

public TemplateSourceBuilder()

Method Detail

pushContext

public void pushContext(TemplateSourceBuilder.Context context)

popContext

public TemplateSourceBuilder.Context popContext()

nextCommandId

public int nextCommandId()

startSource

public void startSource(java.util.Map<java.lang.String,java.lang.String> transitionPrefixMapping,
               java.util.Set<java.lang.String> transitionExcludeResultPrefixSet,
               boolean excludeResultPrefixBoundary)

endSource

public SourceResult endSource()

startVirtualChain

public void startVirtualChain()

Signals the start of a new virtual command. This method adds a call to the current virtual method context and then creates a new virtual method context.

endVirtualChain

public void endVirtualChain()

Signals the end of a virtual chain. The method removes the current virtual chain context from the stack and uses it to build the virtual method.

appendCommandCall

public void appendCommandCall()

startStartElement

public void startStartElement()

endStartElement

public void endStartElement()

startEndElement

public void startEndElement()

endEndElement

public void endEndElement()

appendStartPrefixMapping

public void appendStartPrefixMapping(java.lang.String prefix,
                            java.lang.String uri)

appendEndPrefixMapping

public void appendEndPrefixMapping(java.lang.String prefix)

appendStartExcludeResultPrefix

public void appendStartExcludeResultPrefix(java.lang.String prefix)

appendEndExcludeResultPrefix

public void appendEndExcludeResultPrefix(java.lang.String prefix)

appendContextStartPrefixMapping

public void appendContextStartPrefixMapping(java.lang.String prefix,
                                   java.lang.String uri)

appendContextEndPrefixMapping

public void appendContextEndPrefixMapping(java.lang.String prefix)

appendAttributeValueTemplate

public void appendAttributeValueTemplate(java.lang.String uri,
                                java.lang.String localName,
                                java.lang.String qName,
                                java.lang.String attributeValueTemplate)
                                  throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

appendStartElement

public void appendStartElement(java.lang.String uri,
                      java.lang.String localName,
                      java.lang.String qName)

Appends code to send a start element event to the handler.

appendEndElement

public void appendEndElement(java.lang.String uri,
                    java.lang.String localName,
                    java.lang.String qName)

Appends code to send an end element event to the handler.

appendCharacters

public void appendCharacters(java.lang.String characters)

Appends code to output a static string to the handler as a characters(char[], int, int) event to the handler.

appendIgnorableWhitespace

public void appendIgnorableWhitespace(java.lang.String ignorableWhitespace)

appendValueOf

public void appendValueOf(java.lang.String jxpath)

Appends code to output an xpath to the handler as a characters(char[], int, int) event to the handler. This should support disable-output-escaping="yes|no" and output the javax.xml.transform.disable-output-escaping processing instruction if needed.

appendStartComment

public void appendStartComment()

appendEndComment

public void appendEndComment()

appendStartDynamicElement

public void appendStartDynamicElement(java.lang.String name,
                             java.lang.String namespace)

Appends code for the start of a tag.

Parameters:

name - the required name attribute.

namespace - the optional namespace attribute.

appendEndDynamicElement

public void appendEndDynamicElement()

Appends code for the end of a tag.

appendStartDynamicAttribute

public void appendStartDynamicAttribute(java.lang.String name,
                               java.lang.String namespace)

Appends code for the start of a tag.

Parameters:

name - the required name attribute.

namespace - the required namespace attribute.

appendEndDynamicAttribute

public void appendEndDynamicAttribute()

Appends code for the end of a tag.

changeBodyMode

public void changeBodyMode(TemplateSourceBuilder.BodyMode newMode)

indent

public java.lang.StringBuilder indent(java.lang.StringBuilder builder)

incrementIndent

public void incrementIndent()

decrementIndent

public void decrementIndent()

parseAttributeValueTemplate

public static java.util.List<java.lang.String> parseAttributeValueTemplate(java.lang.String attributeValueTemplate)
                                                                    throws org.xml.sax.SAXException

Parses an attribute value template into fixed and dynamic parts. This list will always start with a fixed part and then include alternating dynamic and fixed parts.

Throws:

org.xml.sax.SAXException

stringConstant

public static java.lang.String stringConstant(java.lang.String source)