Main | License | Installation | FAQ | Screenshots | Contact | Links | Sf.net | Freshmeat.net | KDE-Apps.org

XMLDocument Class Reference
[XML C++ Wrappers]

#include <xmlDocument.hpp>

Inheritance diagram for XMLDocument:

[legend]

Public Member Functions
	XMLDocument (const std::string &schemaURI)
void	load (const std::string &fileName) throw (Error)
void	save (const std::string &fileName) throw (Error)
void	fromString (const std::string &string) throw (Error)
void	fromInputSource (InputSource &inputSource) throw (Error)
const XalanDocument *	getDocument (void) const
XMLReference < XalanElement >	getDocumentElement (void)
XalanSourceTreeDOMSupport *	getDOMSupport (void)
XPathEnvSupportDefault *	getEnvSupport (void)
XPathFactoryDefault *	getXPathFactory (void)
XPathExecutionContextDefault *	getExecutionContext (void)
Protected Attributes
XMLErrorHandler	xmlErrorHandler
	Error handler for catching parse errors.
const XalanDocument *	document
	The XML DOM.
Xalan classes for parsing and maintaining the XML DOM
XalanSourceTreeDOMSupport	theDOMSupport
XalanSourceTreeParserLiaison	theLiaison
Xalan classes for making XPath queries
XPathEnvSupportDefault	theEnvSupport
XObjectFactoryDefault	theXObjectFactory
XPathFactoryDefault	theXPathFactory
XPathExecutionContextDefault	theExecutionContext

---

Detailed Description

Class for parsing XML documents. Don't forget to add the following initialization code to your main application, before using this class:

    XMLPlatformUtils::Initialize();
    XPathInit oTheXPathInit;
    

After using this class, execute the following code:

    XMLPlatformUtils::Terminate();
    

See Apache Xerces and Xalan documentation for more details.

Date:

Thu Mar 10 2005

Author:

Jan Wedekind (wedesoft@users.sourceforge.net)

Definition at line 68 of file xmlDocument.hpp.

---

Constructor & Destructor Documentation

XMLDocument::XMLDocument

(

const std::string &

schemaURI

)

Constructor. Create empty XML-document and configure verification.

Parameters:

schemaURI

(Namespace-URI and) XSD-filename of XML schema. Specify "", if you don't want verification.

Definition at line 39 of file xmlDocument.cpp.

References theDOMSupport, theLiaison, and xmlErrorHandler.

                                                    :
   theLiaison( theDOMSupport )
#ifndef SIMPLEXPATH
  , theExecutionContext( theEnvSupport, theDOMSupport, theXObjectFactory )
#endif
{
  theDOMSupport.setParserLiaison( &theLiaison );
  theLiaison.setErrorHandler( &xmlErrorHandler );
  if ( !schemaURI.empty() ) {
#ifndef NDEBUG
    cerr << "Specifying schema \"" << schemaURI << "\"." << endl;
#endif
    if ( schemaURI.find( ' ' ) < schemaURI.size() )
      theLiaison.setExternalSchemaLocation
        ( StrX<XMLCh,char>( schemaURI.c_str() ).getBuffer() );
    else
      theLiaison.setExternalNoNamespaceSchemaLocation
        ( StrX<XMLCh,char>( schemaURI.c_str() ).getBuffer() );
    theLiaison.setUseValidation( true );
  };
  theLiaison.setDoNamespaces( true );
};

---

Member Function Documentation

void XMLDocument::load

(

const std::string &

fileName

)

throw (Error)

Definition at line 62 of file xmlDocument.cpp.

References ERRORMACRO, and fromInputSource().

{
  // XALAN_USING_XERCES(LocalFileInputSource)
  try {
    LocalFileInputSource
      localFileInputSource( StrX<XMLCh,char>( fileName.c_str() ).getBuffer() );
    fromInputSource( localFileInputSource );
  } catch ( XMLException &exc ) {
    ERRORMACRO( false, Error, ,
                "Could not load XML file \"" << fileName << "\": "
                << ( StrX<char,XMLCh>( exc.getMessage() ).getBuffer() ) );
  };
};

