xalanc::ProblemListener Class Reference

This is the abstract class that the XSL processor uses when it has a problem of some kind, that requires a message, an error or a warning. More...

#include <xalanc/XSLT/ProblemListener.hpp>

Inheritance diagram for xalanc::ProblemListener:

Collaboration diagram for xalanc::ProblemListener:

Public Types
typedef eSource	eProblemSource
Public Types inherited from xalanc::ProblemListenerBase
enum	eSource {   eXMLPARSER = 0, eXMLParser = 0, eXSLPROCESSOR = 1, eXSLTProcessor = 1,   eXPATH = 2, eXPath = 2, eSourceCount }
enum	eClassification {   eMESSAGE = 0, eMessage = 0, eWARNING = 1, eWarning = 1,   eERROR = 2, eError = 2, eClassificationCount }
typedef eSource	eProblemSource

Public Member Functions
	ProblemListener ()
virtual	~ProblemListener ()
virtual void	setPrintWriter (PrintWriter *pw)=0
virtual void	problem (eSource source, eClassification classification, const XalanDOMString &msg, const Locator *locator, const XalanNode *sourceNode)=0
	Function that is called when a problem event occurs. More...
virtual void	problem (eSource source, eClassification classification, const XalanDOMString &msg, const XalanNode *sourceNode)=0
	Function that is called when a problem event occurs. More...
virtual void	problem (eSource source, eClassification classification, const XalanNode *sourceNode, const ElemTemplateElement *styleNode, const XalanDOMString &msg, const XalanDOMChar *uri, XalanFileLoc lineNo, XalanFileLoc charOffset)=0
	Function that is called when a problem event occurs. More...
Public Member Functions inherited from xalanc::ProblemListenerBase
	ProblemListenerBase ()
virtual	~ProblemListenerBase ()

Additional Inherited Members
Static Public Member Functions inherited from xalanc::ProblemListenerBase
static void	defaultFormat (PrintWriter &pw, eSource source, eClassification classification, const XalanDOMString &msg, const Locator *locator, const XalanNode *sourceNode)
	Function to format a problem call to a PrintWriter instance. More...
static void	defaultFormat (PrintWriter &pw, eSource source, eClassification classification, const XalanDOMString &msg, const XalanNode *sourceNode)
	Function to format a problem call to a PrintWriter instance. More...
Static Protected Attributes inherited from xalanc::ProblemListenerBase
static const XalanMessages::Codes	s_messageCodes [eSourceCount][eClassificationCount]

Detailed Description

This is the abstract class that the XSL processor uses when it has a problem of some kind, that requires a message, an error or a warning.

Users should ask the XSLTProcessor class to setProblemListener if they wish an object instance to be called when a problem event occurs.

Definition at line 48 of file ProblemListener.hpp.

Member Typedef Documentation

eProblemSource

typedef eSource xalanc::ProblemListener::eProblemSource

Definition at line 53 of file ProblemListener.hpp.

Constructor & Destructor Documentation

ProblemListener()

xalanc::ProblemListener::ProblemListener

(

)

~ProblemListener()

virtual xalanc::ProblemListener::~ProblemListener ( )

virtual

Member Function Documentation

problem() [1/3]

virtual void xalanc::ProblemListener::problem ( eSource  source, eClassification  classification, const XalanDOMString &  msg, const Locator *  locator, const XalanNode *  sourceNode  )

pure virtual

Function that is called when a problem event occurs.

Parameters

source	Either eXMLParser, eXSLProcessor, or eXPATH.
classification	Either eMessage, eWarning, or eError.
locator	The current Locator instance for the stylesheet. Maybe be a null pointer.
sourceNode	The current source node, if any.
msg	The error message.

Implements xalanc::ProblemListenerBase.

Implemented in xalanc::XalanTransformerProblemListener, and xalanc::ProblemListenerDefault.

problem() [2/3]

virtual void xalanc::ProblemListener::problem ( eSource  source, eClassification  classification, const XalanDOMString &  msg, const XalanNode *  sourceNode  )

pure virtual

Function that is called when a problem event occurs.

This version assumes location information is already formatted into the message.

Parameters

source	either eXMLPARSER, eXSLPROCESSOR, or eXPATH
classification	either eMESSAGE, eERROR or eWARNING
msg	string message explaining the problem.

Implements xalanc::ProblemListenerBase.

Implemented in xalanc::XalanTransformerProblemListener, and xalanc::ProblemListenerDefault.

problem() [3/3]

virtual void xalanc::ProblemListener::problem ( eSource  source, eClassification  classification, const XalanNode *  sourceNode, const ElemTemplateElement *  styleNode, const XalanDOMString &  msg, const XalanDOMChar *  uri, XalanFileLoc  lineNo, XalanFileLoc  charOffset  )

pure virtual

Function that is called when a problem event occurs.

This function is deprecated. Use the overload with the Locator parameter instead.

Deprecated:

Parameters

source	either eXMLPARSER, eXSLPROCESSOR, or eXPATH
classification	either eMESSAGE, eERROR or eWARNING
sourceNode	source tree node where the problem occurred (may be 0)
styleNode	style tree node where the problem occurred (may be 0)
msg	string message explaining the problem.
uri	the URI of the document where the problem occurred. May be 0.
lineNo	line number where the problem occurred.
charOffset	character offset where the problem.

Implemented in xalanc::ProblemListenerDefault, and xalanc::XalanTransformerProblemListener.

setPrintWriter()

virtual void xalanc::ProblemListener::setPrintWriter ( PrintWriter *  pw )

pure virtual

Implemented in xalanc::ProblemListenerDefault, and xalanc::XalanTransformerProblemListener.

---

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

• xalanc/XSLT/ProblemListener.hpp