Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Member Functions | List of all members
XMLParserLiaison Class Referenceabstract
Inheritance diagram for XMLParserLiaison:
XalanSourceTreeParserLiaison XercesParserLiaison

Public Member Functions

 XMLParserLiaison ()
 
virtual ~XMLParserLiaison ()
 
virtual void reset ()=0
 
virtual ExecutionContextgetExecutionContext () const =0
 
virtual MemoryManagerTypegetMemoryManager ()=0
 
virtual void setExecutionContext (ExecutionContext &theContext)=0
 
virtual XalanDocumentparseXMLStream (const InputSourceType &inputSource, const XalanDOMString &identifier)=0
 Parse the text pointed at by the reader as XML, and return a DOM Document interface. More...
 
virtual void parseXMLStream (const InputSourceType &inputSource, DocumentHandlerType &handler, const XalanDOMString &identifier)=0
 Parse the text pointed at by the reader as XML. More...
 
virtual void destroyDocument (XalanDocument *theDocument)=0
 Destroy the supplied XalanDocument instance. More...
 
virtual int getIndent () const =0
 Get the amount to indent when indent-result="yes". More...
 
virtual void setIndent (int i)=0
 Set the amount to indent when indent-result="yes". More...
 
virtual bool getUseValidation () const =0
 Get whether or not validation will be performed. More...
 
virtual void setUseValidation (bool b)=0
 If set to true, validation will be performed. More...
 
virtual const XalanDOMStringgetParserDescription (XalanDOMString &theResult) const =0
 Return a string suitable for telling the user what parser is being used. More...
 
virtual EntityResolverTypegetEntityResolver () const =0
 This method returns the installed entity resolver. More...
 
virtual void setEntityResolver (EntityResolverType *resolver)=0
 This method installs the user specified entity resolver on the parser. More...
 
virtual ErrorHandlerTypegetErrorHandler () const =0
 This method returns the installed error handler. More...
 
virtual void setErrorHandler (ErrorHandlerType *handler)=0
 This method installs the user-specified error handler. More...
 

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
theDocumentThe XalanDocument instance to destroy.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual EntityResolverType* XMLParserLiaison::getEntityResolver ( ) const
pure virtual

This method returns the installed entity resolver.

Returns
The pointer to the installed entity resolver object.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual ErrorHandlerType* 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
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 MemoryManagerType& XMLParserLiaison::getMemoryManager ( )
pure virtual
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 XalanDocument* XMLParserLiaison::parseXMLStream ( const InputSourceType 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 when asked (see DestroyDocument()), or when the liaison is reset, or goes out of scope.

Parameters
readerstream that should hold valid XML
identifierused 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 InputSourceType inputSource,
DocumentHandlerType 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.

Parameters
inputSourceinput source that should hold valid XML
handlerinstance of a DocumentHandler
identifierused 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
virtual void XMLParserLiaison::setEntityResolver ( EntityResolverType resolver)
pure virtual

This method installs the user specified entity resolver on the parser.

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

Parameters
handlerA pointer to the entity resolver to be called when the parser comes across references to entities in the XML file.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::setErrorHandler ( ErrorHandlerType handler)
pure virtual

This method installs the user-specified error handler.

Parameters
handlerA pointer to the error handler to be called upon error.

Implemented in XalanSourceTreeParserLiaison, and XercesParserLiaison.

virtual void XMLParserLiaison::setExecutionContext ( ExecutionContext theContext)
pure virtual
virtual void XMLParserLiaison::setIndent ( int  i)
pure virtual

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

Deprecated:
Parameters
inumber 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
btrue to perform validation

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.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo