axiom_document_ops Struct Reference
[document]

document ops struct Encapsulator struct for ops of axiom_document_t More...

#include <axiom_document.h>

List of all members.

Public Attributes

axis2_status_t(* free )(struct axiom_document *document, const axis2_env_t *env)
axiom_node_t *(* build_next )(struct axiom_document *document, const axis2_env_t *env)
axiom_node_t *(* get_root_element )(struct axiom_document *document, const axis2_env_t *env)
axis2_status_t(* set_root_element )(struct axiom_document *document, const axis2_env_t *env, axiom_node_t *om_node)
axiom_node_t *(* build_all )(struct axiom_document *document, const axis2_env_t *env)
axiom_stax_builder *(* get_builder )(struct axiom_document *document, const axis2_env_t *env)
axis2_status_t(* serialize )(struct axiom_document *document, const axis2_env_t *env, axiom_output_t *om_output)


Detailed Description

document ops struct Encapsulator struct for ops of axiom_document_t


Member Data Documentation

axiom_node_t*( * axiom_document_ops::build_all)(struct axiom_document *document, const 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 axiom_document_t struct to be built.
env environment MUST NOT be NULL.

axiom_node_t*( * axiom_document_ops::build_next)(struct axiom_document *document, const 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( * axiom_document_ops::free)(struct axiom_document *document, const axis2_env_t *env)
 

Free document struct

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

struct axiom_stax_builder*( * axiom_document_ops::get_builder)(struct axiom_document *document, const axis2_env_t *env)
 

get builder

Returns:
builder , returns NULL if a builder is not associated with document

axiom_node_t*( * axiom_document_ops::get_root_element)(struct axiom_document *document, const 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( * axiom_document_ops::serialize)(struct axiom_document *document, const axis2_env_t *env, axiom_output_t *om_output)
 

Parameters:
om_document 
Returns:
status code AXIS2_SUCCESS on success , otherwise AXIS2_FAILURE

axis2_status_t( * axiom_document_ops::set_root_element)(struct axiom_document *document, const axis2_env_t *env, axiom_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 Thu Aug 31 17:32:39 2006 for Axis2/C by  doxygen 1.4.6