axiom_node_ops Struct Reference
[node]

node ops struct Encapsulator struct for ops of axiom_node More...

#include <axiom_node.h>

List of all members.

Public Attributes

axis2_status_t(* free )(axiom_node_t *om_node, const axis2_env_t *env)
axis2_status_t(* add_child )(axiom_node_t *om_node, const axis2_env_t *env, axiom_node_t *child)
axiom_node_t *(* detach )(axiom_node_t *om_node, const axis2_env_t *env)
axis2_status_t(* insert_sibling_after )(axiom_node_t *om_node, const axis2_env_t *env, axiom_node_t *node_to_insert)
axis2_status_t(* insert_sibling_before )(axiom_node_t *om_node, const axis2_env_t *env, axiom_node_t *node_to_insert)
axis2_status_t(* serialize )(axiom_node_t *om_node, const axis2_env_t *env, struct axiom_output *om_output)
axiom_node_t *(* get_parent )(axiom_node_t *om_node, const axis2_env_t *env)
axiom_node_t *(* get_first_child )(axiom_node_t *om_node, const axis2_env_t *env)
axiom_node_t *(* get_last_child )(axiom_node_t *om_node, const axis2_env_t *env)
axiom_node_t *(* get_previous_sibling )(axiom_node_t *om_node, const axis2_env_t *env)
axiom_node_t *(* get_next_sibling )(axiom_node_t *om_node, const axis2_env_t *env)
axiom_types_t(* get_node_type )(axiom_node_t *om_node, const axis2_env_t *env)
void *(* get_data_element )(axiom_node_t *om_node, const axis2_env_t *env)
axis2_bool_t(* is_complete )(axiom_node_t *om_node, const axis2_env_t *env)
axiom_document *(* get_document )(axiom_node_t *om_node, const axis2_env_t *env)
axis2_char_t *(* to_string )(axiom_node_t *om_node, const axis2_env_t *env)


Detailed Description

node ops struct Encapsulator struct for ops of axiom_node


Member Data Documentation

axis2_status_t( * axiom_node_ops::free)(axiom_node_t *om_node, const 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 op. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_status_t( * axiom_node_ops::add_child)(axiom_node_t *om_node, const axis2_env_t *env, axiom_node_t *child)

Adds given node as child to parent. child should not have a parent if child has a parent it will be detached from existing parent

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

axiom_node_t*( * axiom_node_ops::detach)(axiom_node_t *om_node, const 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( * axiom_node_ops::insert_sibling_after)(axiom_node_t *om_node, const axis2_env_t *env, axiom_node_t *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 op. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_status_t( * axiom_node_ops::insert_sibling_before)(axiom_node_t *om_node, const axis2_env_t *env, axiom_node_t *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 op. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_status_t( * axiom_node_ops::serialize)(axiom_node_t *om_node, const axis2_env_t *env, struct axiom_output *om_output)

Serializes the given node. This op 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 AXIOM output handler to be used in serializing
Returns:
satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE

axiom_node_t*( * axiom_node_ops::get_parent)(axiom_node_t *om_node, const 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.

axiom_node_t*( * axiom_node_ops::get_first_child)(axiom_node_t *om_node, const 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

axiom_node_t*( * axiom_node_ops::get_last_child)(axiom_node_t *om_node, const 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.

axiom_node_t*( * axiom_node_ops::get_previous_sibling)(axiom_node_t *om_node, const 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 )

axiom_node_t*( * axiom_node_ops::get_next_sibling)(axiom_node_t *om_node, const 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.

axiom_types_t( * axiom_node_ops::get_node_type)(axiom_node_t *om_node, const axis2_env_t *env)

get the node type of this element Node type can be one of AXIOM_ELEMENT, AXIOM_COMMENT, AXIOM_TEXT AXIOM_DOCTYPE, AXIOM_PROCESSING_INSTRUCTION

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

void*( * axiom_node_ops::get_data_element)(axiom_node_t *om_node, const axis2_env_t *env)

get the struct contained in the node IF the node is on type AXIOM_ELEMENT , this method returns a pointer to axiom_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

axis2_bool_t( * axiom_node_ops::is_complete)(axiom_node_t *om_node, const axis2_env_t *env)

Indicates whether parser has parsed this information item completely or not

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

struct axiom_document*( * axiom_node_ops::get_document)(axiom_node_t *om_node, const axis2_env_t *env)

returns the associated document, only valid if built using builder and for a node of type AXIOM_ELEMENT returns null if no document is available

Parameters:
om_node 
env environment, MUST NOT be NULL.


The documentation for this struct was generated from the following file:
Generated on Wed Dec 20 20:14:14 2006 for Axis2/C by  doxygen 1.5.1