Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

StylesheetExecutionContext Class Reference

#include <StylesheetExecutionContext.hpp>

Inheritance diagram for StylesheetExecutionContext:

Inheritance graph
[legend]
Collaboration diagram for StylesheetExecutionContext:

Collaboration graph
[legend]
List of all members.

Public Types

Public Methods

Member Typedef Documentation

typedef XalanVector< TopLevelArg > StylesheetExecutionContext::ParamVectorType<TopLevelArg>
 

typedef std::ostream StylesheetExecutionContext::StreamType
 

typedef XalanMemMgrAutoPtr< XalanNumberFormat, true > StylesheetExecutionContext::XalanNumberFormatAutoPtr<XalanNumberFormat,true>
 

typedef size_t StylesheetExecutionContext::tl_size_type
 

Member Enumeration Documentation

enum StylesheetExecutionContext::eDummy
 

Enumeration values:
eDefaultXMLIndentAmount  
eDefaultHTMLIndentAmount  

enum StylesheetExecutionContext::eEscapeURLs
 

Enums to determine whether or not run-time escaping of URLs has been set.

Enumeration values:
eEscapeURLsDefault  
eEscapeURLsNo  
eEscapeURLsYes  

enum StylesheetExecutionContext::eOmitMETATag
 

Enums to determine whether or not run-time omission of the META tag has been set.

Enumeration values:
eOmitMETATagDefault  
eOmitMETATagNo  
eOmitMETATagYes  

Constructor & Destructor Documentation

StylesheetExecutionContext::StylesheetExecutionContext ( MemoryManagerType & m_memoryManager,
XObjectFactory * theXObjectFactory = 0 ) [explicit]
 

StylesheetExecutionContext::~StylesheetExecutionContext ( ) [virtual]
 

Member Function Documentation

void StylesheetExecutionContext::addResultAttribute ( const XalanDOMString & aname,
const XalanDOMChar * value ) [pure virtual]
 

Add a result attribute to the list of pending attributes.

Parameters:
aname   name of attribute
value   value of attribute

void StylesheetExecutionContext::addResultAttribute ( const XalanDOMString & aname,
const XalanDOMString & value ) [pure virtual]
 

Add a result attribute to the list of pending attributes.

Parameters:
aname   name of attribute
value   value of attribute

void StylesheetExecutionContext::beginCreateXResultTreeFrag ( XalanNode * sourceNode ) [pure virtual]
 

Initiate creation of a result tree fragment.

Parameters:
sourceNode   the source Node

void StylesheetExecutionContext::beginFormatToText ( XalanDOMString & theResult ) [pure virtual]
 

Initiate to put execution result in string.

Parameters:
theResult   the string to contain the result

void StylesheetExecutionContext::beginParams ( ) [pure virtual]
 

Initiate context to accept a new set of parameters.

MutableNodeRefList * StylesheetExecutionContext::borrowMutableNodeRefList ( ) [pure virtual]
 

Borrow a cached MutableNodeRefList instance.

Returns:
A pointer to the instance.

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::characters ( const XObjectPtr & xobject ) [pure virtual]
 

Send character data from an XObject to the result tree.

Parameters:
node   The xobject to send.

void StylesheetExecutionContext::characters ( const XalanNode & node ) [pure virtual]
 

Send character data from a node to the result tree.

Parameters:
node   The node to send.

void StylesheetExecutionContext::characters ( const XalanDOMChar * ch,
XalanDOMString::size_type start,
XalanDOMString::size_type length ) [pure virtual]
 

Receive notification of character data.

Parameters:
ch   pointer to characters from the XML document
start   start position in the array
length   number of characters to read from the array

void StylesheetExecutionContext::charactersRaw ( const XObjectPtr & xobject ) [pure virtual]
 

Send raw character data from an XObject to the result tree.

Parameters:
node   The xobject to send.

void StylesheetExecutionContext::charactersRaw ( const XalanNode & node ) [pure virtual]
 

Send raw character data from a node to the result tree.

Parameters:
node   The node to send.
length   number of characters to read from the array

void StylesheetExecutionContext::charactersRaw ( const XalanDOMChar * ch,
XalanDOMString::size_type start,
XalanDOMString::size_type length ) [pure virtual]
 

Receive notification of character data.

If available, when the disable-output-escaping attribute is used, output raw text without escaping.

Parameters:
ch   pointer to characters from the XML document
start   start position in the array
length   number of characters to read from the array

void StylesheetExecutionContext::clearTopLevelParams ( ) [pure virtual]
 

Reset the vector of top level parameters.

void StylesheetExecutionContext::cloneToResultTree ( const XalanNode & node,
XalanNode::NodeType nodeType,
bool overrideStrip,
bool shouldCloneAttributes,
const LocatorType * locator ) [pure virtual]
 

Clone a node to the result tree.

Parameters:
node   node to clone
nodeType   the type of the node
overrideStrip   false if white space stripping should be done
shouldCloneAttributes   true if attributes should be cloned
locator   The Locator, if any

void StylesheetExecutionContext::cloneToResultTree ( const XalanNode & node,
const LocatorType * locator ) [pure virtual]
 

Clone a node to the result tree.

Parameters:
node   node to clone
locator   The Locator, if any

int StylesheetExecutionContext::collationCompare ( const XalanDOMChar * theLHS,
const XalanDOMChar * theRHS,
const XalanDOMChar * theLocale,
XalanCollationServices::eCaseOrder theCaseOrder = XalanCollationServices::eDefault ) [pure virtual]
 

