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

OM Node
[AXIOM (Axis Object Model)]


Classes

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

Defines

#define AXIS2_OM_NODE_FREE_TREE(om_node, env)   ((om_node)->ops->free(om_node,env))
#define AXIS2_OM_NODE_ADD_CHILD(om_node, env, parent)   ((parent)->ops->add_child(om_node,env,parent))
#define AXIS2_OM_NODE_DETACH(om_node, env)   ((om_node)->ops->detach(om_node,env))
#define AXIS2_OM_NODE_INSERT_SIBLING_AFTER(om_node, env, node_to_insert)   ((om_node)->ops->insert_sibling_after(om_node,env,node_to_insert))
#define AXIS2_OM_NODE_INSERT_SIBLING_BEFORE(om_node, env, node_to_insert)   ((om_node)->ops->insert_sibling_before(om_node,env,node_to_insert))
#define AXIS2_OM_NODE_SET_PARENT(om_node, env, parent_node)   ((om_node)->ops->set_parent(om_node,env,parent_node))
#define AXIS2_OM_NODE_SERIALIZE(om_node, env, om_output)   ((om_node)->ops->serialize(om_node,env,om_output))
#define AXIS2_OM_NODE_GET_PARENT(om_node, env)   ((om_node)->ops->get_parent(om_node,env))
#define AXIS2_OM_NODE_GET_FIRST_CHILD(om_node, env)   ((om_node)->ops->get_first_child(om_node,env))
#define AXIS2_OM_NODE_GET_LAST_CHILD(om_node, env)   ((om_node)->ops->get_last_child(om_node,env))
#define AXIS2_OM_NODE_GET_NEXT_SIBLING(om_node, env)   ((om_node)->ops->get_next_sibling(om_node,env))
#define AXIS2_OM_NODE_GET_PREVIOUS_SIBLING(om_node, env)   ((om_node)->ops->get_previous_sibling(om_node,env))
#define AXIS2_OM_NODE_GET_BUILD_STATUS(om_node, env)   ((om_node)->ops->get_build_status(om_node,env))
#define AXIS2_OM_NODE_GET_DATA_ELEMENT(om_node, env)   ((om_node)->ops->get_data_element(om_node,env))
#define AXIS2_OM_NODE_GET_NODE_TYPE(om_node, env)   ((om_node)->ops->get_node_type(om_node,env))
#define AXIS2_OM_NODE_SET_LAST_CHILD(om_node, env, last_child)   ((om_node)->ops->set_last_child(om_node,env,last_child))
#define AXIS2_OM_NODE_SET_FIRST_CHILD(om_node, env, first_child)   ((om_node)->ops->set_first_child(om_node,env,first_child))
#define AXIS2_OM_NODE_SET_PREVIOUS_SIBLING(om_node, env, prev_sibling)   ((om_node)->ops->set_previous_sibling(om_node,env,prev_sibling))
#define AXIS2_OM_NODE_SET_NEXT_SIBLING(om_node, env, next_sibling)   ((om_node)->ops->set_next_sibling(om_node,env,next_sibling))
#define AXIS2_OM_NODE_SET_BUILD_STATUS(om_node, env, done)   ((om_node)->ops->set_build_status(om_node,env,done))
#define AXIS2_OM_NODE_SET_DATA_ELEMENT(om_node, env, data_element)   ((om_node)->ops->set_data_element(om_node,env,data_element))
#define AXIS2_OM_NODE_SET_NODE_TYPE(om_node, env, node_type)   ((om_node)->ops->set_node_type(om_node,env,node_type))

Typedefs

typedef enum axis2_om_types_t axis2_om_types_t
 OM types.
typedef axis2_om_node_ops axis2_om_node_ops_t
 OM Node operations struct Encapsulator struct for operations of axis2_om_node.
typedef axis2_om_node axis2_om_node_t

Enumerations

enum  axis2_om_types_t {
  AXIS2_OM_INVALID = 0, AXIS2_OM_DOCUMENT, AXIS2_OM_ELEMENT, AXIS2_OM_DOCTYPE,
  AXIS2_OM_COMMENT, AXIS2_OM_ATTRIBUTE, AXIS2_OM_NAMESPACE, AXIS2_OM_PROCESSING_INSTRUCTION,
  AXIS2_OM_TEXT
}
 OM types. More...

Functions

axis2_om_node_taxis2_om_node_create (axis2_env_t **env)

Define Documentation

#define AXIS2_OM_NODE_ADD_CHILD om_node,
env,
parent   )     ((parent)->ops->add_child(om_node,env,parent))
 

adds given child to the given parent

#define AXIS2_OM_NODE_DETACH om_node,
env   )     ((om_node)->ops->detach(om_node,env))
 

