XQC_DataManager_s Struct Reference

Using the XmlDataManager one can manage documents and collections. More...

#include <zorba/zorbac.h>


Data Fields

XQUERY_ERROR(* create_collection )(XQC_DataManager data_manager, const char *collection_uri, XQC_Collection_Ref col)
 Create a new collection that is identified by the given URI.
void * data
 for internal use only
XQUERY_ERROR(* delete_collection )(XQC_DataManager data_manager, const char *collection_uri)
 Delete the collection that is identified by the given URI.
XQUERY_ERROR(* delete_document )(XQC_DataManager data_manager, const char *document_uri)
void(* free )(XQC_DataManager data_manager)
 Called to free the resources associated with the XQC_DataManager.
XQUERY_ERROR(* get_collection )(XQC_DataManager data_manager, const char *collection_uri, XQC_Collection_Ref collection)
 Get the collection that is identified by the given URI.
XQUERY_ERROR(* get_document )(XQC_DataManager data_manager, const char *document_uri, XQC_Item_Ref doc)
 Get the document identified by the given URI.
XQUERY_ERROR(* load_document )(XQC_DataManager data_manager, const char *doc_uri, FILE *document)
 This function loads a document from the given FILE pointer.
XQUERY_ERROR(* load_document_uri )(XQC_DataManager data_manager, const char *location)
 This function loads a document that is retrieved from the given URI location.

Detailed Description

Using the XmlDataManager one can manage documents and collections.

The XmlDataManager is a singelton instance. The instance can be accessed by calling XQC_Implementation::data_manager. The XmlDataManager is thread-safe.

Examples:

cdatamanager.c.

Definition at line 1849 of file zorbac.h.

Field Documentation

XQUERY_ERROR(* XQC_DataManager_s::create_collection)(XQC_DataManager data_manager, const char *collection_uri, XQC_Collection_Ref col)

Create a new collection that is identified by the given URI.

Parameters:
data_manager The XQC_DataManager that this function pointer is a member of
document_uri The URI of the collection to create.
[out] col The collection to create. The user is responsible for freeing the object by calling the XQC_Item::free() function.
Return values:
XQC_NO_ERROR 
XQC_INTERNAL_ERROR 
Examples:
cdatamanager.c.

void* XQC_DataManager_s::data

for internal use only

Definition at line 1963 of file zorbac.h.

XQUERY_ERROR(* XQC_DataManager_s::delete_collection)(XQC_DataManager data_manager, const char *collection_uri)

Delete the collection that is identified by the given URI.

Parameters:
data_manager The XQC_DataManager that this function pointer is a member of
document_uri The URI of the collection to delete.
Return values:
XQC_NO_ERROR 
XQC_INTERNAL_ERROR 

XQUERY_ERROR(* XQC_DataManager_s::delete_document)(XQC_DataManager data_manager, const char *document_uri)

void(* XQC_DataManager_s::free)(XQC_DataManager data_manager)

Called to free the resources associated with the XQC_DataManager.

Parameters:
context The XQC_DataManager that this function pointer is a member of
Examples:
cdatamanager.c.

XQUERY_ERROR(* XQC_DataManager_s::get_collection)(XQC_DataManager data_manager, const char *collection_uri, XQC_Collection_Ref collection)

Get the collection that is identified by the given URI.

Parameters:
data_manager The XQC_DataManager that this function pointer is a member of
document_uri The URI of the collection to retrieve.
[out] col The collection to retrieve. The user is responsible for freeing the object by calling the XQC_Item::free() function.
Return values:
XQC_NO_ERROR 
XQC_INTERNAL_ERROR 

XQUERY_ERROR(* XQC_DataManager_s::get_document)(XQC_DataManager data_manager, const char *document_uri, XQC_Item_Ref doc)

Get the document identified by the given URI.

Parameters:
data_manager The XQC_DataManager that this function pointer is a member of
document_uri The URI of the document to retrieve.
[out] doc The Item of the document to get. The user is responsible for freeing the object by calling the XQC_Item::free() function.
Return values:
XQC_NO_ERROR 
XQC_INTERNAL_ERROR 

XQUERY_ERROR(* XQC_DataManager_s::load_document)(XQC_DataManager data_manager, const char *doc_uri, FILE *document)

This function loads a document from the given FILE pointer.

The document is identified by the given URI.

Parameters:
data_manager The XQC_DataManager that this function pointer is a member of
doc_uri The URI of the document to load.
document The document to load as a FILE pointer.
Return values:
XQC_NO_ERROR 
XQP0016_LOADER_IO_ERROR,\retval XQP0017_LOADER_PARSING_ERROR,
XQC_INTERNAL_ERROR 

XQUERY_ERROR(* XQC_DataManager_s::load_document_uri)(XQC_DataManager data_manager, const char *location)

This function loads a document that is retrieved from the given URI location.

The document is identified by the given URI.

Parameters:
data_manager The XQC_DataManager that this function pointer is a member of
location The URI of the document to load.
Return values:
XQC_NO_ERROR 
XQP0016_LOADER_IO_ERROR,\retval XQP0017_LOADER_PARSING_ERROR,
XQC_INTERNAL_ERROR 

The documentation for this struct was generated from the following file: