org.xchain.namespaces.jsl

Class AbstractTemplateCommand

java.lang.Object

org.xchain.impl.ChainImpl

org.xchain.namespaces.jsl.AbstractTemplateCommand

All Implemented Interfaces:

Chain, Command, Locatable, Registerable

public abstract class AbstractTemplateCommand
extends ChainImpl
implements Locatable, Registerable

The base class for generated jsl template commands.

Author:

Christian Trimble, Jason Rose

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.ThreadLocal<java.util.LinkedList<CommandExecutionState[]>>	commandExecutionStateStackTL The thread local stack of command execution state arrays.
static java.lang.ThreadLocal<java.lang.Integer>	depthTl
static java.lang.ThreadLocal<java.util.LinkedList<javax.xml.namespace.QName>>	dynamicElementStackTL
static java.lang.ThreadLocal<java.util.LinkedList<ElementOutputState[]>>	elementOutputStateStackTL The thread local stack of element output state arrays.
protected org.xml.sax.Locator	locator
protected javax.xml.namespace.QName	qName
static java.lang.ThreadLocal<org.xml.sax.SAXException>	saxExceptionTl
protected java.lang.String	systemId
protected int	templateDepth

Fields inherited from class org.xchain.impl.ChainImpl

commandList

Constructor Summary

Constructors

Constructor and Description
AbstractTemplateCommand(int elementCount)

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.xml.namespace.QName	dynamicQName(org.apache.commons.jxpath.JXPathContext context, java.lang.String nameXPath, java.lang.String namespaceXPath, boolean includeDefaultPrefix) Uses the specified nameXPath and namespaceXPath to create a dynamic qName.
boolean	execute(org.apache.commons.jxpath.JXPathContext context) Initializes the internal state of this command and then calls executeTemplate( JXPathContext ).
protected boolean	executeChildren(org.apache.commons.jxpath.JXPathContext context, int[] childIndecies) Calls the execute method of the children specified by childIndecies, passing it the supplied context.
abstract boolean	executeTemplate(org.apache.commons.jxpath.JXPathContext context) Generated templates implement this method to provide sax output.
protected static CommandExecutionState[]	getCommandExecutionState() Returns the command execute state array for the current thread.
protected CommandHandler	getContentHandler()
protected static java.util.LinkedList<javax.xml.namespace.QName>	getDynamicElementStack()
protected static ElementOutputState[]	getElementOutputState()
org.xml.sax.Locator	getLocator() Returns a Locator for Commands and Catalogs.
javax.xml.namespace.QName	getQName() If this command is registered, then the qname for this command is returned.
java.lang.String	getSystemId() If this command is registered, then the system id for the catalog it is registered in is returned.
protected boolean	hasSaxExceptionFired()
boolean	isElementStarted(int elementIndex)
boolean	isRegistered() Returns true if this command is registered with a catalog, false otherwise.
protected boolean	postProcessChildren(org.apache.commons.jxpath.JXPathContext context, java.lang.Exception exception, int[] childIndecies) Calls post process of the specified indices.
protected void	registerSaxException(org.xml.sax.SAXException saxException)
void	setLocator(org.xml.sax.Locator locator)
void	setQName(javax.xml.namespace.QName qName) Sets the registration qname for this command.
void	setSystemId(java.lang.String systemId) Sets the registration system id for this command.
protected static java.lang.String	toPrefixedQName(javax.xml.namespace.QName qName) Turns a QName into its prefixed string representation.
protected void	trackEndElement(int elementIndex)
protected void	trackStartElement(int elementIndex)
protected boolean	virtualPostProcess(org.apache.commons.jxpath.JXPathContext context, java.lang.Exception exception, boolean result, int[] childIndecies) The post process command for virtual chains.

Methods inherited from class org.xchain.impl.ChainImpl

addCommand, getCommandList

Methods inherited from class java.lang.Object

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

Field Detail

commandExecutionStateStackTL

public static final java.lang.ThreadLocal<java.util.LinkedList<CommandExecutionState[]>> commandExecutionStateStackTL

The thread local stack of command execution state arrays.

elementOutputStateStackTL

public static final java.lang.ThreadLocal<java.util.LinkedList<ElementOutputState[]>> elementOutputStateStackTL

The thread local stack of element output state arrays.

dynamicElementStackTL

public static final java.lang.ThreadLocal<java.util.LinkedList<javax.xml.namespace.QName>> dynamicElementStackTL

saxExceptionTl

public static final java.lang.ThreadLocal<org.xml.sax.SAXException> saxExceptionTl

depthTl

public static final java.lang.ThreadLocal<java.lang.Integer> depthTl

locator

