Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Types | Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
ProblemListenerBase Class Referenceabstract

This is the abstract class that is used when reporting a problem some kind, that requires a message, an error or a warning. More...

#include <ProblemListenerBase.hpp>

Inherited by ExecutionContext, ProblemListener, XPathConstructionContext, XPathEnvSupport, and XSLTProcessor.

Public Types

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

 ProblemListenerBase ()
 
virtual ~ProblemListenerBase ()
 
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...
 

Static Public Member Functions

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

static const XalanMessages::Codes s_messageCodes [eSourceCount][eClassificationCount]
 

Detailed Description

This is the abstract class that is used when reporting a problem some kind, that requires a message, an error or a warning.

Definition at line 53 of file ProblemListenerBase.hpp.

Member Typedef Documentation

◆ eProblemSource

Definition at line 68 of file ProblemListenerBase.hpp.

Member Enumeration Documentation

◆ eClassification

Enumerator
eMESSAGE 
eMessage 
eWARNING 
eWarning 
eERROR 
eError 
eClassificationCount 

Definition at line 72 of file ProblemListenerBase.hpp.

◆ eSource

Enumerator
eXMLPARSER 
eXMLParser 
eXSLPROCESSOR 
eXSLTProcessor 
eXPATH 
eXPath 
eSourceCount 

Definition at line 59 of file ProblemListenerBase.hpp.

Constructor & Destructor Documentation

◆ ProblemListenerBase()

ProblemListenerBase::ProblemListenerBase ( )

◆ ~ProblemListenerBase()

virtual ProblemListenerBase::~ProblemListenerBase ( )
virtual

Member Function Documentation

◆ defaultFormat() [1/2]

static void ProblemListenerBase::defaultFormat ( PrintWriter pw,
eSource  source,
eClassification  classification,
const XalanDOMString msg,
const Locator *  locator,
const XalanNode sourceNode 
)
static

Function to format a problem call to a PrintWriter instance.

This is a bare-bones implementation that uses localized strings.

Parameters
pwThe PrintWriter instance to use.
sourceEither eXMLParser, eXSLProcessor, or eXPATH.
classificationEither eMessage, eWarning, or eError.
locatorThe current Locator instance for the stylesheet. Maybe be a null pointer.
sourceNodeThe current source node, if any.
msgThe error message.

◆ defaultFormat() [2/2]

static void ProblemListenerBase::defaultFormat ( PrintWriter pw,
eSource  source,
eClassification  classification,
const XalanDOMString msg,
const XalanNode sourceNode 
)
static

Function to format a problem call to a PrintWriter instance.

This is a bare-bones implementation that uses localized strings.

Parameters
pwThe PrintWriter instance to use.
sourceeither eXMLPARSER, eXSLPROCESSOR, or eXPATH
classificationeither eMESSAGE, eERROR or eWARNING
msgstring message explaining the problem.

◆ problem() [1/2]

virtual void ProblemListenerBase::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
sourceEither eXMLParser, eXSLProcessor, or eXPATH.
classificationEither eMessage, eWarning, or eError.
locatorThe current Locator instance for the stylesheet. Maybe be a null pointer.
sourceNodeThe current source node, if any.
msgThe error message.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, XPathExecutionContext, XPathExecutionContextDefault, XSLTEngineImpl, StylesheetConstructionContext, StylesheetConstructionContextDefault, XSLTProcessorEnvSupportDefault, XSLTProcessor, XalanTransformerProblemListener, XPathEnvSupportDefault, XPathEnvSupport, ExecutionContext, XPathConstructionContext, ProblemListenerDefault, XPathConstructionContextDefault, ProblemListener, and XSLTProcessorEnvSupport.

◆ problem() [2/2]

virtual void ProblemListenerBase::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
sourceeither eXMLPARSER, eXSLPROCESSOR, or eXPATH
classificationeither eMESSAGE, eERROR or eWARNING
msgstring message explaining the problem.

Implemented in StylesheetExecutionContext, StylesheetExecutionContextDefault, XPathExecutionContext, XPathExecutionContextDefault, XSLTEngineImpl, StylesheetConstructionContext, StylesheetConstructionContextDefault, XSLTProcessorEnvSupportDefault, XSLTProcessor, XalanTransformerProblemListener, XPathEnvSupportDefault, XPathEnvSupport, ExecutionContext, XPathConstructionContext, ProblemListenerDefault, XPathConstructionContextDefault, ProblemListener, and XSLTProcessorEnvSupport.

Member Data Documentation

◆ s_messageCodes

const XalanMessages::Codes ProblemListenerBase::s_messageCodes[eSourceCount][eClassificationCount]
staticprotected

Definition at line 156 of file ProblemListenerBase.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