Main Page | Modules | Class List | Directories | File List | Class Members | File Members

OM Document
[AXIOM (Axis Object Model)]


Classes

struct  axis2_om_document_ops
 OM document operations struct Encapsulator struct for operations of axis2_om_document_t. More...
struct  axis2_om_document
 OM document struct Handles the XML document in OM. More...

Defines

#define AXIS2_OM_DOCUMENT_FREE(document, env)   ((document)->ops->free(document,env))
#define AXIS2_OM_DOCUMENT_ADD_CHILD(document, env, child)   ((document)->ops->add_child(document,env,child))
#define AXIS2_OM_DOCUMENT_BUILD_NEXT(document, env)   ((document)->ops->build_next(document,env))
#define AXIS2_OM_DOCUMENT_GET_ROOT_ELEMENT(document, env)   ((document)->ops->get_root_element(document,env))
#define AXIS2_OM_DOCUMENT_SET_ROOT_ELEMENT(document, env, om_node)   ((document)->ops->set_root_element(document,env,om_node))
#define AXIS2_OM_DOCUMENT_BUILD_ALL(document, env)   ((document)->ops->build_all(document,env))

Typedefs

typedef axis2_om_document_ops axis2_om_document_ops_t
 OM document operations struct Encapsulator struct for operations of axis2_om_document_t.
typedef axis2_om_document axis2_om_document_t
 OM document struct Handles the XML document in OM.

Functions

axis2_om_document_taxis2_om_document_create (axis2_env_t **env, axis2_om_node_t *root, struct axis2_om_stax_builder *builder)

Define Documentation

#define AXIS2_OM_DOCUMENT_ADD_CHILD document,
env,
child   )     ((document)->ops->add_child(document,env,child))
 

adds a child to document

#define AXIS2_OM_DOCUMENT_BUILD_ALL document,
env   )     ((document)->ops->build_all(document,env))
 

build till the root node is complete

#define AXIS2_OM_DOCUMENT_BUILD_NEXT document,
env   )     ((document)->ops->build_next(document,env))
 

builds next node of document

#define AXIS2_OM_DOCUMENT_FREE document,
env   )     ((document)->ops->free(document,env))
 

frees given document

#define AXIS2_OM_DOCUMENT_GET_ROOT_ELEMENT document,
env   )     ((document)->ops->get_root_element(document,env))
 

gets the root eleemnt of given document

#define AXIS2_OM_DOCUMENT_SET_ROOT_ELEMENT document,
env,
om_node   )     ((document)->ops->set_root_element(document,env,om_node))
 

sets the root node


Function Documentation

axis2_om_document_t* axis2_om_document_create axis2_env_t **  env,
axis2_om_node_t root,
struct axis2_om_stax_builder builder
 

creates an axis2_om_document_t struct

Parameters:
env Environment. MUST NOT be NULL.
root pointer to document's root node. Optional, can be NULL
builder pointer to axis2_om_stax_builder
Returns:
pointer to the newly created document.


Generated on Wed Dec 7 07:58:28 2005 for Axis2/C by  doxygen 1.4.2