protected org.xml.sax.Locator locator

systemId

protected java.lang.String systemId

qName

protected javax.xml.namespace.QName qName

templateDepth

protected int templateDepth

Constructor Detail

AbstractTemplateCommand

public AbstractTemplateCommand(int elementCount)

Method Detail

getCommandExecutionState

protected static CommandExecutionState[] getCommandExecutionState()

Returns the command execute state array for the current thread.

getElementOutputState

protected static ElementOutputState[] getElementOutputState()

getDynamicElementStack

protected static java.util.LinkedList<javax.xml.namespace.QName> getDynamicElementStack()

isRegistered

public boolean isRegistered()

Description copied from interface: Registerable

Returns true if this command is registered with a catalog, false otherwise.

Specified by:

isRegistered in interface Registerable

Returns:

true if this command is registered with a catalog, false otherwise.

setQName

public void setQName(javax.xml.namespace.QName qName)

Description copied from interface: Registerable

Sets the registration qname for this command. This method should only be called by the XChain framework.

Specified by:

setQName in interface Registerable

Parameters:

qName - the key for this command in the catalog.

getQName

public javax.xml.namespace.QName getQName()

Description copied from interface: Registerable

If this command is registered, then the qname for this command is returned. Otherwise, the result is undefined.

Specified by:

getQName in interface Registerable

Returns:

the qname of this command, if it is registered. The result is undefined otherwise.

setSystemId

public void setSystemId(java.lang.String systemId)

Description copied from interface: Registerable

Sets the registration system id for this command. This method should only be called by the XChain framework.

Specified by:

setSystemId in interface Registerable

Parameters:

systemId - the system id of the catalog where this command is registered.

getSystemId

public java.lang.String getSystemId()

Description copied from interface: Registerable

If this command is registered, then the system id for the catalog it is registered in is returned. Otherwise, the result is undefined.

Specified by:

getSystemId in interface Registerable

Returns:

the system id of the catalog to which this command is registered. If the command is not registered, then the result is undefined.

dynamicQName

protected javax.xml.namespace.QName dynamicQName(org.apache.commons.jxpath.JXPathContext context,
                                     java.lang.String nameXPath,
                                     java.lang.String namespaceXPath,
                                     boolean includeDefaultPrefix)
                                          throws org.xml.sax.SAXException

Uses the specified nameXPath and namespaceXPath to create a dynamic qName.

Throws:

org.xml.sax.SAXException

trackStartElement

protected void trackStartElement(int elementIndex)

trackEndElement

protected void trackEndElement(int elementIndex)

isElementStarted

public boolean isElementStarted(int elementIndex)

setLocator

public void setLocator(org.xml.sax.Locator locator)

Specified by:

setLocator in interface Locatable

getLocator

public org.xml.sax.Locator getLocator()

Description copied from interface: Locatable

Returns a Locator for Commands and Catalogs.

Specified by:

getLocator in interface Locatable

execute

public final boolean execute(org.apache.commons.jxpath.JXPathContext context)
                      throws java.lang.Exception

Initializes the internal state of this command and then calls executeTemplate( JXPathContext ).

Specified by:

execute in interface Command

Overrides:

execute in class ChainImpl

Throws:

java.lang.Exception

executeTemplate

public abstract boolean executeTemplate(org.apache.commons.jxpath.JXPathContext context)
                                 throws java.lang.Exception

Generated templates implement this method to provide sax output.

Throws:

java.lang.Exception

executeChildren

protected final boolean executeChildren(org.apache.commons.jxpath.JXPathContext context,
                      int[] childIndecies)
                                 throws java.lang.Exception

Calls the execute method of the children specified by childIndecies, passing it the supplied context. If the execute call completes without failing, then the command execution state for that child command is updated to EXECUTED.

Throws:

java.lang.Exception

virtualPostProcess

protected final boolean virtualPostProcess(org.apache.commons.jxpath.JXPathContext context,
                         java.lang.Exception exception,
                         boolean result,
                         int[] childIndecies)
                                    throws java.lang.Exception

The post process command for virtual chains.

Throws:

java.lang.Exception

postProcessChildren

protected final boolean postProcessChildren(org.apache.commons.jxpath.JXPathContext context,
                          java.lang.Exception exception,
                          int[] childIndecies)

Calls post process of the specified indices.

toPrefixedQName

protected static final java.lang.String toPrefixedQName(javax.xml.namespace.QName qName)

Turns a QName into its prefixed string representation.

getContentHandler

protected CommandHandler getContentHandler()

hasSaxExceptionFired

protected boolean hasSaxExceptionFired()

registerSaxException

protected void registerSaxException(org.xml.sax.SAXException saxException)