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

OM Node
[AXIOM (Axis Object Model)]


Classes

struct  axiom_node_ops
 OM Node ops struct Encapsulator struct for ops of axiom_node. More...
struct  axiom_node

Defines

#define AXIOM_NODE_FREE_TREE(om_node, env)   ((om_node)->ops->free(om_node,env))
#define AXIOM_NODE_ADD_CHILD(om_node, env, child)   ((om_node)->ops->add_child(om_node, env, child))
#define AXIOM_NODE_DETACH(om_node, env)   ((om_node)->ops->detach(om_node,env))
#define AXIOM_NODE_INSERT_SIBLING_AFTER(om_node, env, node_to_insert)   ((om_node)->ops->insert_sibling_after(om_node,env,node_to_insert))
#define AXIOM_NODE_INSERT_SIBLING_BEFORE(om_node, env, node_to_insert)   ((om_node)->ops->insert_sibling_before(om_node,env,node_to_insert))
#define AXIOM_NODE_SERIALIZE(om_node, env, om_output)   ((om_node)->ops->serialize(om_node,env,om_output))
#define AXIOM_NODE_GET_PARENT(om_node, env)   ((om_node)->ops->get_parent(om_node,env))
#define AXIOM_NODE_GET_FIRST_CHILD(om_node, env)   ((om_node)->ops->get_first_child(om_node,env))
#define AXIOM_NODE_GET_LAST_CHILD(om_node, env)   ((om_node)->ops->get_last_child(om_node,env))
#define AXIOM_NODE_GET_NEXT_SIBLING(om_node, env)   ((om_node)->ops->get_next_sibling(om_node,env))
#define AXIOM_NODE_GET_PREVIOUS_SIBLING(om_node, env)   ((om_node)->ops->get_previous_sibling(om_node,env))
#define AXIOM_NODE_IS_COMPLETE(om_node, env)   ((om_node)->ops->is_complete(om_node,env))
#define AXIOM_NODE_GET_DATA_ELEMENT(om_node, env)   ((om_node)->ops->get_data_element(om_node,env))
#define AXIOM_NODE_GET_NODE_TYPE(om_node, env)   ((om_node)->ops->get_node_type(om_node,env))
#define AXIOM_NODE_GET_DOCUMENT(om_node, env)   ((om_node)->ops->get_document(om_node, env))
#define AXIOM_NODE_TO_STRING(om_node, env)   ((om_node)->ops->to_string(om_node, env))

Typedefs

typedef enum axiom_types_t axiom_types_t
 OM types.
typedef axiom_node_ops axiom_node_ops_t
 OM Node ops struct Encapsulator struct for ops of axiom_node.

Enumerations

enum  axiom_types_t {
  AXIOM_INVALID = 0, AXIOM_DOCUMENT, AXIOM_ELEMENT, AXIOM_DOCTYPE,
  AXIOM_COMMENT, AXIOM_ATTRIBUTE, AXIOM_NAMESPACE, AXIOM_PROCESSING_INSTRUCTION,
  AXIOM_TEXT
}
 OM types. More...

Functions

AXIS2_EXTERN axiom_node_taxiom_node_create (const axis2_env_t *env)

Define Documentation

#define AXIOM_NODE_ADD_CHILD om_node,
env,
child   )     ((om_node)->ops->add_child(om_node, env, child))
 

adds given child to the given parent

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

detaches the given node from its parent

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

frees given node

#define AXIOM_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 AXIOM_NODE_GET_DOCUMENT om_node,
env   )     ((om_node)->ops->get_document(om_node, env))
 

get document

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

get firet child of this om_node

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

get last child

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

get next sibling

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

node type one of om_node_types

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

returns parent of this om_node

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

get previous sibling

#define AXIOM_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 AXIOM_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 AXIOM_NODE_IS_COMPLETE om_node,
env   )     ((om_node)->ops->is_complete(om_node,env))
 

get build status

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

serialize an om_node and all its children


Enumeration Type Documentation

enum axiom_types_t
 

OM types.

Enumeration values:
AXIOM_INVALID  Invalid node type
AXIOM_DOCUMENT  OM document type
AXIOM_ELEMENT  OM element type
AXIOM_DOCTYPE  OM doctype type
AXIOM_COMMENT  OM comment type
AXIOM_ATTRIBUTE  OM attribute type
AXIOM_NAMESPACE  OM namespace type
AXIOM_PROCESSING_INSTRUCTION  OM processing instruction type
AXIOM_TEXT  OM text type


Function Documentation

AXIS2_EXTERN axiom_node_t* axiom_node_create const 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 Fri Jun 16 18:02:45 2006 for Axis2/C by  doxygen 1.4.2