Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Types | Public Member Functions | Static Public Member Functions

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>

Inherits Stylesheet.

Collaboration diagram for StylesheetRoot:
Collaboration graph
[legend]

List of all members.

Public Types

Public Member Functions

Static Public Member Functions


Detailed Description

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

Definition at line 63 of file StylesheetRoot.hpp.


Member Typedef Documentation

Definition at line 72 of file StylesheetRoot.hpp.

Definition at line 69 of file StylesheetRoot.hpp.

Definition at line 67 of file StylesheetRoot.hpp.


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

void StylesheetRoot::addAttributeSet ( ElemAttributeSet theAttributeSet  ) 
static StylesheetRoot* StylesheetRoot::create ( MemoryManager &  theManager,
const XalanDOMString baseIdentifier,
StylesheetConstructionContext constructionContext 
) [static]
const ElemAttributeSet* StylesheetRoot::getAttributeSet ( StylesheetExecutionContext theExecutionContext,
const XalanQName theQName,
size_type  matchingIndex,
const Locator *  theLocator 
) const

Get the nth attribute set with the specified name.

Parameters:
execution context for executing this stylesheet
theQName the name of the attribute set
matchingIndex index of the attribute set with the specified name
theLocator the locator
Returns:
a pointer to the attribute, 0 if no matching attribute set
ElemTemplateElement* StylesheetRoot::getDefaultRootRule (  )  const [inline]

Get the template representing the default root rule.

Returns:
pointer to default root template rule

Definition at line 302 of file StylesheetRoot.hpp.

ElemTemplateElement* StylesheetRoot::getDefaultRule (  )  const [inline]

Get the template representing the default rule.

Returns:
pointer to default template rule

Definition at line 291 of file StylesheetRoot.hpp.

ElemTemplateElement* StylesheetRoot::getDefaultTextRule (  )  const [inline]

Get the template representing the default rule for text.

Returns:
pointer to template rule for text

Definition at line 280 of file StylesheetRoot.hpp.

unsigned long StylesheetRoot::getElemNumberCount (  )  const [inline]

Definition at line 415 of file StylesheetRoot.hpp.

bool StylesheetRoot::getHTMLOutputIndent (  )  const [inline]

Determine if output indenting should be enabled for HTML output.

Semantically, this implies the output method is implicit, not explicit, but we don't really check that.

Returns:
true to indent

Definition at line 188 of file StylesheetRoot.hpp.

URLStackType& StylesheetRoot::getImportStack (  )  [inline]

Retrieve the stack of imported stylesheets.

Returns:
stack of URIs for stylesheets

Definition at line 326 of file StylesheetRoot.hpp.

const URLStackType& StylesheetRoot::getImportStack (  )  const [inline]

Retrieve the stack of imported stylesheets.

Returns:
const stack of URIs for stylesheets

Definition at line 337 of file StylesheetRoot.hpp.

MemoryManager& StylesheetRoot::getMemoryManager (  )  [inline]

Reimplemented from Stylesheet.

Definition at line 94 of file StylesheetRoot.hpp.

unsigned long StylesheetRoot::getNextElemNumberID (  )  [inline]

Definition at line 409 of file StylesheetRoot.hpp.

void StylesheetRoot::getNodeSetByKey ( XalanNode context,
const XalanQName qname,
const XalanDOMString ref,
const PrefixResolver resolver,
MutableNodeRefList nodelist,
StylesheetExecutionContext executionContext,
const Locator *  locator,
KeyTablesTableType theKeysTable 
) const

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

Parameters:
context context node
qname 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
resolver resolver for namespace resolution
nodelist A node list to contain the nodes found
executionContext The current execution context
theKeysTable The table of keys to search.
bool StylesheetRoot::getOmitOutputXMLDecl (  )  const [inline]

Determine whether to output XML declarations.

Returns:
true to output declarations

Definition at line 255 of file StylesheetRoot.hpp.

XalanDOMString& StylesheetRoot::getOutputDoctypePublic ( XalanDOMString theResult  )  const [inline]

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

Returns:
document type public id string

Definition at line 242 of file StylesheetRoot.hpp.

XalanDOMString& StylesheetRoot::getOutputDoctypeSystem ( XalanDOMString theResult  )  const [inline]

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

Returns:
document type string

Definition at line 228 of file StylesheetRoot.hpp.

XalanDOMString& StylesheetRoot::getOutputEncoding ( XalanDOMString theResult  )  const [inline]

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

Returns:
encoding string

Definition at line 200 of file StylesheetRoot.hpp.

bool StylesheetRoot::getOutputIndent (  )  const [inline]

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

Returns:
true to indent

Definition at line 173 of file StylesheetRoot.hpp.

XalanDOMString& StylesheetRoot::getOutputMediaType ( XalanDOMString theResult  )  const [inline]

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

Returns:
media type string

Definition at line 214 of file StylesheetRoot.hpp.

FormatterListener::eFormat StylesheetRoot::getOutputMethod (  )  const [inline]

Return the output method that was specified in the stylesheet.

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

Returns:
value of output method

Definition at line 141 of file StylesheetRoot.hpp.

XalanDOMString& StylesheetRoot::getOutputStandalone ( XalanDOMString theResult  )  const [inline]

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

(either "yes" or "no")

Returns:
standalone string

Definition at line 267 of file StylesheetRoot.hpp.

XalanDOMString& StylesheetRoot::getOutputVersion ( XalanDOMString theResult  )  const [inline]

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

Returns:
output version string

Definition at line 159 of file StylesheetRoot.hpp.

bool StylesheetRoot::hasCDATASectionElements (  )  const [inline]

Definition at line 366 of file StylesheetRoot.hpp.

bool StylesheetRoot::hasPreserveOrStripSpaceElements (  )  const [inline]

Definition at line 421 of file StylesheetRoot.hpp.

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 [inline]

Definition at line 147 of file StylesheetRoot.hpp.

virtual 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
outputTarget The output result target
constructionContext context for construction of object
void StylesheetRoot::processOutputSpec ( const XalanDOMChar *  name,
const AttributeListType 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  )  [inline]

Change the value of the flag for indenting results.

Parameters:
bIndent true to indent results

Definition at line 348 of file StylesheetRoot.hpp.

void StylesheetRoot::setOutputMethod ( FormatterListener::eFormat  meth  )  [inline]

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

Parameters:
meth new method number

Definition at line 360 of file StylesheetRoot.hpp.

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.
bool StylesheetRoot::shouldStripSourceNode ( const XalanText theNode  )  const [inline]

Check to see if a whitespace text node should be stripped from the source tree.

Parameters:
theNode The text node to check.

Definition at line 433 of file StylesheetRoot.hpp.


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.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo