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

axis2_om_node_ops Struct Reference
[OM Node]

OM Node operations struct Encapsulator struct for operations of axis2_om_node. More...

#include <axis2_om_node.h>

List of all members.

Public Attributes

axis2_status_t(* free )(struct axis2_om_node *om_node, axis2_env_t **env)
axis2_status_t(* add_child )(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *parent)
axis2_om_node *(* detach )(struct axis2_om_node *om_node, axis2_env_t **env)
axis2_status_t(* insert_sibling_after )(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *node_to_insert)
axis2_status_t(* insert_sibling_before )(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *node_to_insert)
axis2_status_t(* set_parent )(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *parent_node)
axis2_status_t(* serialize )(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_output *om_output)
axis2_om_node *(* get_parent )(struct axis2_om_node *om_node, axis2_env_t **env)
axis2_om_node *(* get_first_child )(struct axis2_om_node *om_node, axis2_env_t **env)
axis2_om_node *(* get_last_child )(struct axis2_om_node *om_node, axis2_env_t **env)
axis2_om_node *(* get_previous_sibling )(struct axis2_om_node *om_node, axis2_env_t **env)
axis2_om_node *(* get_next_sibling )(struct axis2_om_node *om_node, axis2_env_t **env)
axis2_om_types_t(* get_node_type )(struct axis2_om_node *om_node, axis2_env_t **env)
void *(* get_data_element )(struct axis2_om_node *om_node, axis2_env_t **env)
axis2_bool_t(* get_build_status )(struct axis2_om_node *om_node, axis2_env_t **env)
axis2_status_t(* set_first_child )(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *first_child)
axis2_status_t(* set_last_child )(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *last_child)
axis2_status_t(* set_next_sibling )(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *last_sibling)
axis2_status_t(* set_previous_sibling )(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *prev_sibling)
axis2_status_t(* set_node_type )(struct axis2_om_node *om_node, axis2_env_t **env, axis2_om_types_t type)
axis2_status_t(* set_data_element )(struct axis2_om_node *om_node, axis2_env_t **env, void *data_element)
axis2_status_t(* set_build_status )(struct axis2_om_node *om_node, axis2_env_t **env, axis2_bool_t done)


Detailed Description

OM Node operations struct Encapsulator struct for operations of axis2_om_node.


Member Data Documentation

axis2_status_t( * axis2_om_node_ops::add_child)(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *parent)
 

Adds given node as child to parent

Parameters:
om_node child node. cannot be NULL.
env Environment. MUST NOT be NULL, .
child child node.
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE

struct axis2_om_node*( * axis2_om_node_ops::detach)(struct axis2_om_node *om_node, axis2_env_t **env)
 

Detaches given node from the parent and reset the links

Parameters:
om_node node to be detached, cannot be NULL.
env Environment. MUST NOT be NULL, .
Returns:
a pointer to detached node,returns NULL on error with error code set to environment's error struct

axis2_status_t( * axis2_om_node_ops::free)(struct axis2_om_node *om_node, axis2_env_t **env)
 

Frees an om node and all of its children

Parameters:
om_node node to be freed.
env Environment. MUST NOT be NULL, .
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_bool_t( * axis2_om_node_ops::get_build_status)(struct axis2_om_node *om_node, axis2_env_t **env)
 

get_build_status

Parameters:
om_node om_node struct
env environment, MUST NOT be NULL.
Returns:
AXIS2_TRUE if node is completly build, AXIS2_FALSE if node is not completed

void*( * axis2_om_node_ops::get_data_element)(struct axis2_om_node *om_node, axis2_env_t **env)
 

get the struct contained in the node IF the node is on type AXIS2_OM_ELEMENT , this method returns a pointer to axis2_om_element_t struct contained

Parameters:
om_node node
env environment, MUST NOT be NULL.
Returns:
pointer to struct contained in the node returns NULL if no struct is contained

struct axis2_om_node*( * axis2_om_node_ops::get_first_child)(struct axis2_om_node *om_node, axis2_env_t **env)
 

get the first child of om_node

Parameters:
om_node node
env environment must not be null.
Returns:
pointer to first child node , NULL is returned on error with error code set in environments error

struct axis2_om_node*( * axis2_om_node_ops::get_last_child)(struct axis2_om_node *om_node, axis2_env_t **env)
 

get the last child

Parameters:
om_node node
env environment, MUST NOT be NULL
Returns:
pointer to last child of this node , return NULL on error.

struct axis2_om_node*( * axis2_om_node_ops::get_next_sibling)(struct axis2_om_node *om_node, axis2_env_t **env)
 

get next sibling

Parameters:
om_node om_node struct
env environment, MUST NOT be NULL.
Returns:
next sibling of this node.