Compare two strings using the collation of the current locale.

Parameters:
theLHS   a string to compare
theRHS   a string to compare
theLocal   a string that specifies the locale
theCaseOrder   the case order for the comparison
Returns:
< 0 if theLHS is before theRHS, 0 if they are equal, or > 0 if theLHS is after theRHS

int StylesheetExecutionContext::collationCompare ( const XalanDOMChar * theLHS,
const XalanDOMChar * theRHS,
XalanCollationServices::eCaseOrder theCaseOrder = XalanCollationServices::eDefault ) [pure virtual]
 

Compare two strings using the collation of the current locale.

Parameters:
theLHS   a string to compare
theRHS   a string to compare
theCaseOrder   the case order for the comparison
Returns:
< 0 if theLHS is before theRHS, 0 if they are equal, or > 0 if theLHS is after theRHS

int StylesheetExecutionContext::collationCompare ( const XalanDOMString & theLHS,
const XalanDOMString & theRHS,
const XalanDOMString & theLocale,
XalanCollationServices::eCaseOrder theCaseOrder = XalanCollationServices::eDefault ) [pure virtual]
 

Compare two strings using the collation of the supplied locale.

Parameters:
theLHS   a string to compare
theRHS   a string to compare
theLocal   a string that specifies the locale
theCaseOrder   the case order for the comparison
Returns:
< 0 if theLHS is before theRHS, 0 if they are equal, or > 0 if theLHS is after theRHS

int StylesheetExecutionContext::collationCompare ( const XalanDOMString & theLHS,
const XalanDOMString & theRHS,
XalanCollationServices::eCaseOrder theCaseOrder = XalanCollationServices::eDefault ) [pure virtual]
 

Compare two strings using the collation of the current locale.

Parameters:
theLHS   a string to compare
theRHS   a string to compare
theCaseOrder   the case order for the comparison
Returns:
< 0 if theLHS is before theRHS, 0 if they are equal, or > 0 if theLHS is after theRHS

void StylesheetExecutionContext::comment ( const XalanDOMChar * data ) [pure virtual]
 

Called when a Comment is to be constructed.

Parameters:
data   pointer to comment data

void StylesheetExecutionContext::copyNamespaceAttributes ( const XalanNode & src ) [pure virtual]
 

Add namespace attributes for a node to the list of pending attributes.

Parameters:
src   source node

MutableNodeRefList & StylesheetExecutionContext::createAndPushMutableNodeRefList ( ) [pure virtual]
 

void StylesheetExecutionContext::createAndPushNodesToTransformList ( const NodeRefListBase * nodeList ) [pure virtual]
 

FormatterListener * StylesheetExecutionContext::createFormatterToHTML ( Writer & writer,
const XalanDOMString & encoding = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
const XalanDOMString & mediaType = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
const XalanDOMString & doctypeSystem = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
const XalanDOMString & doctypePublic = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
bool doIndent = true,
int indent = eDefaultHTMLIndentAmount,
bool escapeURLs = true,
bool omitMetaTag = false ) [pure virtual]
 

Create a new FormatterToHTML instance.

The execution context owns the instance and will delete it when reset.

Parameters:
writer   character output stream to use
encoding   character encoding for the writer
mediaType   media type (MIME content type) of the data
doctypeSystem   system identifier to be used in the document type declaration
doctypePublic   public identifier to be used in the document type declaration
doIndent   true if output is to be indented
indent   number of spaces to indent at each nesting level
escapeURLs   Whether or not to escape URLs according to the recommendation. The default is true.
omitMetaTag   Whether or not to output a META TAG according to the recommendation. The default is false.
Returns:
a pointer to the new instance.

FormatterListener * StylesheetExecutionContext::createFormatterToText ( Writer & writer,
const XalanDOMString & encoding ) [pure virtual]
 

FormatterToText instance constructor.

Parameters:
writer   writer for output
encoding   character encoding for the writer

FormatterListener * StylesheetExecutionContext::createFormatterToXML ( Writer & writer,
const XalanDOMString & version = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
bool doIndent = false,
int indent = eDefaultXMLIndentAmount,
const XalanDOMString & encoding = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
const XalanDOMString & mediaType = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
const XalanDOMString & doctypeSystem = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
const XalanDOMString & doctypePublic = XalanDOMString(XalanMemMgrs::getDummyMemMgr()),
bool xmlDecl = true,
const XalanDOMString & standalone = XalanDOMString(XalanMemMgrs::getDummyMemMgr()) ) [pure virtual]
 

Create a new FormatterToXML instance.

The execution context owns the instance and will delete it when reset.

Parameters:
writer   character output stream to use
version   version of the output method
doIndent   true if output is to be indented
indent   number of spaces to indent at each nesting level
encoding   character encoding for the writer
mediaType   media type (MIME content type) of the data
doctypeSystem   system identifier to be used in the document type declaration
doctypePublic   public identifier to be used in the document type declaration
xmlDecl   true if the XSLT processor should output an XML declaration
standalone   true if the XSLT processor should output a standalone document declaration
Returns:
a pointer to the new instance.

const XPath * StylesheetExecutionContext::createMatchPattern ( const XalanDOMString & str,
const PrefixResolver & resolver ) [pure virtual]
 

