Using the XmlDataManager one can manage documents and collections.
More...
#include <zorba/xmldatamanager.h>
Detailed Description
Using the XmlDataManager one can manage documents and collections.
The XmlDataManager is a singleton instance. The Zorba object is reponsible for maintaining its lifetime. The instance can be accessed by calling getXmlDataManager() on the Zorba object. It may not be accessed anymore after Zorba::shutdown() has been called.
XmlDataManager is a thread-safe class.
- Examples:
- context.cpp, and datamanager.cpp.
Definition at line 35 of file xmldatamanager.h.
Constructor & Destructor Documentation
virtual zorba::XmlDataManager::~XmlDataManager |
( |
| ) |
|
|
inlineprotectedvirtual |
Member Function Documentation
virtual Item zorba::XmlDataManager::fetch |
( |
const String & |
aURI | ) |
const |
|
pure virtual |
Returns a CollectionManager responsible for all collections.
The collection manager provides a set of functions for managing collections identified by a QName and their contents.
Please note that the resulting manager is only responsible for dynamic collections identified by a QName, i.e. those that are not declared in the prolog of a module or identified by a URI.
- Returns
- The collection manager responsible for managing collections.
- Examples:
- datamanager.cpp.
virtual DocumentManager* zorba::XmlDataManager::getDocumentManager |
( |
| ) |
const |
|
pure virtual |
Returns a CollectionManager responsible for collections identified by a URI.
The collection manager provides a set of functions for managing collections identified by a URI and their contents.
Please note that the resulting manager is only responsible for dynamic collections identified by a URI, i.e. those that are not declared in the prolog of a module or identified by a QName.
- Returns
- The collection manager responsible for managing collections.
- Examples:
- datamanager.cpp.
virtual Item zorba::XmlDataManager::parseXML |
( |
std::istream & |
aStream | ) |
const |
|
pure virtual |
virtual Item zorba::XmlDataManager::parseXML |
( |
std::istream & |
aStream, |
|
|
const String & |
aBaseURI |
|
) |
| const |
|
pure virtual |
Parse an XML document and return an Item.
- Parameters
-
aStream | the input stream whose content should be parsed |
aBaseURI | the base URI which will be used as the base URI of the document. This serves both as the base URI used by the XML parser to resolve relative entity references within the document, and as the base URI of the document node that is returned. |
Parse an XML document and return a sequence of nodes.
This function parses the given input stream and returns the result as a sequence of nodes. If external entity processing is disabled the result will be a singleton sequence consisting of one document node. Otherwise, the result is the sequence of the external entity nodes.
- Parameters
-
aStream | the input stream whose content should be parsed |
aOptions | |
- See Also
- ParseOptions
-
ParseOptions
Parse an XML document and return a sequence of nodes.
This function parses the given input stream and returns the result as a sequence of nodes. If external entity processing is disabled the result will be a singleton sequence consisting of one document node. Otherwise, the result is the sequence of the external entity nodes.
- Parameters
-
aStream | the input stream whose content should be parsed |
aBaseURI | the base URI which will be used as the base URI of the document. This serves both as the base URI used by the XML parser to resolve relative entity references within the document, and as the base URI of the document node that is returned. |
aOptions | |
- See Also
- ParseOptions
-
ParseOptions
virtual void zorba::XmlDataManager::registerDiagnosticHandler |
( |
DiagnosticHandler * |
aDiagnosticHandler | ) |
|
|
pure virtual |
Register a DiagnosticHandler to which errors occuring during the management of documents and collections are reported.
If no DiagnosticHandler has been set using this function then subclasses of the ZorbaException class are thrown to report errors.
- Parameters
-
virtual void zorba::XmlDataManager::registerStemmerProvider |
( |
StemmerProvider const * |
provider | ) |
|
|
pure virtual |
Registers a StemmerProvider to use for stemming of text content in order to perform queries involving full-text.
If no StemmerProvider has been set using this function, then the default StemmerProvider will be used.
- Parameters
-
virtual void zorba::XmlDataManager::registerTokenizerProvider |
( |
TokenizerProvider const * |
provider | ) |
|
|
pure virtual |
The documentation for this class was generated from the following file: