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

axis2_om_document_ops Struct Reference
[OM Document]

OM document operations struct Encapsulator struct for operations of axis2_om_document_t. More...

#include <axis2_om_document.h>

List of all members.

Public Attributes

axis2_status_t(* free )(struct axis2_om_document *document, axis2_env_t **env)
axis2_om_node_t *(* build_next )(struct axis2_om_document *document, axis2_env_t **env)
axis2_status_t(* add_child )(struct axis2_om_document *document, axis2_env_t **env, axis2_om_node_t *child)
axis2_om_node_t *(* get_root_element )(struct axis2_om_document *document, axis2_env_t **env)
axis2_status_t(* set_root_element )(struct axis2_om_document *document, axis2_env_t **env, axis2_om_node_t *om_node)
axis2_om_node_t *(* build_all )(struct axis2_om_document *document, axis2_env_t **env)


Detailed Description

OM document operations struct Encapsulator struct for operations of axis2_om_document_t.


Member Data Documentation

axis2_status_t( * axis2_om_document_ops::add_child)(struct axis2_om_document *document, axis2_env_t **env, axis2_om_node_t *child)
 

adds the child node to the document. To the back of the children list. child is added as a child of current last child

Parameters:
document document to add the child. cannot be NULL.
envi Environment. MUST NOT be NULL.
child child node to be added. cannot be NULL.
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE.

axis2_om_node_t*( * axis2_om_document_ops::build_all)(struct axis2_om_document *document, axis2_env_t **env)
 

This method builds the rest of the xml input stream from current position till the root element is completed .

Parameters:
document pointer to axis2_om_document_t struct to be built.
env environment MUST NOT be NULL.

axis2_om_node_t*( * axis2_om_document_ops::build_next)(struct axis2_om_document *document, axis2_env_t **env)
 

Builds the next node if the builder is not finished with input xml stream

Parameters:
document document whose next node is to be built. cannot be NULL
env Environment. MUST NOT be NULL.
Returns:
pointer to the next node. NULL on error.

axis2_status_t( * axis2_om_document_ops::free)(struct axis2_om_document *document, axis2_env_t **env)
 

Free document struct

Parameters:
document pointer to axis2_om_document_t struct to be freed
env Environment. MUST NOT be NULL
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE.

axis2_om_node_t*( * axis2_om_document_ops::get_root_element)(struct axis2_om_document *document, axis2_env_t **env)
 

Gets the root element of the document.

Parameters:
document document to return the root of
env Environment. MUST NOT be NULL.
Returns:
returns a pointer to the root node. If no root present, this method tries to build the root. Returns NULL on error.

axis2_status_t( * axis2_om_document_ops::set_root_element)(struct axis2_om_document *document, axis2_env_t **env, axis2_om_node_t *om_node)
 

set the root element of the document. IF a root node is already exist,it is freed before setting to root element

Parameters:
document document struct to return the root of
env Environment. MUST NOT be NULL.
Returns:
returns status code AXIS2_SUCCESS on success ,AXIS2_FAILURE on error.


The documentation for this struct was generated from the following file:
Generated on Wed Dec 7 07:58:26 2005 for Axis2/C by  doxygen 1.4.2