Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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

StylesheetConstructionContext Class Reference

#include <StylesheetConstructionContext.hpp>

Inheritance diagram for StylesheetConstructionContext

Inheritance graph

[legend]
Collaboration diagram for StylesheetConstructionContext:

Collaboration graph

[legend]
List of all members.

Public Types

Public Methods


Member Typedef Documentation

typedef URISupport::URLAutoPtrType StylesheetConstructionContext::URLAutoPtrType
 


Constructor & Destructor Documentation

StylesheetConstructionContext::StylesheetConstructionContext ( ) [explicit]
 

virtual StylesheetConstructionContext::~StylesheetConstructionContext ( ) [virtual]
 


Member Function Documentation

Stylesheet * StylesheetConstructionContext::create ( StylesheetRoot & theStylesheetRoot,
const XalanDOMString & theBaseIdentifier ) [pure virtual]
 

Create a new Stylesheet instance.

The StylesheetConstructionContext instance owns the Stylesheet instance, and will delete it when asked or when the StylesheetConstructionContext instance is destroyed.

Parameters:
A   reference to the StylesheetRoot instance.
theBaseIdentifier   A URI to the stylesheet file.
Returns:
A pointer to a new StylesheetRoot instance.

Reimplemented in StylesheetConstructionContextDefault.

StylesheetRoot * StylesheetConstructionContext::create ( const XSLTInputSource & theInputSource ) [pure virtual]
 

Create a new StylesheetRoot instance.

The StylesheetConstructionContext instance owns the StylesheetRoot instance, and will delete it when asked or when the StylesheetConstructionContext instance is destroyed.

Parameters:
theInputSource   A reference to the input source.
Returns:
A pointer to a new StylesheetRoot instance.

Reimplemented in StylesheetConstructionContextDefault.

StylesheetRoot * StylesheetConstructionContext::create ( const XalanDOMString & theBaseIdentifier ) [pure virtual]
 

Create a new StylesheetRoot instance.

The StylesheetConstructionContext instance owns the StylesheetRoot instance, and will delete it when asked or when the StylesheetConstructionContext instance is destroyed.

Parameters:
theBaseIdentifier   A URI to the stylesheet file.
Returns:
A pointer to a new StylesheetRoot instance.

Reimplemented in StylesheetConstructionContextDefault.

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

Create and initialize an xpath for a match pattern and return it.

This is to be used by stylesheet elements that need an XPath that is guaranteed to persist while it lives.

Parameters:
str   string to match
resolver   resolver for namespace resolution
Returns:
XPath for match pattern

Reimplemented in StylesheetConstructionContextDefault.

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

Create and initialize an xpath for a match pattern and return it.

This is to be used by stylesheet elements that need an XPath that is guaranteed to persist while it lives.

Parameters:
str   string to match
resolver   resolver for namespace resolution
Returns:
XPath for match pattern

Reimplemented in StylesheetConstructionContextDefault.

XPath * StylesheetConstructionContext::createXPath ( const XalanDOMChar * str,
const PrefixResolver & resolver ) [pure virtual]
 

Create and initialize an xpath and return it.

This is to be used by stylesheet elements that need an XPath that is guaranteed to persist while it lives.

Parameters:
str   string to match
resolver   resolver for namespace resolution
Returns:
XPath for string matched

Reimplemented in StylesheetConstructionContextDefault.

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

Create and initialize an xpath and return it.

This is to be used by stylesheet elements that need an XPath that is guaranteed to persist while it lives.

Parameters:
str   string to match
resolver   resolver for namespace resolution
Returns:
XPath for string matched

Reimplemented in StylesheetConstructionContextDefault.

void StylesheetConstructionContext::destroy ( StylesheetRoot * theStylesheetRoot ) [pure virtual]
 

Destroy a StylesheetRoot instance.

If this StylesheetConstructionContext instance does not own the StylesheetRoot, it will not delete it

Parameters:
theStylesheet   A pointer to the StylesheetRoot instance to delete.

Reimplemented in StylesheetConstructionContextDefault.

virtual void StylesheetConstructionContext::error ( const char * msg,
const XalanNode * sourceNode = 0,
const XalanNode * styleNode = 0 ) const [pure virtual]
 

Tell the user of an error, and probably throw an exception.

Parameters:
msg   text of message to output
sourceNode   node in source where error occurred
styleNode   node in stylesheet where error occurred

Reimplemented from ExecutionContext.

Reimplemented in StylesheetConstructionContextDefault.

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

Tell the user of an error, and probably throw an exception.

Parameters:
msg   text of message to output
sourceNode   node in source where error occurred
styleNode   node in stylesheet where error occurred

Reimplemented from ExecutionContext.

Reimplemented in StylesheetConstructionContextDefault.

int StylesheetConstructionContext::getAttrTok ( const XalanDOMChar * name ) const [pure virtual]
 

Given an XSL tag name, return an integer token that corresponds to ELEMNAME_XXX constants defined in Constants.hpp.

Parameters:
name   a probable xsl:xxx element name
Returns:
Constants.ELEMNAME_XXX token, or -1 if in xsl or Xalan namespace, -2 if not in known namespace

Reimplemented in StylesheetConstructionContextDefault.

int StylesheetConstructionContext::getAttrTok ( const XalanDOMString & name ) const [pure virtual]
 

Given an XSL tag name, return an integer token that corresponds to ELEMNAME_XXX constants defined in Constants.hpp.

Parameters:
name   a probable xsl:xxx element name
Returns:
Constants.ELEMNAME_XXX token, or -1 if in xsl or Xalan namespace, -2 if not in known namespace

