xalanc::ElemTemplate Class Reference

#include <xalanc/XSLT/ElemTemplate.hpp>

Inheritance diagram for xalanc::ElemTemplate:

Public Types
typedef ElemTemplateElement	ParentType

Public Member Functions
	ElemTemplate (StylesheetConstructionContext &constructionContext, Stylesheet &stylesheetTree, const AttributeListType &atts, XalanFileLoc lineNumber, XalanFileLoc columnNumber)
	Construct an object corresponding to an "xsl:template" element.
virtual	~ElemTemplate ()
const XalanQName &	getMode () const
	Retrieve the mode of element.
const XPath *	getMatchPattern () const
	Retrieve the match pattern.
double	getPriority () const
	Retrieve the priority of element.
virtual const XalanQName &	getNameAttribute () const
	Get the QName associated with any name attribute of this element.
virtual void	addToStylesheet (StylesheetConstructionContext &constructionContext, Stylesheet &theStylesheet)
	Called during compilation when an instance is not parented by another element, and thus, is a child of the stylesheet.
virtual const XalanDOMString &	getElementName () const
	Get a string for the name of the element.
virtual const ElemTemplateElement *	startElement (StylesheetExecutionContext &executionContext) const
	Completes "pre-processing" before any sub-elements are invoked (i.e.
virtual void	endElement (StylesheetExecutionContext &executionContext) const
	Completes "post-processing" afer any sub-elements are invoked (i.e.
virtual const ElemTemplateElement *	getInvoker (StylesheetExecutionContext &executionContext) const
	Returns the element that invoked this element.
virtual const XPath *	getXPath (XalanSize_t index) const
	Get XPath pattern/expression of one of the element atribute.
Public Member Functions inherited from xalanc::ElemTemplateElement
	ElemTemplateElement (StylesheetConstructionContext &constructionContext, Stylesheet &stylesheetTree, XalanFileLoc lineNumber, XalanFileLoc columnNumber, int xslToken)
	Construct a template element instance.
	ElemTemplateElement (StylesheetConstructionContext &constructionContext, Stylesheet &stylesheetTree, int xslToken, const XalanDOMString &baseURI=XalanDOMString(XalanMemMgrs::getDummyMemMgr()), XalanFileLoc lineNumber=XalanLocator::getUnknownValue(), XalanFileLoc columnNumber=XalanLocator::getUnknownValue())
	Special constructor used by dummy elements which do not exist in the final stylesheet.
virtual	~ElemTemplateElement ()
virtual const Locator *	getLocator () const
	Get the Locator for the node.
virtual bool	isAttrOK (const XalanDOMChar *attrName, const AttributeListType &atts, XalanSize_t which, StylesheetConstructionContext &constructionContext) const
	See if this is a xmlns attribute or in a non-XSLT.
bool	processSpaceAttr (const XalanDOMChar *elementName, const XalanDOMChar *aname, const AttributeListType &atts, XalanSize_t which, StylesheetConstructionContext &constructionContext)
	Tell whether or not this is a xml:space attribute and, if so, process it.
virtual void	execute (StylesheetExecutionContext &executionContext) const
	Execute the element.
virtual void	executeChildren (StylesheetExecutionContext &executionContext) const
	Execute the children of this element.
int	getXSLToken () const
virtual bool	isWhitespace () const
	Tell if the element will generate text which is XML whitespace.
virtual void	processSortElement (StylesheetConstructionContext &constructionContext, Stylesheet &theStylesheet, const AttributeListType &atts, const Locator *locator=0)
	Called during compilation to process xsl:sort elements in the stylesheet.
virtual void	setDefaultTemplate (bool value)
	Sets a flag indicating this is the default template.
const NamespacesHandler &	getNamespacesHandler () const
	Get the namespaces handler for this element.
const Stylesheet &	getStylesheet () const
	Retrieve the stylesheet from which this element comes.
void	setFinishedConstruction (bool fValue)
	Set the flag indicating construction of the element is completed.
bool	getFinishedConstruction () const
	Get the flag indicating construction of the element is completed.
virtual void	postConstruction (StylesheetConstructionContext &constructionContext, const NamespacesHandler &theParentHandler)
	Called after construction is completed.
virtual ElemTemplateElement *	getFirstChildElem () const
	Get the first child.
virtual const ElemTemplateElement *	beginExecuteChildren (StylesheetExecutionContext &executionContext) const
	Method to initiate the execution of the element's children.
virtual void	endExecuteChildren (StylesheetExecutionContext &executionContext) const
	Method to indicate the execution of the element's children is complete.
const ElemTemplateElement *	beginChildrenToString (StylesheetExecutionContext &executionContext, XalanDOMString &result) const
	Method to initiate output from the children to a string.
void	endChildrenToString (StylesheetExecutionContext &executionContext) const
	Method to indicate string output from the children is complete.
virtual void	setFirstChildElem (ElemTemplateElement *theChild)
	Set the first child.
virtual ElemTemplateElement *	getLastChildElem () const
	Get the last child.
virtual ElemTemplateElement *	getNextSiblingElem () const
	Get the next sibling.
virtual const ElemTemplateElement *	getNextChildElemToExecute (StylesheetExecutionContext &executionContext, const ElemTemplateElement *currentElem) const
	Returns the next sub-element (i.e.
virtual const ElemTemplateElement *	getFirstChildElemToExecute (StylesheetExecutionContext &executionContext) const
	Returns the first sub-element (i.e.
virtual bool	executeChildElement (StylesheetExecutionContext &executionContext, const ElemTemplateElement *element) const
	Filters sub-elements that should be executed.
virtual void	setNextSiblingElem (ElemTemplateElement *theSibling)
	Set the next sibling.
virtual ElemTemplateElement *	getPreviousSiblingElem () const
	Get the previous sibling.
virtual void	setPreviousSiblingElem (ElemTemplateElement *theSibling)
	Set the previous sibling.
virtual ElemTemplateElement *	getParentNodeElem () const
	Get the parent node.
virtual void	setParentNodeElem (ElemTemplateElement *theParent)
	Set the parent node.
virtual ElemTemplateElement *	appendChildElem (ElemTemplateElement *newChild)
	Append a child.
virtual const XalanDOMString *	getNamespaceForPrefix (const XalanDOMString &prefix) const
	Retrieve a namespace corresponding to a prefix.
virtual const XalanDOMString &	getURI () const
	Retrieve the base URI for the resolver.
XalanFileLoc	getLineNumber () const
XalanFileLoc	getColumnNumber () const
bool	hasParams () const
bool	hasVariables () const
bool	hasSingleTextChild () const
bool	hasChildren () const
bool	hasDirectTemplate () const
bool	canGenerateAttributes () const
bool	isDefaultTemplate () const
Public Member Functions inherited from xalanc::PrefixResolver
	PrefixResolver ()
	PrefixResolver (const PrefixResolver &)
virtual	~PrefixResolver ()

Protected Member Functions
virtual bool	childTypeAllowed (int xslToken) const
	Given an xsl token type, determine whether or not a child of that type is allowed.
Protected Member Functions inherited from xalanc::ElemTemplateElement
void	canGenerateAttributes (bool value)
void	hasPrefix (bool value)
bool	hasPrefix () const
void	preserveSpace (bool value)
bool	preserveSpace () const
void	disableOutputEscaping (bool value)
bool	disableOutputEscaping () const
bool	processPrefixControl (StylesheetConstructionContext &constructionContext, const Stylesheet &stylesheetTree, const XalanDOMString &localName, const XalanDOMChar *attrValue)
	Process the exclude-result-prefixes or the extension-element-prefixes attributes, for the purpose of prefix exclusion.
const XalanDOMString *	getNamespaceForPrefixInternal (const XalanDOMString &prefix) const
	Get the namespace for a given prefix.
virtual const ElemTemplateElement *	findTemplateToTransformChild (StylesheetExecutionContext &executionContext, const ElemTemplateElement &xslInstruction, const ElemTemplateElement *theTemplate, XalanNode *child) const
	Given an element, find the corresponding template.
virtual const ElemTemplateElement *	findTemplateToTransformChild (StylesheetExecutionContext &executionContext, const ElemTemplateElement &xslInstruction, const ElemTemplateElement *theTemplate, XalanNode *child, XalanNode::NodeType nodeType) const
	Given an element, find the corresponding template.
virtual void	namespacesPostConstruction (StylesheetConstructionContext &constructionContext, const NamespacesHandler &theParentHandler, NamespacesHandler &theHandler)
	Called after construction is completed.
const NamespacesHandler &	getNamespaces () const
void	error (StylesheetExecutionContext &theContext, XalanMessages::Codes theCode) const
	A convenience function for loading a message and reporting an error through the provided StylesheetExecutionContext instance.
void	error (StylesheetExecutionContext &theContext, XalanMessages::Codes theCode, const XalanDOMString &theToken) const
	A convenience function for loading a message and reporting an error through the provided StylesheetExecutionContext instance.
void	error (StylesheetExecutionContext &theContext, XalanMessages::Codes theCode, const Locator *theLocator) const
	A convenience function for loading a message and reporting an error through the provided StylesheetExecutionContext instance.
void	warn (StylesheetExecutionContext &theContext, XalanMessages::Codes theCode) const
	A convenience function for loading a message and reporting a warning through the provided StylesheetExecutionContext instance.
void	warn (StylesheetExecutionContext &theContext, XalanMessages::Codes theCode, const XalanDOMString &theToken) const
	A convenience function for loading a message and reporting a warning through the provided StylesheetExecutionContext instance.
void	warn (StylesheetExecutionContext &theContext, XalanMessages::Codes theCode, const Locator *theLocator) const
	A convenience function for loading a message and reporting a warning through the provided StylesheetExecutionContext instance.
void	error (StylesheetConstructionContext &theContext, XalanMessages::Codes theCode)
	A convenience function for loading a message and reporting an error through the provided StylesheetConstructionContext instance.
void	error (StylesheetConstructionContext &theContext, XalanMessages::Codes theCode, const XalanDOMString &theToken)
	A convenience function for loading a message and reporting an error through the provided StylesheetConstructionContext instance.
void	error (StylesheetConstructionContext &theContext, XalanMessages::Codes theCode, const XalanDOMString &theToken, const Locator *theLocator)
	A convenience function for loading a message and reporting an error through the provided StylesheetConstructionContext instance.
void	error (StylesheetConstructionContext &theContext, XalanMessages::Codes theCode, const XalanDOMString &theToken1, const XalanDOMString &theToken2)
	A convenience function for loading a message and reporting an error through the provided StylesheetConstructionContext instance.
void	error (StylesheetConstructionContext &theContext, XalanMessages::Codes theCode, const XalanDOMChar *theToken1, const XalanDOMChar *theToken2)
	A convenience function for loading a message and reporting an error through the provided StylesheetConstructionContext instance.
void	error (StylesheetConstructionContext &theContext, XalanMessages::Codes theCode, const XalanDOMChar *theToken1, const XalanDOMChar *theToken2, const XalanDOMChar *theToken3)
	A convenience function for loading a message and reporting an error through the provided StylesheetConstructionContext instance.
void	warn (StylesheetConstructionContext &theContext, XalanMessages::Codes theCode, const XalanDOMChar *theToken1, const XalanDOMChar *theToken2, const XalanDOMChar *theToken3)
	A convenience function for loading a message and reporting a warning through the provided StylesheetConstructionContext instance.

Additional Inherited Members
Static Public Member Functions inherited from xalanc::ElemTemplateElement
static bool	isValidNCName (const XalanDOMString &s)
	Validate that the string is an NCName.
Static Protected Attributes inherited from xalanc::ElemTemplateElement
static const XalanDOMString	s_emptyString

Detailed Description

Definition at line 43 of file ElemTemplate.hpp.

Member Typedef Documentation

ParentType

typedef ElemTemplateElement xalanc::ElemTemplate::ParentType

Definition at line 47 of file ElemTemplate.hpp.

Constructor & Destructor Documentation

ElemTemplate()

xalanc::ElemTemplate::ElemTemplate	(	StylesheetConstructionContext &	constructionContext,
		Stylesheet &	stylesheetTree,
		const AttributeListType &	atts,
		XalanFileLoc	lineNumber,
		XalanFileLoc	columnNumber
	)

Construct an object corresponding to an "xsl:template" element.

Parameters

constructionContext	context for construction of object
stylesheetTree	stylesheet containing element
atts	list of attributes for element
lineNumber	line number in document
columnNumber	column number in document

~ElemTemplate()

virtual xalanc::ElemTemplate::~ElemTemplate ( )

virtual

Member Function Documentation

addToStylesheet()

virtual void xalanc::ElemTemplate::addToStylesheet ( StylesheetConstructionContext &  constructionContext, Stylesheet &  theStylesheet  )

virtual

Called during compilation when an instance is not parented by another element, and thus, is a child of the stylesheet.

Parameters

constructionContext	The current construction context
theStylesheet	The owning stylesheet

Returns

nothing

Reimplemented from xalanc::ElemTemplateElement.

childTypeAllowed()

virtual bool xalanc::ElemTemplate::childTypeAllowed ( int  xslToken ) const

protectedvirtual

Given an xsl token type, determine whether or not a child of that type is allowed.

This is so derived types can determine whether a particular type of child is allowed for the instance. It is called from appendChildElem().

The default is to allow no types (no children)

Parameters

xslToken

The xsl token value of the child.

Returns

true if the child is allowed, or false if not.

Reimplemented from xalanc::ElemTemplateElement.

endElement()

virtual void xalanc::ElemTemplate::endElement ( StylesheetExecutionContext &  executionContext ) const

virtual

Completes "post-processing" afer any sub-elements are invoked (i.e.

children, attribute sets and templates). If there are no sub-elements it does nothing

Parameters

executionContext

context to execute this element

Reimplemented from xalanc::ElemTemplateElement.

getElementName()

virtual const XalanDOMString & xalanc::ElemTemplate::getElementName ( ) const

virtual

Get a string for the name of the element.

Useful for debugging purposes, and error reporting.

Returns

A string containing the name of the element.

Implements xalanc::ElemTemplateElement.

getInvoker()

virtual const ElemTemplateElement * xalanc::ElemTemplate::getInvoker ( StylesheetExecutionContext &  executionContext ) const

virtual

Returns the element that invoked this element.

Returns

element that invoked this element.

Reimplemented from xalanc::ElemTemplateElement.

getMatchPattern()

const XPath * xalanc::ElemTemplate::getMatchPattern ( ) const

inline

Retrieve the match pattern.

Returns

XPath corresponding to the match pattern

Definition at line 87 of file ElemTemplate.hpp.

getMode()

const XalanQName & xalanc::ElemTemplate::getMode ( ) const

inline

Retrieve the mode of element.

Returns

QName for mode

Definition at line 74 of file ElemTemplate.hpp.

getNameAttribute()

virtual const XalanQName & xalanc::ElemTemplate::getNameAttribute ( ) const

virtual

Get the QName associated with any name attribute of this element.

If the element has no name attribute, this will be an empty QName.

Returns

A string containing the name of the element.

Reimplemented from xalanc::ElemTemplateElement.

getPriority()

double xalanc::ElemTemplate::getPriority ( ) const

inline

Retrieve the priority of element.

Returns

priority value

Definition at line 98 of file ElemTemplate.hpp.

getXPath()

virtual const XPath * xalanc::ElemTemplate::getXPath ( XalanSize_t  index ) const

virtual

Get XPath pattern/expression of one of the element atribute.

@index number of the attribute. If an attribute has more then one attribute with pattern/expression,the order of the returned expressions are undefined

Returns

pointer or null

Reimplemented from xalanc::ElemTemplateElement.

startElement()

virtual const ElemTemplateElement * xalanc::ElemTemplate::startElement ( StylesheetExecutionContext &  executionContext ) const

virtual

Completes "pre-processing" before any sub-elements are invoked (i.e.

children, attribute sets and templates). If there are no sub-elements it executes the primary function of the element.

Parameters

executionContext

context to execute this element

Reimplemented from xalanc::ElemTemplateElement.

---

The documentation for this class was generated from the following file:

• xalanc/XSLT/ElemTemplate.hpp