Create and initialize an xpath and return it.

This is to be used to create an XPath that is only used during execution.

Parameters:
str   string expression for XPath evaluation
resolver   resolver for namespace resolution
Returns:
pointer to resulting XPath

MutableNodeRefList * StylesheetExecutionContext::createMutableNodeRefList ( MemoryManagerType & theManager ) const [pure virtual]
 

Create a MutableNodeRefList with the appropriate context.

Returns:
pointer to node list created

Reimplemented from XPathExecutionContext.

PrintWriter * StylesheetExecutionContext::createPrintWriter ( FILE * theStream ) [pure virtual]
 

Create a PrintWriter using the provided FILE instance.

Parameters:
theStream   The output stream for the PrintWriter.
Returns:
The new instance.

PrintWriter * StylesheetExecutionContext::createPrintWriter ( StreamType & theStream ) [pure virtual]
 

Create a PrintWriter using the provided ostream instance.

Parameters:
theStream   The output stream for the PrintWriter.
Returns:
The new instance.

PrintWriter * StylesheetExecutionContext::createPrintWriter ( const XalanDOMString & theFileName,
const XalanDOMString & theEncoding ) [pure virtual]
 

Create a PrintWriter.

Create an appropriate output stream using the provided file name and encoding.

Parameters:
theFileName   The file name for the output stream
theEncoding   The encoding for the output stream
Returns:
The new instance.

PrintWriter * StylesheetExecutionContext::createPrintWriter ( XalanOutputStream * theTextOutputStream ) [pure virtual]
 

Create a PrintWriter for the provided stream.

Parameters:
theTextOutputStream   The output stream for the PrintWriter.
Returns:
The new instance.

void StylesheetExecutionContext::createUseAttributeSetIndexesOnStack ( ) [pure virtual]
 

const XObjectPtr StylesheetExecutionContext::createVariable ( const XPath & xpath,
XalanNode * contextNode,
const PrefixResolver & resolver ) [pure virtual]
 

Execute the supplied XPath and and create a variable in the current context.

Parameters:
str   string expression for XPath evaluation
contextNode   current node in the source tree
resolver   resolver for namespace resolution
Returns:
a pointer to the XObject result

XalanNumberFormatAutoPtr StylesheetExecutionContext::createXalanNumberFormat ( ) [pure virtual]
 

Create a new XalanNumberFormat instance.

Returns:
an XalanNumberFormatAutoPtr that owns a new XalanNumberFormat instance.

bool StylesheetExecutionContext::elementAvailable ( const XalanDOMString & theName,
const LocatorType * locator ) const [pure virtual]
 

Determine if an external element is available by resolving a string to a QName.

Parameters:
theName   The name of the element
locator   A LocatorType instance for error reporting

Returns:
whether the given element is available or not

Reimplemented from XPathExecutionContext.

bool StylesheetExecutionContext::elementAvailable ( const XalanQName & theQName ) const [pure virtual]
 

Determine if an external element is available.

Parameters:
theQName   The QName of the element

Returns:
whether the given element is available or not

Reimplemented from XPathExecutionContext.

const XObjectPtr StylesheetExecutionContext::endCreateXResultTreeFrag ( ) [pure virtual]
 

Indicate sthe completion of result tree fragment.

Returns:
a pointer to the result tree fragment

void StylesheetExecutionContext::endDocument ( ) [pure virtual]
 

Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Exceptions:
SAXException  

void StylesheetExecutionContext::endElement ( const XalanDOMChar * name ) [pure virtual]
 

Receive notification of the end of an element.

Parameters:
name   element type name

void StylesheetExecutionContext::endFormatToText ( ) [pure virtual]
 

Indicates the completion of the result string.

void StylesheetExecutionContext::endParams ( ) [pure virtual]
 

Indicate parameter set is complete.

void StylesheetExecutionContext::error ( const XalanDOMString & msg,
const XalanNode * sourceNode,
const LocatorType * locator ) const [pure virtual]
 

Report an error and throw an exception.

Parameters:
msg   The text of the message.
sourceNode   The source node where the error occurred. May be 0.
locator   A Locator to determine where the error occurred. May be 0.

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::error ( const XalanDOMString & msg,
const ElemTemplateElement & styleNode,
const XalanNode * sourceNode = 0 ) const [pure virtual]
 

Report an error and throw an exception.

Parameters:
msg   The text of the message.
styleNode   The stylesheet node were the error occurred.
sourceNode   The source node where the error occurred. May be 0.

const XObjectPtr StylesheetExecutionContext::extFunction ( const XalanDOMString & theNamespace,
const XalanDOMString & functionName,
XalanNode * context,
const XObjectArgVectorType & argVec,
const LocatorType * locator ) [pure virtual]
 

Handle an extension function.

Parameters:
theNamespace   namespace of function
functionName   extension function name
context   The context node
argVec   vector of arguments to function
locator   A LocatorType instance for error reporting
Returns:
pointer to XObject result

Reimplemented from XPathExecutionContext.

bool StylesheetExecutionContext::findOnElementRecursionStack ( const ElemTemplateElement * theElement ) const [pure virtual]
 

Determine if an element is on the recursion stack.

Returns:
true if element on stack

const XalanDOMString & StylesheetExecutionContext::findURIFromDoc ( const XalanDocument * owner ) const [pure virtual]
 

Given a DOM Document, tell what URI was used to parse it.