Reimplemented in StylesheetConstructionContextDefault.

int StylesheetConstructionContext::getElementToken ( const XalanDOMString & name ) const [pure virtual]
 

Given an XSL tag name, return an integer token that corresponds to ELEMNAME_XXX constants defined in Constants.hpp.

Parameters:
name   a probable xsl:xxx element
Returns:
Constants.ELEMNAME_XXX token, -1 if in XSL or Xalan namespace, or -2 if not in known namespace

Reimplemented in StylesheetConstructionContextDefault.

const Locator * StylesheetConstructionContext::getLocatorFromStack ( ) const [pure virtual]
 

Get the locator from the top of the locator stack.

Returns:
A pointer to the Locator, or 0 if there is nothing on the stack.

Reimplemented in StylesheetConstructionContextDefault.

URLAutoPtrType StylesheetConstructionContext::getURLFromString ( const XalanDOMString & urlString,
const XalanDOMString & base ) [pure virtual]
 

Determine the fully qualified URI for a string.

Parameters:
urlString   string to qualify
base   base location for URI
Returns:
auto pointer to fully qualified URI

Reimplemented in StylesheetConstructionContextDefault.

URLAutoPtrType StylesheetConstructionContext::getURLFromString ( const XalanDOMString & urlString ) [pure virtual]
 

Determine the fully qualified URI for a string.

Parameters:
urlString   string to qualify
Returns:
auto pointer to fully qualified URI

Reimplemented in StylesheetConstructionContextDefault.

XalanDOMString StylesheetConstructionContext::getURLStringFromString ( const XalanDOMString & urlString,
const XalanDOMString & base ) [pure virtual]
 

Determine the fully qualified URI for a string.

Parameters:
urlString   string to qualify
base   base location for URI
Returns:
string to fully qualified URI

Reimplemented in StylesheetConstructionContextDefault.

XalanDOMString StylesheetConstructionContext::getURLStringFromString ( const XalanDOMString & urlString ) [pure virtual]
 

Determine the fully qualified URI for a string.

Parameters:
urlString   string to qualify
Returns:
string to fully qualified URI

Reimplemented in StylesheetConstructionContextDefault.

const XalanDOMString & StylesheetConstructionContext::getXSLTNamespaceURI ( ) const [pure virtual]
 

Retrieve the URI for the current XSLT namespace, for example, "http://www.w3.org/1999/XSL/Transform".

Returns:
URI string

Reimplemented in StylesheetConstructionContextDefault.

double StylesheetConstructionContext::getXSLTVersionSupported ( ) const [pure virtual]
 

Get the latest XSLT version currently supported.

Returns:
XSLT version number

Reimplemented in StylesheetConstructionContextDefault.

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

Get the Xalan namespace for built-in extensions.

Returns:
Xalan namespace for extensions

Reimplemented in StylesheetConstructionContextDefault.

virtual void StylesheetConstructionContext::message ( const char * msg,
const XalanNode * sourceNode = 0,
const XalanNode * styleNode = 0 ) const [pure virtual]
 

Output a message.

Parameters:
msg   text of message to output
sourceNode   node in source where error occurred
styleNode   node in stylesheet where error occurred

Reimplemented from ExecutionContext.

Reimplemented in StylesheetConstructionContextDefault.

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

Output a message.

Parameters:
msg   text of message to output
sourceNode   node in source where error occurred
styleNode   node in stylesheet where error occurred

Reimplemented from ExecutionContext.

Reimplemented in StylesheetConstructionContextDefault.

XalanDocument * StylesheetConstructionContext::parseXML ( const XalanDOMString & urlString,
DocumentHandler * docHandler,
XalanDocument * docToRegister ) [pure virtual]
 

Read in the XML file, either producing a Document or calling SAX events, and register the document in a table.

If the document has already been read in, it will not be reparsed.

Parameters:
urlString   location of the XML
docHandler   pointer to SAX event handler
docToRegister   if using a SAX event handler, the object to register in the source docs table.
Returns:
document object, which represents the parsed XML
Exceptions:
SAXException  

Reimplemented in StylesheetConstructionContextDefault.

void StylesheetConstructionContext::popLocatorStack ( ) [pure virtual]
 

Pop the locator from the top of the locator stack.

Reimplemented in StylesheetConstructionContextDefault.

void StylesheetConstructionContext::pushLocatorOnStack ( const Locator * locator ) [pure virtual]
 

Push a locator on to the locator stack.

Parameters:
A   pointer to the Locator to push.

Reimplemented in StylesheetConstructionContextDefault.

void StylesheetConstructionContext::reset ( ) [pure virtual]
 

Reset the StylesheetConstructionContext instance.

Any existing objects created by the instance will be destroyed.

Reimplemented in StylesheetConstructionContextDefault.

virtual void StylesheetConstructionContext::warn ( const char * msg,
const XalanNode * sourceNode = 0,
const XalanNode * styleNode = 0 ) const [pure virtual]
 

Tell the user of an warning, and probably throw an exception.

Parameters:
msg   text of message to output
sourceNode   node in source where error occurred
styleNode   node in stylesheet where error occurred

Reimplemented from ExecutionContext.

Reimplemented in StylesheetConstructionContextDefault.

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

Tell the user of an warning, and probably throw an exception.

Parameters:
msg   text of message to output
sourceNode   node in source where error occurred
styleNode   node in stylesheet where error occurred

Reimplemented from ExecutionContext.

Reimplemented in StylesheetConstructionContextDefault.


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++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.