Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

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

StylesheetRoot Class Reference

This acts as the stylesheet root of the stylesheet tree, and holds values that are shared by all stylesheets in the tree. More...

#include <StylesheetRoot.hpp>

Inheritance diagram for StylesheetRoot:

Stylesheet XalanDocument PrefixResolver XalanNode Collaboration diagram for StylesheetRoot:

List of all members.

Public Methods

Public Attributes


Detailed Description

This acts as the stylesheet root of the stylesheet tree, and holds values that are shared by all stylesheets in the tree.


Constructor & Destructor Documentation

StylesheetRoot::StylesheetRoot ( const XalanDOMString & baseIdentifier,
StylesheetConstructionContext & constructionContext)

Construct a Stylesheet from a Document.

Parameters:
baseIdentifier   document identifier
constructionContext   context for construction of object

virtual StylesheetRoot::~StylesheetRoot () [virtual]


Member Function Documentation

ElemTemplate * StylesheetRoot::getDefaultRootRule () const

Get the template representing the default root rule.

Returns:
pointer to default root template rule

ElemTemplate * StylesheetRoot::getDefaultRule () const

Get the template representing the default rule.

Returns:
pointer to default template rule

ElemTemplate * StylesheetRoot::getDefaultTextRule () const

Get the template representing the default rule for text.

Returns:
pointer to template rule for text

const URLStackType & StylesheetRoot::getImportStack () const

Retrieve the stack of imported stylesheets.

Returns:
const stack of URIs for stylesheets

URLStackType & StylesheetRoot::getImportStack ()

Retrieve the stack of imported stylesheets.

Returns:
stack of URIs for stylesheets

void StylesheetRoot::getNodeSetByKey ( XalanNode * doc,
const XalanDOMString & name,
const XalanDOMString & ref,
const PrefixResolver & resolver,
MutableNodeRefList & nodelist,
StylesheetExecutionContext & executionContext,
KeyTablesTableType & theKeysTable) const

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
ref   value that must match the value found by the 'match' attribute on xsl:key
resolver   resolver for namespace resolution
nodelist   A node list to contain the nodes found
executionContext   current execution context

bool StylesheetRoot::getOmitOutputXMLDecl () const

Determine whether to output XML declarations.

Returns:
true to output declarations

XalanDOMString StylesheetRoot::getOutputDoctypePublic () const

Get the doctype-public-id string that was specified in the xsl:output element.

Returns:
document type public id string

XalanDOMString StylesheetRoot::getOutputDoctypeSystem () const

Get the doctype-system-id string that was specified in the xsl:output element.

Returns:
document type string

XalanDOMString StylesheetRoot::getOutputEncoding () const

Get the output encoding string that was specified in the xsl:output element.

Returns:
encoding string

bool StylesheetRoot::getOutputIndent () const

Determine if output indenting was specified in the xsl:output element.

Returns:
true to indent

XalanDOMString StylesheetRoot::getOutputMediaType () const

Get the media-type string that was specified in the xsl:output element.

Returns:
media type string

FormatterListener::eFormat StylesheetRoot::getOutputMethod () const

Return the output method that was specified in the stylesheet.

The returned value is one of FormatterLister::eFormat values.

Returns:
value of output method

XalanDOMString StylesheetRoot::getOutputStandalone () const

Get the standalone string that was specified in the xsl:output element.(either "yes" or "no").

Returns:
standalone string

XalanDOMString StylesheetRoot::getOutputVersion () const

Get the output version string that was specified in the xsl:output element.

Returns:
output version string

bool StylesheetRoot::hasCDATASectionElements () const

void StylesheetRoot::initDefaultRule ( StylesheetConstructionContext & constructionContext)

Create the default rule if needed.

Parameters:
constructionContext   context for construction of object

bool StylesheetRoot::isCDATASectionElementName ( const XalanQName & theQName) const

Determine if a QName is in the list of CDATA section element QNames.

Parameters:
theQName   The QName of the element to check.
Returns:
true or false

bool StylesheetRoot::isOutputMethodSet () const

void StylesheetRoot::postConstruction ( StylesheetConstructionContext & constructionContext) [virtual]

Called after construction is completed.

Reimplemented from Stylesheet.

void StylesheetRoot::process ( XalanNode * sourceTree,
XSLTResultTarget & outputTarget,
StylesheetExecutionContext & executionContext) const

Transform the source tree to the output in the given result tree target.

Parameters:
inputSource   The input source tree
outputTarget   The output source tree
constructionContext   context for construction of object

void StylesheetRoot::processOutputSpec ( const XalanDOMChar * name,
const AttributeList & atts,
StylesheetConstructionContext & constructionContext)

Process the "xsl:output" element.

Parameters:
name   name of element
atts   attribute list for element
constructionContext   context for construction of object

void StylesheetRoot::setIndentResult ( bool bIndent)

Change the value of the flag for indenting results.

Parameters:
bIndent   true to indent results

void StylesheetRoot::setOutputMethod ( FormatterListener::eFormat meth)

Change the value of the output method, one of the FormatterListener::eFormat values.

Parameters:
meth   new method number

FormatterListener * StylesheetRoot::setupFormatterListener ( XSLTResultTarget & outputTarget,
StylesheetExecutionContext & executionContext) const

Have the stylesheet create the appropriate FormatterListener, based on the XSLTResultTarget provided.

setupFormatterListener also calls setFormatterListener() on the execution context instance. setupFormatterListener() is done automatically by process(), but this is provided as an escape, to allow for changing the FormatterListener on-the-fly.

Parameters:
outputTarget   The output source tree
constructionContext   context for construction of object
Returns:
a pointer to the new FormatterListener instance.

Member Data Documentation

XalanDOMString StylesheetRoot::m_doctypePublic

If doctype-public-id attribute is also specified, then the xml output method should output PUBLIC followed by the public identifier and then the system identifier; otherwise, it should output SYSTEM followed by the system identifier.

The internal subset should be empty. The doctype-public-id attribute should be ignored unless the doctype-system-id attribute is specified.

XalanDOMString StylesheetRoot::m_doctypeSystem

If the doctype-system-id attribute is specified, the xml output method should output a document type declaration immediately before the first element.

The name following <!DOCTYPE should be the name of the first element.

XalanDOMString StylesheetRoot::m_encoding

The encoding attribute specifies the preferred encoding to use for outputting the result tree.

bool StylesheetRoot::m_indentResult

indent-result is by default no, which means an XSL processor must not change the whitespace on output.

XalanDOMString StylesheetRoot::m_mediatype

The media-type attribute is applicable for the xml output method.

The default value for the media-type attribute is text/xml.

bool StylesheetRoot::m_omitxmlDecl

Tells whether or not to output an XML declaration.

XalanDOMString StylesheetRoot::m_standalone

Tells what the xmldecl should specify for the standalone value.

XalanDOMString StylesheetRoot::m_version

The version tells the version of XML to be used for outputting the result tree, as specified in xsl:output.


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.

Xalan-C++ XSLT Processor Version 1.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.