#include <XercesParserLiaison.hpp>
Inherits XMLParserLiaison, and ErrorHandler.
Classes | |
struct | DocumentEntry |
Public Types | |
typedef XERCES_CPP_NAMESPACE_QUALIFIER SAXParser | SAXParserType |
typedef XalanMap< const XalanDocument *, DocumentEntry > | DocumentMapType |
typedef XERCES_CPP_NAMESPACE_QUALIFIER XercesDOMParser | DOMParserType |
Public Member Functions | |
XercesParserLiaison (XercesDOMSupport &theSupport, MemoryManager &theManager XALAN_DEFAULT_MEMMGR) | |
Construct a XercesParserLiaison instance. More... | |
XercesParserLiaison (MemoryManager &theManager XALAN_DEFAULT_MEMMGR) | |
Construct a XercesParserLiaison instance. More... | |
virtual | ~XercesParserLiaison () |
MemoryManager & | getMemoryManager () |
Get a reference to the current MemoryManager instance. More... | |
virtual void | reset () |
Reset the instance, freeing any XalanDocument instances created through parseXMLStream(). More... | |
virtual ExecutionContext * | getExecutionContext () const |
Get a pointer to the current ExecutionContext instance, which may be null. More... | |
virtual void | setExecutionContext (ExecutionContext &theContext) |
Set the current ExecutionContext instance. More... | |
virtual XalanDocument * | parseXMLStream (const InputSource &reader, const XalanDOMString &identifier=XalanDOMString(XalanMemMgrs::getDummyMemMgr())) |
Parse the text pointed at by the reader as XML, and return a DOM Document interface. More... | |
virtual void | parseXMLStream (const InputSource &urlInputSource, DocumentHandler &handler, const XalanDOMString &identifier=XalanDOMString(XalanMemMgrs::getDummyMemMgr())) |
Parse the text pointed at by the reader as XML. More... | |
virtual void | destroyDocument (XalanDocument *theDocument) |
Destroy the supplied XalanDocument instance. More... | |
virtual int | getIndent () const |
Get the amount to indent when indent-result="yes". More... | |
virtual void | setIndent (int i) |
Set the amount to indent when indent-result="yes". More... | |
virtual bool | getUseValidation () const |
Get whether or not validation will be performed. More... | |
virtual void | setUseValidation (bool b) |
If set to true, validation will be performed. More... | |
virtual const XalanDOMString & | getParserDescription (XalanDOMString &theResult) const |
Return a string suitable for telling the user what parser is being used. More... | |
virtual EntityResolver * | getEntityResolver () const |
This method returns the installed EntityResolver. More... | |
virtual void | setEntityResolver (EntityResolver *resolver) |
This method installs the user-specified EntityResolver on the parser. More... | |
virtual XMLEntityResolver * | getXMLEntityResolver () const |
This method returns the installed XMLEntityResolver. More... | |
virtual void | setXMLEntityResolver (XMLEntityResolver *resolver) |
This method installs the user-specified XMLEntityResolver on the parser. More... | |
virtual ErrorHandler * | getErrorHandler () const |
This method returns the installed error handler. More... | |
virtual void | setErrorHandler (ErrorHandler *handler) |
This method installs the user-specified error handler. More... | |
virtual DOMDocument_Type * | createDOMFactory () |
Create an instance of the Xerces default document that is suitable as a raw document. More... | |
virtual void | destroyDocument (DOMDocument_Type *theDocument) |
Destroy an instance created by a call to createDOMFactory(). More... | |
virtual bool | getIncludeIgnorableWhitespace () const |
Get the 'include ignorable whitespace' flag. More... | |
virtual void | setIncludeIgnorableWhitespace (bool include) |
Set the 'include ignorable whitespace' flag. More... | |
virtual bool | getDoNamespaces () const |
This method returns the state of the parser's namespace handling capability. More... | |
virtual void | setDoNamespaces (bool newState) |
This method allows users to enable or disable the parser's namespace processing. More... | |
virtual bool | getExitOnFirstFatalError () const |
This method returns the state of the parser's exit-on-First-Fatal-Error flag. More... | |
virtual void | setExitOnFirstFatalError (bool newState) |
This method allows users to set the parser's behaviour when it encounters the first fatal error. More... | |
virtual const XalanDOMChar * | getExternalSchemaLocation () const |
This method returns the location for an external schema document for parsing. More... | |
virtual void | setExternalSchemaLocation (const XalanDOMChar *location) |
This method sets the location for an external schema document for parsing. More... | |
virtual const XalanDOMChar * | getExternalNoNamespaceSchemaLocation () const |
This method returns the location for an external schema document for parsing. More... | |
virtual void | setExternalNoNamespaceSchemaLocation (const XalanDOMChar *location) |
This method sets the location for an external schema document for parsing. More... | |
XalanDocument * | createDocument (const DOMDocument_Type *theXercesDocument) |
Create a XalanDocument proxy for an existing Xerces document. More... | |
XalanDocument * | createDocument (const DOMDocument_Type *theXercesDocument, bool threadSafe, bool buildWrapper, bool buildMaps=false) |
Create a XalanDocument proxy for an existing Xerces document. More... | |
XercesDocumentWrapper * | mapDocumentToWrapper (const XalanDocument *theDocument) const |
Map a pointer to a XalanDocument instance to its implementation class pointer. More... | |
const DOMDocument_Type * | mapToXercesDocument (const XalanDocument *theDocument) const |
Map a pointer to a XalanDocument instance to its corresponding class pointer. More... | |
virtual void | warning (const SAXParseExceptionType &exception) |
virtual void | error (const SAXParseExceptionType &exception) |
virtual void | fatalError (const SAXParseExceptionType &exception) |
virtual void | resetErrors () |
bool | getBuildBridgeNodes () const |
This API is deprecated. More... | |
void | setBuildBridgeNodes (bool newState) |
This API is deprecated. More... | |
bool | getBuildWrapperNodes () const |
This functions returns the state of the liaison's build-wrapper-nodes flag. More... | |
void | setBuildWrapperNodes (bool newState) |
This functions sets the state of the liaison's build-wrapper-nodes flag. More... | |
bool | getThreadSafe () const |
This functions returns the state of the liaison's thread-safe flag. More... | |
void | setThreadSafe (bool newState) |
This functions sets the state of the liaison's thread-safe flag. More... | |
bool | getBuildMaps () const |
This functions returns the state of the liaison's buildMaps flag. More... | |
void | setBuildMaps (bool newState) |
This functions sets the state of the liaison's buildMaps flag. More... | |
![]() | |
XMLParserLiaison () | |
virtual | ~XMLParserLiaison () |
Protected Member Functions | |
XercesDocumentWrapper * | doCreateDocument (const DOMDocument_Type *theXercesDocument, bool threadSafe, bool buildWrapper, bool buildMaps, bool isOwned) |
Create a XalanDocument proxy for an existing Xerces document. More... | |
Static Protected Member Functions | |
static void | formatErrorMessage (const SAXParseExceptionType &e, XalanDOMString &theMessage) |
Definition at line 72 of file XercesParserLiaison.hpp.
typedef XalanMap<const XalanDocument*, DocumentEntry> XercesParserLiaison::DocumentMapType |
Definition at line 536 of file XercesParserLiaison.hpp.
typedef XERCES_CPP_NAMESPACE_QUALIFIER XercesDOMParser XercesParserLiaison::DOMParserType |
Definition at line 676 of file XercesParserLiaison.hpp.
typedef XERCES_CPP_NAMESPACE_QUALIFIER SAXParser XercesParserLiaison::SAXParserType |
Definition at line 79 of file XercesParserLiaison.hpp.
XercesParserLiaison::XercesParserLiaison | ( | XercesDOMSupport & | theSupport, |
MemoryManager &theManager | XALAN_DEFAULT_MEMMGR | ||
) |
Construct a XercesParserLiaison instance.
theSupport | instance of DOMSupport object |
XercesParserLiaison::XercesParserLiaison | ( | MemoryManager &theManager | XALAN_DEFAULT_MEMMGR | ) |
Construct a XercesParserLiaison instance.
|
virtual |
|
inline |
Create a XalanDocument proxy for an existing Xerces document.
The parser liaison owns the instance, and you must not delete it. The liaison will delete it when reset() is called, or the liaison is destroyed.
theXercesDocument | The Xerces document. |
Definition at line 369 of file XercesParserLiaison.hpp.
XalanDocument* XercesParserLiaison::createDocument | ( | const DOMDocument_Type * | theXercesDocument, |
bool | threadSafe, | ||
bool | buildWrapper, | ||
bool | buildMaps = false |
||
) |
Create a XalanDocument proxy for an existing Xerces document.
The parser liaison owns the instance, and you must not delete it. The liaison will delete it when reset() is called, or the liaison is destroyed.
theXercesDocument | The Xerces document. |
threadSafe | If true, read access to the tree will be thread-safe (implies buildWrapper == true). |
buildWrapper | If true, the entire wrapper structure is built. |
buildMaps | If true, the map of Xerces to Xalan nodes is always built. |
|
virtual |
Create an instance of the Xerces default document that is suitable as a raw document.
The new document instance is owned by this instance and will be destroyed when this instance goes out of scope, or by an explicit call to destroyDocument()
|
virtual |
Destroy the supplied XalanDocument instance.
It must be an instance that was created by a previous call to parseXMLStream().
theDocument | The XalanDocument instance to destroy. |
Implements XMLParserLiaison.
|
virtual |
Destroy an instance created by a call to createDOMFactory().
a pointer to the instance to be destroyed
|
protected |
Create a XalanDocument proxy for an existing Xerces document.
theXercesDocument | The Xerces document. |
threadSafe | If true, read access to the tree will be thread-safe (implies buildBridge == true). |
buildWrapper | If true, the entire bridge structure is built. |
buildMaps | If true, the map of Xerces to Xalan nodes is always built. |
|
virtual |
|
virtual |
|
staticprotected |
|
inline |
This API is deprecated.
This functions returns the state of the liaison's build-bridge-nodes flag.
Definition at line 547 of file XercesParserLiaison.hpp.
|
inline |
This functions returns the state of the liaison's buildMaps flag.
If true, maps will be created to allow mapping of Xalan<->Xerces mapping in both directions for XercesWrapper classes.
Definition at line 653 of file XercesParserLiaison.hpp.
|
inline |
This functions returns the state of the liaison's build-wrapper-nodes flag.
Definition at line 582 of file XercesParserLiaison.hpp.
|
virtual |
This method returns the state of the parser's namespace handling capability.
|
virtual |
This method returns the installed EntityResolver.
Implements XMLParserLiaison.
|
virtual |
This method returns the installed error handler.
Implements XMLParserLiaison.
|
virtual |
Get a pointer to the current ExecutionContext instance, which may be null.
Implements XMLParserLiaison.
|
virtual |
This method returns the state of the parser's exit-on-First-Fatal-Error flag.
|
virtual |
This method returns the location for an external schema document for parsing.
|
virtual |
This method returns the location for an external schema document for parsing.
|
virtual |
Get the 'include ignorable whitespace' flag.
This method returns the state of the parser's include ignorable whitespace flag.
|
virtual |
Get the amount to indent when indent-result="yes".
Implements XMLParserLiaison.
|
inlinevirtual |
Get a reference to the current MemoryManager instance.
Implements XMLParserLiaison.
Definition at line 104 of file XercesParserLiaison.hpp.
|
virtual |
Return a string suitable for telling the user what parser is being used.
Implements XMLParserLiaison.
|
inline |
This functions returns the state of the liaison's thread-safe flag.
If true, documents created will be safe when data is read. By default, documents are not thread-safe.
Note – modifications are never synchronized.
Definition at line 618 of file XercesParserLiaison.hpp.
|
virtual |
Get whether or not validation will be performed.
Validation is off by default.
Implements XMLParserLiaison.
|
virtual |
This method returns the installed XMLEntityResolver.
Implements XMLParserLiaison.
XercesDocumentWrapper* XercesParserLiaison::mapDocumentToWrapper | ( | const XalanDocument * | theDocument | ) | const |
Map a pointer to a XalanDocument instance to its implementation class pointer.
Normally, you should have no reason for doing this. The liaison will return a null pointer if it did not create the instance passed.
theDocument | A pointer to a XalanDocument instance. |
const DOMDocument_Type* XercesParserLiaison::mapToXercesDocument | ( | const XalanDocument * | theDocument | ) | const |
Map a pointer to a XalanDocument instance to its corresponding class pointer.
Normally, you should have no reason for doing this. The liaison will return a null pointer if it did not create the instance passed.
theDocument | A pointer to a XalanDocument instance. |
|
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.
reader | stream that should hold valid XML |
identifier | used for diagnostic purposes only, some sort of identification for error reporting, default an empty string |
Implements XMLParserLiaison.
|
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.
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 |
Implements XMLParserLiaison.
|
virtual |
Reset the instance, freeing any XalanDocument instances created through parseXMLStream().
Implements XMLParserLiaison.
|
virtual |
|
inline |
This API is deprecated.
This functions sets the state of the liaison's build-bridge-nodes flag. This flag must be set for the document to be thread safe. It can also be set to true to increase performance. If this flag is set to false, then the thread-safe flag will also be set to false.
newState | The new state for the flag. |
Definition at line 566 of file XercesParserLiaison.hpp.
|
inline |
This functions sets the state of the liaison's buildMaps flag.
When this flag is true, maps will be built providing Xerces<->Xalan mapping in Wrapper classes.
newState | The new state for the flag. |
Definition at line 671 of file XercesParserLiaison.hpp.
|
inline |
This functions sets the state of the liaison's build-wrapper-nodes flag.
This flag must be set for the document to be thread safe. It can also be set to true to increase performance. If this flag is set to false, then the thread-safe flag will also be set to false.
newState | The new state for the flag. |
Definition at line 598 of file XercesParserLiaison.hpp.
|
virtual |
This method allows users to enable or disable the parser's namespace processing.
When set to true, parser starts enforcing all the constraints / rules specified by the NameSpace specification.
The parser's default state is: false.
This flag is ignored by the underlying scanner if the installed validator indicates that namespace constraints should be enforced.
newState | The value specifying whether NameSpace rules should be enforced or not. |
|
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.
handler | A pointer to the EntityResolver to be called when the parser encounters references to external entities. |
Implements XMLParserLiaison.
|
virtual |
This method installs the user-specified error handler.
handler | A pointer to the error handler to be called upon error. |
Implements XMLParserLiaison.
|
virtual |
Set the current ExecutionContext instance.
theContext A reference to the new ExecutionContext instance.
Implements XMLParserLiaison.
|
virtual |
This method allows users to set the parser's behaviour when it encounters the first fatal error.
If set to true, the parser will exit at the first fatal error. If false, then it will report the error and continue processing.
The default value is 'true' and the parser exits on the first fatal error.
newState | The value specifying whether the parser should continue or exit when it encounters the first fatal error. |
|
virtual |
This method sets the location for an external schema document for parsing.
location | A string representing the location of the external schema document |
|
virtual |
This method sets the location for an external schema document for parsing.
location | A string representing the location of the external schema document |
|
virtual |
Set the 'include ignorable whitespace' flag.
This method allows the user to specify whether a validating parser should include ignorable whitespaces as text nodes. It has no effect on non-validating parsers which always include non-markup text.
When set to true (also the default), ignorable whitespaces will be added to the DOM tree as text nodes. The method DOMText::isWhitespace
will return true for those text nodes only.
When set to false, all ignorable whitespace will be discarded and no text node is added to the DOM tree. Note: applications intended to process the "xml:space" attribute should not set this flag to false.
include | The new state of the include ignorable whitespace flag. |
|
virtual |
Set the amount to indent when indent-result="yes".
i | number of characters to indent |
Implements XMLParserLiaison.
|
inline |
This functions sets the state of the liaison's thread-safe flag.
This flag must be set for the document to be thread safe. If this flag is set to true, then the build-bridge-nodes flag will also be set to true.
newState | The new state for the flag. |
Definition at line 634 of file XercesParserLiaison.hpp.
|
virtual |
If set to true, validation will be performed.
Validation is off by default.
b | true to perform validation |
Implements XMLParserLiaison.
|
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.
handler | A pointer to the entity resolver to be called when the parser encounters references to external entities. |
Implements XMLParserLiaison.
|
virtual |
Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.
Xalan-C++ XSLT Processor Version 1.11 |
|