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

OM Document
[AXIOM (Axis Object Model)]


Classes

struct  axiom_document_ops
 OM document ops struct Encapsulator struct for ops of axiom_document_t. More...
struct  axiom_document
 OM document struct Handles the XML document in OM. More...

Defines

#define AXIOM_DOCUMENT_FREE(document, env)   ((document)->ops->free(document,env))
#define AXIOM_DOCUMENT_BUILD_NEXT(document, env)   ((document)->ops->build_next(document,env))
#define AXIOM_DOCUMENT_GET_ROOT_ELEMENT(document, env)   ((document)->ops->get_root_element(document,env))
#define AXIOM_DOCUMENT_SET_ROOT_ELEMENT(document, env, om_node)   ((document)->ops->set_root_element(document,env,om_node))
#define AXIOM_DOCUMENT_BUILD_ALL(document, env)   ((document)->ops->build_all(document,env))
#define AXIOM_DOCUMENT_GET_BUILDER(document, env)   ((document)->ops->get_builder(document, env))
#define AXIOM_DOCUMENT_SERIALIZE(document, env, om_output)   ((document)->ops->serialize(document, env, om_output))

Typedefs

typedef axiom_document_ops axiom_document_ops_t
 OM document ops struct Encapsulator struct for ops of axiom_document_t.
typedef axiom_document axiom_document_t
 OM document struct Handles the XML document in OM.

Functions

AXIS2_EXTERN axiom_document_taxiom_document_create (const axis2_env_t *env, axiom_node_t *root, struct axiom_stax_builder *builder)

Define Documentation

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

build till the root node is complete

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

builds next node of document

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

frees given document

#define AXIOM_DOCUMENT_GET_BUILDER document,
env   )     ((document)->ops->get_builder(document, env))
 

returns the builder

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

gets the root eleemnt of given document

#define AXIOM_DOCUMENT_SERIALIZE document,
env,
om_output   )     ((document)->ops->serialize(document, env, om_output))
 

serialize opertation

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

sets the root node


Function Documentation

AXIS2_EXTERN axiom_document_t* axiom_document_create const axis2_env_t env,
axiom_node_t root,
struct axiom_stax_builder builder
 

creates an axiom_document_t struct

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


Generated on Fri Jun 16 18:02:45 2006 for Axis2/C by  doxygen 1.4.2