Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Classes | Public Member Functions

XMLParserLiaison Class Reference

#include <XMLParserLiaison.hpp>

Inherited by XalanSourceTreeParserLiaison, and XercesParserLiaison.

List of all members.

Classes

Public Member Functions


Detailed Description

Definition at line 65 of file XMLParserLiaison.hpp.


Constructor & Destructor Documentation

XMLParserLiaison::XMLParserLiaison (  ) 
virtual XMLParserLiaison::~XMLParserLiaison (  )  [virtual]

Member Function Documentation

virtual void XMLParserLiaison::destroyDocument ( XalanDocument theDocument  )  [pure virtual]

Destroy the supplied XalanDocument instance.

It must be an instance that was created by a previous call to parseXMLStream().

Parameters:
theDocument The XalanDocument instance to destroy.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual EntityResolver* XMLParserLiaison::getEntityResolver (  )  const [pure virtual]

This method returns the installed EntityResolver.

Returns:
The pointer to the installed EntityResolver object.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual ErrorHandler* XMLParserLiaison::getErrorHandler (  )  const [pure virtual]

This method returns the installed error handler.

Returns:
The pointer to the installed error handler object.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual ExecutionContext* XMLParserLiaison::getExecutionContext (  )  const [pure virtual]

Get a pointer to the current ExecutionContext instance, which may be null.

Returns:
A pointer to the current ExecutionContext, if any.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

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

Get the amount to indent when indent-result="yes".

Deprecated:
Returns:
number of characters to indent

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual MemoryManager& XMLParserLiaison::getMemoryManager (  )  [pure virtual]

Get a reference to the current MemoryManager instance.

Returns:
A pointer to the current ExecutionContext, if any.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual const XalanDOMString& XMLParserLiaison::getParserDescription ( XalanDOMString theResult  )  const [pure virtual]

Return a string suitable for telling the user what parser is being used.

Returns:
string describing parser

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual bool XMLParserLiaison::getUseValidation (  )  const [pure virtual]

Get whether or not validation will be performed.

Validation is off by default.

Returns:
true to perform validation

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual XMLEntityResolver* XMLParserLiaison::getXMLEntityResolver (  )  const [pure virtual]

This method returns the installed XMLEntityResolver.

Returns:
The pointer to the installed XMLEntityResolver object.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual XalanDocument* XMLParserLiaison::parseXMLStream ( const InputSource &  inputSource,
const XalanDOMString identifier 
) [pure virtual]

Parse the text pointed at by the reader as XML, and return a DOM Document interface.

It is recommended that you pass in some sort of recognizable name, such as the filename or URI, with which the reader can be recognized if the parse fails.

The liaison owns the XalanDocument instance, and will delete it when asked (see DestroyDocument()), or when the liaison is reset, or goes out of scope.

This function is not reentrant, so you cannot call it again until the current call exits.

Parameters:
reader stream that should hold valid XML
identifier used for diagnostic purposes only, some sort of identification for error reporting, default an empty string
Returns:
DOM document created

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::parseXMLStream ( const InputSource &  inputSource,
DocumentHandler &  handler,
const XalanDOMString identifier 
) [pure virtual]

Parse the text pointed at by the reader as XML.

It is recommended that you pass in some sort of recognizable name, such as the filename or URI, with which the reader can be recognized if the parse fails.

This function is reentrant, so you can call it again before any other call exits. However, it is not thread-safe.

Parameters:
inputSource input source that should hold valid XML
handler instance of a DocumentHandler
identifier used for diagnostic purposes only, some sort of identification for error reporting, default an empty string

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::reset (  )  [pure virtual]

Reset the instance, freeing any XalanDocument instances created through parseXMLStream().

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::setEntityResolver ( EntityResolver *  resolver  )  [pure virtual]

This method installs the user-specified EntityResolver on the parser.

It allows applications to trap and redirect calls to external entities.

A call to setEntityResolver with a non-null pointer will uninstall any XMLEntityResolver previously installed.

Parameters:
handler A pointer to the EntityResolver to be called when the parser encounters references to external entities.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::setErrorHandler ( ErrorHandler *  handler  )  [pure virtual]

This method installs the user-specified error handler.

Parameters:
handler A pointer to the error handler to be called upon error.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::setExecutionContext ( ExecutionContext theContext  )  [pure virtual]

Set the current ExecutionContext instance.

theContext A reference to the new ExecutionContext instance.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::setIndent ( int  i  )  [pure virtual]

Set the amount to indent when indent-result="yes".

Deprecated:
Parameters:
i number of characters to indent

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::setUseValidation ( bool  b  )  [pure virtual]

If set to true, validation will be performed.

Validation is off by default.

Parameters:
b true to perform validation

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::setXMLEntityResolver ( XMLEntityResolver *  resolver  )  [pure virtual]

This method installs the user-specified XMLEntityResolver on the parser.

It allows applications to trap and redirect calls to external entities.

A call to setXMLEntityResolver with a non-null pointer will uninstall any EntityResolver previously installed.

Parameters:
handler A pointer to the entity resolver to be called when the parser encounters references to external entities.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.


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