Needed for relative resolution.

Parameters:
owner   source document
Returns:
document URI

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::fireGenerateEvent ( const GenerateEvent & ge ) [pure virtual]
 

Fire a generate event.

Parameters:
ge   generate event to fire

void StylesheetExecutionContext::fireSelectEvent ( const SelectionEvent & se ) [pure virtual]
 

Fire a selection event.

Parameters:
se   selection event to fire

void StylesheetExecutionContext::fireTraceEvent ( const TracerEvent & te ) [pure virtual]
 

Fire a trace event.

Parameters:
te   trace event to fire

void StylesheetExecutionContext::flushPending ( ) [pure virtual]
 

Flush the pending element.

void StylesheetExecutionContext::formatNumber ( double number,
const XalanDOMString & pattern,
const XalanDOMString & dfsName,
XalanDOMString & theResult,
const XalanNode * context = 0,
const LocatorType * locator = 0 ) [pure virtual]
 

Formats a number according to the specified pattern.

Parameters:
number   the number to be formatted
pattern   the format pattern
dfsName   the name of decimal format to use
theResult   the formatted number
context   the source node
locator   the locator
Returns:
a pointer to the functor, 0 if none was found

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::formatNumber ( double number,
const XalanDOMString & pattern,
XalanDOMString & theResult,
const XalanNode * context = 0,
const LocatorType * locator = 0 ) [pure virtual]
 

Formats a number according to the specified pattern.

Parameters:
number   the number to be formatted
pattern   the format pattern
theResult   the formatted number
context   the source node
locator   the locator

Reimplemented from XPathExecutionContext.

bool StylesheetExecutionContext::functionAvailable ( const XalanDOMString & theName,
const LocatorType * locator ) const [pure virtual]
 

Determine if a function is available.

Parameters:
theName   The name of the function
locator   A LocatorType instance for error reporting

Returns:
whether the function is available or not

Reimplemented from XPathExecutionContext.

bool StylesheetExecutionContext::functionAvailable ( const XalanQName & theQName ) const [pure virtual]
 

Determine if a function is available.

Parameters:
theQName   The QName of the function

Returns:
whether the function is available or not

Reimplemented from XPathExecutionContext.

XalanDOMString & StylesheetExecutionContext::getAndPopCachedString ( ) [pure virtual]
 

Gets the last string to be cached on the stack and pops it from the stack.

The reference is valid until the next request is made for a cached string

Returns:
the last string to be cached

XalanDOMString & StylesheetExecutionContext::getAndPushCachedString ( ) [pure virtual]
 

Get a string that is cached on a stack.

Returns:
a cached string

XalanDOMString & StylesheetExecutionContext::getCachedString ( ) [pure virtual]
 

Get a cached string for temporary use.

Returns:
A reference to the string

Reimplemented from XPathExecutionContext.

const NodeRefListBase & StylesheetExecutionContext::getContextNodeList ( ) const [pure virtual]
 

Get the node list for current context.

Returns:
node list

Reimplemented from XPathExecutionContext.

size_type StylesheetExecutionContext::getContextNodeListLength ( ) const [pure virtual]
 

Reimplemented from XPathExecutionContext.

size_type StylesheetExecutionContext::getContextNodeListPosition ( const XalanNode & contextNode ) const [pure virtual]
 

Reimplemented from XPathExecutionContext.

bool StylesheetExecutionContext::getCopyTextNodesOnly ( ) const [pure virtual]
 

If this function returns true, only text nodes can be copied to the result tree.

Returns:
true or false

CountersTable & StylesheetExecutionContext::getCountersTable ( ) [pure virtual]
 

Get the counters table, which is a table of cached results that is used by ElemNumber.

Returns:
A reference to the counters table.

const XalanQName * StylesheetExecutionContext::getCurrentMode ( ) const [pure virtual]
 

Retrieve the current mode.

Returns:
QName for mode

XalanNode * StylesheetExecutionContext::getCurrentNode ( ) const [pure virtual]
 

Retrieve the node currently being executed.

Returns:
current node

Reimplemented from XPathExecutionContext.

int StylesheetExecutionContext::getCurrentStackFrameIndex ( ) const [pure virtual]
 

Get the top of the stack frame from where a search for a variable or param should take place.

Returns:
current value of index

const ElemTemplate * StylesheetExecutionContext::getCurrentTemplate ( ) const [pure virtual]
 

Retrieve the current template.

Returns:
The current template instance or null if there is no current template

eEscapeURLs StylesheetExecutionContext::getEscapeURLs ( ) const [pure virtual]
 

Get the value for run-time escaping of URLs.

This can override the property specified by the stylesheet. The default behavior is to honor the property in the stylesheet.

Returns:
The value of the enum

FormatterListener * StylesheetExecutionContext::getFormatterListener ( ) const [pure virtual]
 

Get the current formatter listener.

Returns:
pointer to formatter listener

int StylesheetExecutionContext::getGlobalStackFrameIndex ( ) const [pure virtual]
 

Get the top of the global stack frame.

Returns:
current value of index

int StylesheetExecutionContext::getIndent ( ) const [pure virtual]
 

Retrieve the current number of spaces to indent.

Returns:
number of spaces

const ElemTemplateElement * StylesheetExecutionContext::getInvoker ( ) const [pure virtual]
 

Get the lastest element that has invoked a non-child element.