axis2_om_types_t( * axis2_om_node_ops::get_node_type)(struct axis2_om_node *om_node, axis2_env_t **env)
 

get the node type of this element Node type can be one of AXIS2_OM_ELEMENT, AXIS2_OM_COMMENT, AXIS2_OM_TEXT AXIS2_OM_DOCTYPE, AXIS2_OM_PROCESSING_INSTRUCTION

Parameters:
om_node node of which node type is required
env environment
Returns:
node type

struct axis2_om_node*( * axis2_om_node_ops::get_parent)(struct axis2_om_node *om_node, axis2_env_t **env)
 

get parent of om_node node

Parameters:
env environment
Returns:
pointer to parent node of om_node, return NULL if no parent exists or when an error occured.

struct axis2_om_node*( * axis2_om_node_ops::get_previous_sibling)(struct axis2_om_node *om_node, axis2_env_t **env)
 

get the previous sibling

Parameters:
om_node om_node struct
env environment , must node be null
Returns:
a pointer to previous sibling , NULL if a previous sibling does not exits (happens when this node is the first child of a node )

axis2_status_t( * axis2_om_node_ops::insert_sibling_after)(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *node_to_insert)
 

Inserts a sibling node after the given node

Parameters:
om_node node to whom the sibling to be inserted. , cannot be NULL.
env Environment. MUST NOT be NULL, .
node_to_insert the node to be inserted. , cannot be NULL.
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_status_t( * axis2_om_node_ops::insert_sibling_before)(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *node_to_insert)
 

Inserts a sibling node before the given current node

Parameters:
om_node node to whom the sibling to be inserted. , cannot be NULL.
env Environment. MUST NOT be NULL, .
node_to_insert the node to be inserted. , cannot be NULL.
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_status_t( * axis2_om_node_ops::serialize)(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_output *om_output)
 

Serializes the given node. This operation makes the node go through its children and serialize them in order.

Parameters:
om_node node to be serialized. cannot be NULL.
env Environment .MUST NOT be NULL.
om_output OM output handler to be used in serializing
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_status_t( * axis2_om_node_ops::set_build_status)(struct axis2_om_node *om_node, axis2_env_t **env, axis2_bool_t done)
 

set build status, if the node if completety build build status is set to AXIS2_TRUE , otherwise AXIS2_FALSE

Parameters:
om_node 
env environment, MUST NOT be NULL.
done 

axis2_status_t( * axis2_om_node_ops::set_data_element)(struct axis2_om_node *om_node, axis2_env_t **env, void *data_element)
 

set data element

Parameters:
om_node node struct
env environment, MUST NOT be NULL.
data_element 
Returns:
status code of the operation AXIS2_SUCCESS on success, AXIS2_FAILURE on error

axis2_status_t( * axis2_om_node_ops::set_first_child)(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *first_child)
 

sets a node as first child of om_node

Parameters:
om_node om_node
env environment, MUST NOT be NULL.
first_child child to be set as first child

axis2_status_t( * axis2_om_node_ops::set_last_child)(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *last_child)
 

set last child

Parameters:
om_node 
env environment, MUST NOT be NULL.
last_child 
Returns:
status code AXIS2_SUCCESS on success.AXIS2_FAILURE on error

axis2_status_t( * axis2_om_node_ops::set_next_sibling)(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *last_sibling)
 

set next sibling

Parameters:
om_node 
env environment, MUST NOT be NULL.
last_sibling 
Returns:
status of the operation, AXIS2_SUCCESS on success, AXIS2_FAILURE on error

axis2_status_t( * axis2_om_node_ops::set_node_type)(struct axis2_om_node *om_node, axis2_env_t **env, axis2_om_types_t type)
 

set node type

Parameters:
om_node 
env environment, MUST NOT be NULL.
type type of the node
Returns:
status code of the operation AXIS2_SUCCESS on success, AXIS2_FAILURE on error

axis2_status_t( * axis2_om_node_ops::set_parent)(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *parent_node)
 

Sets a parent node to a given node, if a parent already exist for this node then it is detached before seting the parent

Parameters:
om_node child node to whom a parent to be added. , cannot be NULL.
env Environment. MUST NOT be NULL, .
parent_node the node that will be set as parent. , cannot be NULL.
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_status_t( * axis2_om_node_ops::set_previous_sibling)(struct axis2_om_node *om_node, axis2_env_t **env, struct axis2_om_node *prev_sibling)
 

set previous sibling

Parameters:
om_node 
env environment, MUST NOT be NULL.
prev_sibling 
Returns:
status of the operation, 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:27 2005 for Axis2/C by  doxygen 1.4.2