void XMLDocument::save

(

const std::string &

fileName

)

throw (Error)

Definition at line 76 of file xmlDocument.cpp.

References ERRORMACRO.

{
  ERRORMACRO( false, Error, ,
              "Saving of xml-documents not implemented yet." );
}

void XMLDocument::fromString

(

const std::string &

string

)

throw (Error)

Referenced by CookBook::getVersion().

void XMLDocument::fromInputSource

(

InputSource &

inputSource

)

throw (Error)

Definition at line 91 of file xmlDocument.cpp.

References document, ERRORMACRO, XMLErrorHandler::getErrorMessage(), XMLErrorHandler::getErrorOccurred(), theLiaison, and xmlErrorHandler.

Referenced by load().

{
  document = theLiaison.parseXMLStream( inputSource );
  if ( xmlErrorHandler.getErrorOccurred() ) {
    ERRORMACRO( false, Error, ,
                "Parse error in XML file: "
                << xmlErrorHandler.getErrorMessage() );
  };
  assert( document != NULL );
}

const XalanDocument* XMLDocument::getDocument

(

void

)

const [inline]

Definition at line 85 of file xmlDocument.hpp.

References document.

  { return document; }

XMLReference< XalanElement > XMLDocument::getDocumentElement

(

void

)

[inline]

Definition at line 88 of file xmlDocument.hpp.

References document.

Referenced by CookBook::getVersion().

  { return XMLReference< XalanElement >
      ( document->getDocumentElement(), this ); }

XalanSourceTreeDOMSupport* XMLDocument::getDOMSupport

(

void

)

[inline]

Definition at line 93 of file xmlDocument.hpp.

References theDOMSupport.

  { return &theDOMSupport; }

XPathEnvSupportDefault* XMLDocument::getEnvSupport

(

void

)

[inline]

Definition at line 96 of file xmlDocument.hpp.

References theEnvSupport.

{ return &theEnvSupport; }

XPathFactoryDefault* XMLDocument::getXPathFactory

(

void

)

[inline]

Definition at line 103 of file xmlDocument.hpp.

{ return &theXPathFactory; }

XPathExecutionContextDefault* XMLDocument::getExecutionContext

(

void

)

[inline]

Definition at line 105 of file xmlDocument.hpp.

References theExecutionContext.

  { return &theExecutionContext; }

---

Field Documentation

XalanSourceTreeDOMSupport XMLDocument::theDOMSupport [protected]

Definition at line 112 of file xmlDocument.hpp.

Referenced by getDOMSupport(), and XMLDocument().

XalanSourceTreeParserLiaison XMLDocument::theLiaison [protected]

Definition at line 114 of file xmlDocument.hpp.

Referenced by fromInputSource(), and XMLDocument().

XMLErrorHandler XMLDocument::xmlErrorHandler [protected]

Error handler for catching parse errors.

Definition at line 117 of file xmlDocument.hpp.

Referenced by fromInputSource(), and XMLDocument().

const XalanDocument* XMLDocument::document [protected]

The XML DOM.

Definition at line 119 of file xmlDocument.hpp.

Referenced by fromInputSource(), getDocument(), and getDocumentElement().

XPathEnvSupportDefault XMLDocument::theEnvSupport [protected]

Definition at line 125 of file xmlDocument.hpp.

Referenced by getEnvSupport().

XObjectFactoryDefault XMLDocument::theXObjectFactory [protected]

Definition at line 127 of file xmlDocument.hpp.

XPathFactoryDefault XMLDocument::theXPathFactory [protected]

Definition at line 134 of file xmlDocument.hpp.

XPathExecutionContextDefault XMLDocument::theExecutionContext [protected]

Definition at line 136 of file xmlDocument.hpp.

Referenced by getExecutionContext().

---

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

• xmlDocument.hpp
• xmlDocument.cpp

---