XalanDOMString & StylesheetExecutionContext::getLastCachedString ( ) [pure virtual]
 

Gets the last string that was cached on the stack.

Returns:
the last string to be cached

const XalanDOMString * StylesheetExecutionContext::getNamespaceForPrefix ( const XalanDOMString & prefix ) const [pure virtual]
 

Retrieve the URI corresponding to a namespace prefix.

Parameters:
prefix   prefix for a namespace
Returns:
URI corresponding to namespace

Reimplemented from XPathExecutionContext.

XalanNode * StylesheetExecutionContext::getNextNodeToTransform ( ) [pure virtual]
 

void StylesheetExecutionContext::getNodeSetByKey ( XalanDocument * doc,
const XalanDOMString & name,
const XalanDOMString & ref,
const LocatorType * locator,
MutableNodeRefList & nodelist ) [pure virtual]
 

Given a valid element key, return the corresponding node list.

Parameters:
doc   source document
name   name of the key, which must match the 'name' attribute on xsl:key. Will be resolved to a qname using the provided resolver.
ref   value that must match the value found by the 'match' attribute on xsl:key
locator   The LocatorType to use for error reporting. Can be 0.
nodelist   A node list to contain the nodes found

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::getNodeSetByKey ( XalanDocument * doc,
const XalanQName & qname,
const XalanDOMString & ref,
MutableNodeRefList & nodelist ) [pure virtual]
 

Given a valid element key, return the corresponding node list.

Parameters:
doc   source document
name   qname of the key, which must match the 'name' attribute on xsl:key
ref   value that must match the value found by the 'match' attribute on xsl:key
nodelist   A node list to contain the nodes found

Reimplemented from XPathExecutionContext.

NodeSorter * StylesheetExecutionContext::getNodeSorter ( ) [pure virtual]
 

Get node sorter instance.

eOmitMETATag StylesheetExecutionContext::getOmitMETATag ( ) const [pure virtual]
 

Get the value for run-time omission of URLs.

This can override the property specified by the stylesheet. The default behavior is to honor the property in the stylesheet.

Returns:
The value of the enum

const XObjectPtr StylesheetExecutionContext::getParamVariable ( const XalanQName & theName ) [pure virtual]
 

Given a name, return a string representing the value, but don't look in the global space.

Parameters:
theName   name of variable
Returns:
An XObjectPtr instance. Call XObjectPtr::null() on the instance to determine if the variable was found. If XObjectPtr::null() returns true, the variable was not found, and no other operations on the XObject instance are permitted.

const PrefixResolver * StylesheetExecutionContext::getPrefixResolver ( ) const [pure virtual]
 

Retrieve the resolver for namespaces.

Returns:
object for namespace resolution

Reimplemented from XPathExecutionContext.

bool StylesheetExecutionContext::getQuietConflictWarnings ( ) const [pure virtual]
 

Determine whether conflicts should be reported.

Returns:
true if conflicts should not be warned

const XalanDOMString * StylesheetExecutionContext::getResultNamespaceForPrefix ( const XalanDOMString & thePrefix ) const [pure virtual]
 

Retrieve the result namespace corresponding to a prefix.

Parameters:
thePrefix   prefix for namespace

Returns:
A pointer to a string containing the namespace, or 0 if the prefix is not mapped.

const XalanDOMString * StylesheetExecutionContext::getResultPrefixForNamespace ( const XalanDOMString & theNamespace ) const [pure virtual]
 

Retrieve the result prefix corresponding to a namespace.

Parameters:
theNamespace   namespace for prefix

Returns:
A pointer to a string containing the prefix, or 0 if the namespace is not mapped.

XalanNode * StylesheetExecutionContext::getRootDocument ( ) const [pure virtual]
 

Retrieve root document for stylesheet.

Note that this does not have to be a XalanDocument -- it can be any node in a document.

Returns:
root document

bool StylesheetExecutionContext::getSkipElementAttributes ( ) const [pure virtual]
 

Get the last flag setting that determines if an element's attributes should be skipped.

Returns:
the value of the flag

XalanDocument * StylesheetExecutionContext::getSourceDocument ( const XalanDOMString & theURI ) const [pure virtual]
 

Get the document associated with the given URI.

Parameters:
theURI   document URI
Returns:
a pointer to the document instance, if any.

Reimplemented from XPathExecutionContext.

tl_size_type StylesheetExecutionContext::getTraceListeners ( ) const [pure virtual]
 

Determine the number of trace listeners.

Returns:
number of listeners

bool StylesheetExecutionContext::getTraceSelects ( ) const [pure virtual]
 

If this is set to true, simple traces of template calls are made.

Returns:
true if traces made

void StylesheetExecutionContext::getUniqueNamespaceValue ( XalanDOMString & theValue ) const [pure virtual]
 

Generate a random namespace prefix guaranteed to be unique.

Parameters:
theValue   A string for returning the new prefix

const XalanDOMString & StylesheetExecutionContext::getUnparsedEntityURI ( const XalanDOMString & theName,
const XalanDocument & theDocument ) const [pure virtual]
 

The getUnparsedEntityURI function returns the URI of the unparsed entity with the specified name in the same document as the context node (see [3.3 Unparsed Entities]).

It returns the empty string if there is no such entity.

Parameters:
theName   name of entity
theDocument   document containing entity
Returns:
URI for the entity

Reimplemented from XPathExecutionContext.