detaches the given node from its parent

#define AXIS2_OM_NODE_FREE_TREE om_node,
env   )     ((om_node)->ops->free(om_node,env))
 

frees given node

#define AXIS2_OM_NODE_GET_BUILD_STATUS om_node,
env   )     ((om_node)->ops->get_build_status(om_node,env))
 

get build status

#define AXIS2_OM_NODE_GET_DATA_ELEMENT om_node,
env   )     ((om_node)->ops->get_data_element(om_node,env))
 

get data element of this node can be om_element om_text etc

#define AXIS2_OM_NODE_GET_FIRST_CHILD om_node,
env   )     ((om_node)->ops->get_first_child(om_node,env))
 

get firet child of this om_node

#define AXIS2_OM_NODE_GET_LAST_CHILD om_node,
env   )     ((om_node)->ops->get_last_child(om_node,env))
 

get last child

#define AXIS2_OM_NODE_GET_NEXT_SIBLING om_node,
env   )     ((om_node)->ops->get_next_sibling(om_node,env))
 

get next sibling

#define AXIS2_OM_NODE_GET_NODE_TYPE om_node,
env   )     ((om_node)->ops->get_node_type(om_node,env))
 

node type one of om_node_types

#define AXIS2_OM_NODE_GET_PARENT om_node,
env   )     ((om_node)->ops->get_parent(om_node,env))
 

returns parent of this om_node

#define AXIS2_OM_NODE_GET_PREVIOUS_SIBLING om_node,
env   )     ((om_node)->ops->get_previous_sibling(om_node,env))
 

get previous sibling

#define AXIS2_OM_NODE_INSERT_SIBLING_AFTER om_node,
env,
node_to_insert   )     ((om_node)->ops->insert_sibling_after(om_node,env,node_to_insert))
 

inserts a sibling after the given node

#define AXIS2_OM_NODE_INSERT_SIBLING_BEFORE om_node,
env,
node_to_insert   )     ((om_node)->ops->insert_sibling_before(om_node,env,node_to_insert))
 

inserts a sibling before the given node

#define AXIS2_OM_NODE_SERIALIZE om_node,
env,
om_output   )     ((om_node)->ops->serialize(om_node,env,om_output))
 

serialize an om_node and all its children

#define AXIS2_OM_NODE_SET_BUILD_STATUS om_node,
env,
done   )     ((om_node)->ops->set_build_status(om_node,env,done))
 

set build status

#define AXIS2_OM_NODE_SET_DATA_ELEMENT om_node,
env,
data_element   )     ((om_node)->ops->set_data_element(om_node,env,data_element))
 

set data element

#define AXIS2_OM_NODE_SET_FIRST_CHILD om_node,
env,
first_child   )     ((om_node)->ops->set_first_child(om_node,env,first_child))
 

set first child

#define AXIS2_OM_NODE_SET_NEXT_SIBLING om_node,
env,
next_sibling   )     ((om_node)->ops->set_next_sibling(om_node,env,next_sibling))
 

set next sibling

#define AXIS2_OM_NODE_SET_NODE_TYPE om_node,
env,
node_type   )     ((om_node)->ops->set_node_type(om_node,env,node_type))
 

set node type

#define AXIS2_OM_NODE_SET_PARENT om_node,
env,
parent_node   )     ((om_node)->ops->set_parent(om_node,env,parent_node))
 

sets the parent of the given node

#define AXIS2_OM_NODE_SET_PREVIOUS_SIBLING om_node,
env,
prev_sibling   )     ((om_node)->ops->set_previous_sibling(om_node,env,prev_sibling))
 

set previous sibling


Typedef Documentation

typedef struct axis2_om_node axis2_om_node_t
 

This is the structure that defines a node in om tree


Enumeration Type Documentation

enum axis2_om_types_t
 

OM types.

Enumeration values:
AXIS2_OM_INVALID  Invalid node type
AXIS2_OM_DOCUMENT  OM document type
AXIS2_OM_ELEMENT  OM element type
AXIS2_OM_DOCTYPE  OM doctype type
AXIS2_OM_COMMENT  OM comment type
AXIS2_OM_ATTRIBUTE  OM attribute type
AXIS2_OM_NAMESPACE  OM namespace type
AXIS2_OM_PROCESSING_INSTRUCTION  OM processing instruction type
AXIS2_OM_TEXT  OM text type


Function Documentation

axis2_om_node_t* axis2_om_node_create axis2_env_t **  env  ) 
 

Creates a node struct.

Parameters:
env Environment. MUST NOT be NULL, .
Returns:
a pointer to newly created node struct. NULL on error.


Generated on Wed Dec 7 07:58:28 2005 for Axis2/C by  doxygen 1.4.2