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

axis2_om_element_ops Struct Reference
[OM Element]

OM element operations struct Encapsulator struct for operations of axis2_om_element. More...

#include <axis2_om_element.h>

List of all members.

Public Attributes

axis2_om_namespace_t *(* find_namespace )(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_node_t *node, const axis2_char_t *uri, const axis2_char_t *prefix)
axis2_status_t(* declare_namespace )(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_node_t *node, axis2_om_namespace_t *ns)
axis2_om_namespace_t *(* find_namespace_with_qname )(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_node_t *node, axis2_qname_t *qname)
axis2_status_t(* add_attribute )(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_attribute_t *attribute)
axis2_om_attribute_t *(* get_attribute )(struct axis2_om_element *om_element, axis2_env_t **env, axis2_qname_t *qname)
axis2_status_t(* free )(struct axis2_om_element *element, axis2_env_t **env)
axis2_status_t(* serialize_start_part )(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_output_t *om_output)
axis2_status_t(* serialize_end_part )(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_output_t *om_output)
axis2_char_t *(* get_localname )(struct axis2_om_element *om_element, axis2_env_t **env)
axis2_status_t(* set_localname )(struct axis2_om_element *om_element, axis2_env_t **env, const axis2_char_t *localname)
axis2_om_namespace_t *(* get_namespace )(struct axis2_om_element *om_element, axis2_env_t **env)
axis2_status_t(* set_namespace )(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_namespace_t *ns, axis2_om_node_t *node)


Detailed Description

OM element operations struct Encapsulator struct for operations of axis2_om_element.


Member Data Documentation

axis2_status_t( * axis2_om_element_ops::add_attribute)(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_attribute_t *attribute)
 

Adds an attribute to current element

Parameters:
om_element element to which the attribute is to be added.cannot be NULL.
env Environment. MUST NOT be NULL.
attribute attribute to be added.
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE.

axis2_status_t( * axis2_om_element_ops::declare_namespace)(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_node_t *node, axis2_om_namespace_t *ns)
 

Declare a namespace in current element (in the scope of this element ). It checks to see if it is already declared.

Parameters:
om_element contained in the om node struct
env Environment. MUST NOT be NULL.
node node containing an instance of an OM element.
ns pointer to the namespace struct to be declared
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE.

axis2_om_namespace_t*( * axis2_om_element_ops::find_namespace_with_qname)(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_node_t *node, axis2_qname_t *qname)
 

Finds a namespace using qname Start to find from the given node and go up the hierarchy.

Parameters:
om_element om_element contained in node
env Environment. MUST NOT be NULL.
node node containing an instance of an OM element, cannot be NULL.
qname qname of the namespace to be found. cannot be NULL.
Returns:
pointer to the namespace, if found, else NULL. On error, returns NULL and sets the error code in environment's error struct.

axis2_status_t( * axis2_om_element_ops::free)(struct axis2_om_element *element, axis2_env_t **env)
 

Frees given element

Parameters:
element OM element to be freed.
env Environment. MUST NOT be NULL.
Returns:
satus of the operation. AXIS2_SUCCESS on success ,AXIS2_FAILURE on error.

axis2_om_attribute_t*( * axis2_om_element_ops::get_attribute)(struct axis2_om_element *om_element, axis2_env_t **env, axis2_qname_t *qname)
 

Gets (finds) the attribute with the given qname

Parameters:
element element whose attribute is to be found.
env Environment. MUST NOT be NULL. qname qname of the attribute to be found. should not be NULL.
Returns:
a pointer to the attribute with given qname if found, else NULL. On error, returns NULL and sets the error code in environment's error struct.

axis2_char_t*( * axis2_om_element_ops::get_localname)(struct axis2_om_element *om_element, axis2_env_t **env)
 

returns the localname of this element

Parameters:
om_element om_element struct
env environment struct
Returns:
localname of element, returns NULL on error.

axis2_om_namespace_t*( * axis2_om_element_ops::get_namespace)(struct axis2_om_element *om_element, axis2_env_t **env)
 

get the namespace of om_element

Parameters:
om_element om_element struct
env environemt, MUST NOT be NULL.
Returns:
pointer to axis2_om_namespace_t struct NULL if there is no namespace associated with the element, NULL on error with error code set to environment's error

axis2_status_t( * axis2_om_element_ops::serialize_end_part)(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_output_t *om_output)
 

Serializes the end part of the given element. serialize_start_part must have been called before calling this method.

Parameters:
om_element element to be serialized.
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_element_ops::serialize_start_part)(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_output_t *om_output)
 

Serializes the start part of the given element

Parameters:
element element to be serialized.
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_element_ops::set_localname)(struct axis2_om_element *om_element, axis2_env_t **env, const axis2_char_t *localname)
 

set the localname of this element

Parameters:
om_element om_element_struct to with localname is set
env environment struct text value to be set as localname
Returns:
status code of operation, AXIS2_SUCCESS on success, AXIS2_FAILURE on error.

axis2_status_t( * axis2_om_element_ops::set_namespace)(struct axis2_om_element *om_element, axis2_env_t **env, axis2_om_namespace_t *ns, axis2_om_node_t *node)
 

set the namespace of the element

Parameters:
om_element Om_element struct
env environment must not be null
ns pointer to namespace
Returns:
status code of the operation , NULL on error with error code set to environment's error


The documentation for this struct was generated from the following file:
Generated on Thu Nov 24 13:58:31 2005 for Axis2/C by  doxygen 1.4.2