UseAttributeSetIndexes & StylesheetExecutionContext::getUseAttributeSetIndexes ( ) [pure virtual]
 

const XObjectPtr StylesheetExecutionContext::getVariable ( const XalanQName & name,
const LocatorType * locator = 0 ) [pure virtual]
 

Given a name, locate a variable in the current context, and return a pointer to the object.

Parameters:
theName   name of variable
Returns:
An XObjectPtr instance. If the variable is not found, an exception is thrown, or the routine returns an instance of XUnknown.

Reimplemented from XPathExecutionContext.

const XalanDOMString & StylesheetExecutionContext::getXSLNameSpaceURL ( ) const [pure virtual]
 

Determine the full XSLT Namespace URI.

Returns:
Xalan namespace URI

const XalanDOMString & StylesheetExecutionContext::getXalanXSLNameSpaceURL ( ) const [pure virtual]
 

Special Xalan namespace for built-in extensions.

Returns:
Xalan namespace for extensions

bool StylesheetExecutionContext::isElementPending ( ) const [pure virtual]
 

See if there is an element pending.

bool StylesheetExecutionContext::isNodeAfter ( const XalanNode & node1,
const XalanNode & node2 ) const [pure virtual]
 

Determine if a node is after another node, in document order.

Parameters:
node1   The first node
node2   The second node
Returns:
true if node1 one is after node2, or false if it is not.

Reimplemented from XPathExecutionContext.

bool StylesheetExecutionContext::isPendingResultPrefix ( const XalanDOMString & thePrefix ) [pure virtual]
 

Determine whether or not a prefix is in use on the pending element or the pending attributes.

Parameters:
thePrefix   prefix for namespace

Returns:
true if the prefix is in use, false if not.

void StylesheetExecutionContext::message ( const XalanDOMString & msg,
const XalanNode * sourceNode = 0,
const LocatorType * locator = 0 ) const [pure virtual]
 

Output a message.

Parameters:
msg   The text of the message.
sourceNode   The source node where the message occurred. May be 0.
locator   A Locator to determine where the message occurred. May be 0.

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::message ( const XalanDOMString & msg,
const ElemTemplateElement & styleNode,
const XalanNode * sourceNode = 0 ) const [pure virtual]
 

Report a message.

Parameters:
msg   The text of the message.
styleNode   The stylesheet node were the message occurred.
sourceNode   The source node where the message occurred. May be 0.

void StylesheetExecutionContext::outputResultTreeFragment ( const XObject & theTree,
const LocatorType * locator ) [pure virtual]
 

Given a result tree fragment, walk the tree and output it to the result stream.

Parameters:
theTree   result tree fragment
locator   The Locator, if any

void StylesheetExecutionContext::outputToResultTree ( const XObject & xobj,
const LocatorType * locator ) [pure virtual]
 

Output an object to the result tree by doing the right conversions.

This is public for access by extensions.

Parameters:
obj   the XObject to output
locator   The Locator, if any

XalanDocument * StylesheetExecutionContext::parseXML ( MemoryManagerType & theManager,
const XalanDOMString & urlString,
const XalanDOMString & base ) const [pure virtual]
 

Provides support for XML parsing service.

Parameters:
urlString   location of the XML
base   base location for URI
Returns:
parsed document

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::popContextMarker ( ) [pure virtual]
 

Pop the current context from the current context stack.

void StylesheetExecutionContext::popContextNodeList ( ) [pure virtual]
 

Pop the node list for current context.

Reimplemented from XPathExecutionContext.

bool StylesheetExecutionContext::popCopyTextNodesOnly ( ) [pure virtual]
 

Pop the last flag setting that determines if only text nodes can be copied to the result tree.

void StylesheetExecutionContext::popCurrentMode ( ) [pure virtual]
 

Pop the current mode.

void StylesheetExecutionContext::popCurrentNode ( ) [pure virtual]
 

Reset the node currently being executed.

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::popCurrentStackFrameIndex ( ) [pure virtual]
 

Pop the last stack frame index setting.

void StylesheetExecutionContext::popCurrentTemplate ( ) [pure virtual]
 

void StylesheetExecutionContext::popElementFrame ( ) [pure virtual]
 

Pop a frame marker for an element.

Parameters:
elem   the element

const ElemTemplateElement * StylesheetExecutionContext::popElementRecursionStack ( ) [pure virtual]
 

Pop an element off the recursion stack.

Returns:
pointer to element popped

bool StylesheetExecutionContext::popExecuteIf ( ) [pure virtual]
 

Pop the flag that determines if the if test was true.

Parameters:
executeIf   the value of the flag

void StylesheetExecutionContext::popInvoker ( ) [pure virtual]
 

Pop the element that invoked non children elements.

void StylesheetExecutionContext::popNodesToTransformList ( ) [pure virtual]
 

void StylesheetExecutionContext::popOutputContext ( ) [pure virtual]
 

bool StylesheetExecutionContext::popProcessCurrentAttribute ( ) [pure virtual]
 

Pops the last flag setting that determines if the current attribute should be executed.

bool StylesheetExecutionContext::popSkipElementAttributes ( ) [pure virtual]
 

Pops the last flag setting that determines if an element's attributes should be skipped.

void StylesheetExecutionContext::popUseAttributeSetIndexesFromStack ( ) [pure virtual]
 

void StylesheetExecutionContext::popXObjectPtr ( ) [pure virtual]
 

void StylesheetExecutionContext::processingInstruction ( const XalanDOMChar * target,
const XalanDOMChar * data ) [pure virtual]
 

Receive notification of a processing instruction.

Parameters:
target   processing instruction target
data   processing instruction data, or null if none was supplied

void StylesheetExecutionContext::pushContextMarker ( ) [pure virtual]
 

Push a context marker onto the stack to let us know when to stop searching for a var.

void StylesheetExecutionContext::pushContextNodeList ( const NodeRefListBase & theList ) [pure virtual]
 

Push the node list for current context.

Parameters:
theList   new node list

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::pushCopyTextNodesOnly ( bool copyTextNodesOnly ) [pure virtual]
 

Set the flag that determines if only text nodes can be copied to the result tree.

Parameters:
copyTextNodesOnly   The value of the flag

void StylesheetExecutionContext::pushCurrentMode ( const XalanQName * theMode ) [pure virtual]
 

Set the current mode.

Parameters:
theMode   QName for mode

void StylesheetExecutionContext::pushCurrentNode ( XalanNode * theCurrentNode ) [pure virtual]
 

Change the node currently being executed.

Parameters:
theCurrentNode   new current node

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::pushCurrentStackFrameIndex ( int currentStackFrameIndex = -1 ) [pure virtual]
 

Set the top of the stack frame from where a search for a variable or param should take place.

Parameters:
currentStackFrameIndex   new value of index

void StylesheetExecutionContext::pushCurrentTemplate ( const ElemTemplate * theTemplate ) [pure virtual]
 

Set the current template.

Parameters:
theTemplate   The current template instance

void StylesheetExecutionContext::pushElementFrame ( const ElemTemplateElement * elem ) [pure virtual]
 

Push a frame marker for an element.

Parameters:
elem   the element

void StylesheetExecutionContext::pushExecuteIf ( bool executeIf ) [pure virtual]
 

Set flag that determines if the if test was true.

Parameters:
executeIf   the value of the flag

void StylesheetExecutionContext::pushInvoker ( const ElemTemplateElement * invoker ) [pure virtual]
 

Push the element that will invoke non children elements (i.e templates, attribute-sets).

Parameters:
invokers   the element that will invoke non children elements

void StylesheetExecutionContext::pushOnElementRecursionStack ( const ElemTemplateElement * theElement ) [pure virtual]
 

Push an element onto the recursion stack.

Parameters:
theElement   pointer to element to push

void StylesheetExecutionContext::pushOutputContext ( FormatterListener * flistener = 0 ) [pure virtual]
 

void StylesheetExecutionContext::pushParam ( const XalanQName & qName,
const XObjectPtr & theValue ) [pure virtual]
 

Push a single paramter onto the latest initialized paramter set.

Parameters:
qName   the name of the parameter
theValue   the value of the parameter

void StylesheetExecutionContext::pushProcessCurrentAttribute ( bool processAttribute ) [pure virtual]
 

Set the flag that determines if the current attribute should be executed.

Parameters:
processAttribute   the value of the flag

void StylesheetExecutionContext::pushSkipElementAttributes ( bool skipAttributes ) [pure virtual]
 

Set the flag that determines if an element's attributes should be skipped.

Parameters:
skipAttributes   the value of the flag

void StylesheetExecutionContext::pushTopLevelVariables ( const ParamVectorType & topLevelParams ) [pure virtual]
 

Set a list of top level variables in the specified execution context stylesheet.

Parameters:
topLevelParams   list of top level parameters

void StylesheetExecutionContext::pushVariable ( const XalanQName & name,
const ElemVariable * var,
const ElemTemplateElement * element ) [pure virtual]
 

Push a named variable onto the processor variable stack The variable will be evaluated when first referenced.

Parameters:
name   name of variable
var   pointer to ElemVariable instance
element   element marker for variable

void StylesheetExecutionContext::pushVariable ( const XalanQName & name,
const XObjectPtr val,
const ElemTemplateElement * element ) [pure virtual]
 

Push a named variable onto the variables stack.

The variable has already been evaluated.

Parameters:
name   name of variable
val   pointer to XObject value
element   element marker for variable

void StylesheetExecutionContext::pushVariable ( const XalanQName & name,
const ElemTemplateElement * element,
const XPath & xpath,
XalanNode * contextNode,
const PrefixResolver & resolver ) [pure virtual]
 

Execute the supplied XPath and push the result as a variable in the current context.

Parameters:
name   name of variable
element   element marker for variable
str   string expression for XPath evaluation
contextNode   current node in the source tree
resolver   resolver for namespace resolution
Returns:
nothing

void StylesheetExecutionContext::pushVariable ( const XalanQName & name,
const ElemTemplateElement * element,
const XalanDOMString & str,
XalanNode * contextNode,
const PrefixResolver & resolver ) [pure virtual]
 

Execute an XPath using the provided expression, and push the result as a variable in the context of the supplied element.

Parameters:
name   name of variable
element   element marker for variable
str   string expression for XPath evaluation
contextNode   current node in the source tree
resolver   resolver for namespace resolution
Returns:
nothing

void StylesheetExecutionContext::pushXObjectPtr ( const XObjectPtr & xobjectPtr ) [pure virtual]
 

void StylesheetExecutionContext::releaseAndPopMutableNodeRefList ( ) [pure virtual]
 

bool StylesheetExecutionContext::releaseCachedString ( XalanDOMString & theString ) [pure virtual]
 

Return a cached string.

Parameters:
theString   The string to release.

Returns:
true if the string was released successfully.

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::replacePendingAttribute ( const XalanDOMChar * theName,
const XalanDOMChar * theNewType,
const XalanDOMChar * theNewValue ) [pure virtual]
 

Replace the contents of a pending attribute.

Parameters:
theName   name of attribute
theNewType   type of attribute
theNewValue   new value of attribute

void StylesheetExecutionContext::reset ( ) [pure virtual]
 

Reset the instance.

This must be called before another execution is attempted.

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::resolveTopLevelParams ( ) [pure virtual]
 

Resolve the params that were pushed by the caller.

bool StylesheetExecutionContext::returnMutableNodeRefList ( MutableNodeRefList * theList ) [pure virtual]
 

Return a previously borrowed MutableNodeRefList instance.

Parameters:
theList   A pointer the to previously borrowed instance.
Returns:
true if the list was borrowed (at therefore, destroyed), false if not.

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::returnXPath ( const XPath * xpath ) [pure virtual]
 

Return the XPath created by createMatchPattern().

Parameters:
xpath   The XPath to return.

bool StylesheetExecutionContext::returnXResultTreeFrag ( XResultTreeFrag * theXResultTreeFrag ) [pure virtual]
 

This is a hook that XResultTreeFrag instances (which are reference counted), can notify the owning StylesheetExecutionContext instance when they are dereferenced and can be cleaned up.

Parameters:
theXResultTreeFrag   The instance that is being returned.

Returns:
true if the XResultTreeFrag instance belongs to the execution context. false if not.

void StylesheetExecutionContext::setEscapeURLs ( eEscapeURLs value ) [pure virtual]
 

Set the value for run-time escaping of URLs.

This can override the property specified by the stylesheet. The default behavior is to honor the property in the stylesheet.

Parameters:
value   The value of the enum

void StylesheetExecutionContext::setFormatterListener ( FormatterListener * flistener ) [pure virtual]
 

Set the current formatter listener.

Parameters:
flistener   pointer to new formatter listener

void StylesheetExecutionContext::setIndent ( int indentAmount ) [pure virtual]
 

Set the current number of spaces to indent.

Parameters:
indentAmount   The number of spaces to indent. Use -1 for the default amount.

void StylesheetExecutionContext::setOmitMETATag ( eOmitMETATag value ) [pure virtual]
 

Get the value for run-time omission of URLs.

This can override the property specified by the stylesheet. The default behavior is to honor the property in the stylesheet.

Parameters:
value   The value of the enum

void StylesheetExecutionContext::setPrefixResolver ( const PrefixResolver * thePrefixResolver ) [pure virtual]
 

Change the resolver for namespaces.

Parameters:
thePrefixResolver   new object for namespace resolution

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::setRootDocument ( XalanNode * theDocument ) [pure virtual]
 

Set root document for stylesheet.

Note that this does not have to be a XalanDocument -- it can be any node in a document.

Parameters:
theDocument   root document

void StylesheetExecutionContext::setSourceDocument ( const XalanDOMString & theURI,
XalanDocument * theDocument ) [pure virtual]
 

Associate a document with a given URI.

Parameters:
theURI   document URI
theDocument   source document

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::setStylesheetRoot ( const StylesheetRoot * theStylesheet ) [pure virtual]
 

Set root stylesheet for stylesheet.

Parameters:
theStylesheet   root stylesheet

bool StylesheetExecutionContext::shouldStripSourceNode ( const XalanText & node ) [pure virtual]
 

Tells, through the combination of the default-space attribute on xsl:stylesheet, xsl:strip-space, xsl:preserve-space, and the xml:space attribute, whether or not extra whitespace should be stripped from the node.

Literal elements from template elements should not be tested with this function.

Parameters:
textNode   text node from the source tree
Returns:
true if the text node should be stripped of extra whitespace

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::startDocument ( ) [pure virtual]
 

Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).

Exceptions:
SAXException  

void StylesheetExecutionContext::startElement ( const XalanDOMChar * name ) [pure virtual]
 

Receive notification of the beginning of an element.

Parameters:
name   element type name

void StylesheetExecutionContext::traceSelect ( const ElemTemplateElement & theStylesheetElement,
const NodeRefListBase & nl,
const XPath * xpath ) [pure virtual]
 

Compose a diagnostic trace of the current selection.

Parameters:
theStylesheetElement   The executing stylesheet element
nl   The list of selected nodes
xpath   A pointer to the XPath which generated the list of nodes, if any.

void StylesheetExecutionContext::warn ( const XalanDOMString & msg,
const XalanNode * sourceNode = 0,
const LocatorType * locator = 0 ) const [pure virtual]
 

Report a warning.

Parameters:
msg   The text of the message.
sourceNode   The source node where the warning occurred. May be 0.
locator   A Locator to determine where the warning occurred. May be 0.

Reimplemented from XPathExecutionContext.

void StylesheetExecutionContext::warn ( const XalanDOMString & msg,
const ElemTemplateElement & styleNode,
const XalanNode * sourceNode = 0 ) const [pure virtual]
 

Report a warning.

Parameters:
msg   The text of the message.
styleNode   The stylesheet node were the warning occurred.
sourceNode   The source node where the warning occurred. May be 0.

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

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo