#include <axiom_element.h>
Public Attributes | |
axiom_namespace_t *(* | find_namespace )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *node, const axis2_char_t *uri, const axis2_char_t *prefix) |
axis2_status_t(* | declare_namespace )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *node, axiom_namespace_t *ns) |
axiom_namespace_t *(* | find_namespace_with_qname )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *node, axis2_qname_t *qname) |
axis2_status_t(* | add_attribute )(axiom_element_t *om_element, const axis2_env_t *env, axiom_attribute_t *attribute, axiom_node_t *node) |
axiom_attribute_t *(* | get_attribute )(axiom_element_t *om_element, const axis2_env_t *env, axis2_qname_t *qname) |
axis2_char_t *(* | get_attribute_value )(axiom_element_t *om_element, const axis2_env_t *env, axis2_qname_t *qname) |
axis2_status_t(* | free )(axiom_element_t *element, const axis2_env_t *env) |
axis2_status_t(* | serialize_start_part )(axiom_element_t *om_element, const axis2_env_t *env, axiom_output_t *om_output, axiom_node_t *ele_node) |
axis2_status_t(* | serialize_end_part )(axiom_element_t *om_element, const axis2_env_t *env, axiom_output_t *om_output) |
axiom_namespace_t *(* | find_declared_namespace )(axiom_element_t *om_element, const axis2_env_t *env, const axis2_char_t *uri, const axis2_char_t *prefix) |
axis2_char_t *(* | get_localname )(axiom_element_t *om_element, const axis2_env_t *env) |
axis2_status_t(* | set_localname )(axiom_element_t *om_element, const axis2_env_t *env, const axis2_char_t *localname) |
axiom_namespace_t *(* | get_namespace )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *ele_node) |
axis2_status_t(* | set_namespace )(axiom_element_t *om_element, const axis2_env_t *env, axiom_namespace_t *ns, axiom_node_t *node) |
axis2_hash_t *(* | get_all_attributes )(axiom_element_t *om_element, const axis2_env_t *env) |
axis2_hash_t *(* | get_namespaces )(axiom_element_t *om_element, const axis2_env_t *env) |
axis2_qname_t *(* | get_qname )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *ele_node) |
axiom_children_iterator_t *(* | get_children )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
axiom_children_qname_iterator_t *(* | get_children_with_qname )(axiom_element_t *om_element, const axis2_env_t *env, axis2_qname_t *element_qname, axiom_node_t *element_node) |
axiom_element_t *(* | get_first_child_with_qname )(axiom_element_t *om_element, const axis2_env_t *env, axis2_qname_t *element_qname, axiom_node_t *element_node, axiom_node_t **child_node) |
axis2_status_t(* | remove_attribute )(axiom_element_t *om_element, const axis2_env_t *env, axiom_attribute_t *om_attribute) |
axis2_status_t(* | set_text )(axiom_element_t *om_element, const axis2_env_t *env, const axis2_char_t *text, axiom_node_t *element_node) |
axis2_char_t *(* | get_text )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
axiom_element_t *(* | get_first_element )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node, axiom_node_t **first_element_node) |
axis2_char_t *(* | to_string )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
axiom_child_element_iterator_t *(* | get_child_elements )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
axis2_status_t(* | build )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
axiom_namespace_t *(* | get_default_namespace )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
axiom_namespace_t *(* | declare_default_namespace )(axiom_element_t *om_element, const axis2_env_t *env, axis2_char_t *uri) |
axiom_namespace_t *(* | find_namespace_uri )(axiom_element_t *om_element, const axis2_env_t *env, axis2_char_t *prefix, axiom_node_t *element_node) |
axis2_status_t(* | set_namespace_with_no_find_in_current_scope )(axiom_element_t *om_element, const axis2_env_t *env, axiom_namespace_t *om_ns) |
axis2_hash_t *(* | extract_attributes )(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *ele_node) |
axis2_char_t *(* | get_attribute_value_by_name )(axiom_element_t *om_ele, const axis2_env_t *env, axis2_char_t *attr_name) |
axis2_status_t( * axiom_element_ops::declare_namespace)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *node, axiom_namespace_t *ns) |
Declare a namespace in current element (in the scope of this element ). It checks to see if it is already declared.
om_element | contained in the om node struct | |
env | Environment. MUST NOT be NULL. | |
node | node containing an instance of an AXIOM element. | |
ns | pointer to the namespace struct to be declared |
axiom_namespace_t*( * axiom_element_ops::find_namespace_with_qname)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *node, axis2_qname_t *qname) |
Finds a namespace using qname Start to find from the given node and go up the hierarchy.
om_element | om_element contained in node | |
env | Environment. MUST NOT be NULL. | |
node | node containing an instance of an AXIOM element, cannot be NULL. | |
qname | qname of the namespace to be found. cannot be NULL. |
axis2_status_t( * axiom_element_ops::add_attribute)(axiom_element_t *om_element, const axis2_env_t *env, axiom_attribute_t *attribute, axiom_node_t *node) |
Adds an attribute to current element
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. | |
node | axiom_node_t node that om_element is contained in |
axiom_attribute_t*( * axiom_element_ops::get_attribute)(axiom_element_t *om_element, const axis2_env_t *env, axis2_qname_t *qname) |
Gets (finds) the attribute with the given qname
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. |
axis2_char_t*( * axiom_element_ops::get_attribute_value)(axiom_element_t *om_element, const axis2_env_t *env, axis2_qname_t *qname) |
Gets (finds) the attribute value with the given qname
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. |
axis2_status_t( * axiom_element_ops::free)(axiom_element_t *element, const axis2_env_t *env) |
Frees given element
element | AXIOM element to be freed. | |
env | Environment. MUST NOT be NULL. |
axis2_status_t( * axiom_element_ops::serialize_start_part)(axiom_element_t *om_element, const axis2_env_t *env, axiom_output_t *om_output, axiom_node_t *ele_node) |
Serializes the start part of the given element
element | element to be serialized. | |
env | Environment. MUST NOT be NULL. | |
om_output | AXIOM output handler to be used in serializing |
axis2_status_t( * axiom_element_ops::serialize_end_part)(axiom_element_t *om_element, const axis2_env_t *env, axiom_output_t *om_output) |
Serializes the end part of the given element. serialize_start_part must have been called before calling this method.
om_element | element to be serialized. | |
env | Environment must not be null. | |
om_output | AXIOM output handler to be used in serializing |
axiom_namespace_t*( * axiom_element_ops::find_declared_namespace)(axiom_element_t *om_element, const axis2_env_t *env, const axis2_char_t *uri, const axis2_char_t *prefix) |
finds a namespace in current elements scope
om_element | ||
env | environemt must not be null | |
uri | namespace uri | |
prefix | prefix |
axis2_char_t*( * axiom_element_ops::get_localname)(axiom_element_t *om_element, const axis2_env_t *env) |
returns the localname of this element
om_element | om_element struct | |
env | environment struct |
axis2_status_t( * axiom_element_ops::set_localname)(axiom_element_t *om_element, const axis2_env_t *env, const axis2_char_t *localname) |
set the localname of this element
om_element | om_element_struct to with localname is set | |
env | environment struct text value to be set as localname |
axiom_namespace_t*( * axiom_element_ops::get_namespace)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *ele_node) |
get the namespace of om_element
om_element | om_element struct | |
env | environemt, MUST NOT be NULL. |
axis2_status_t( * axiom_element_ops::set_namespace)(axiom_element_t *om_element, const axis2_env_t *env, axiom_namespace_t *ns, axiom_node_t *node) |
set the namespace of the element
om_element | Om_element struct | |
env | environment must not be null | |
ns | pointer to namespace |
axis2_hash_t*( * axiom_element_ops::get_all_attributes)(axiom_element_t *om_element, const axis2_env_t *env) |
get the attribute list of the element
om_element | om element | |
env | environment must not be null |
axis2_hash_t*( * axiom_element_ops::get_namespaces)(axiom_element_t *om_element, const axis2_env_t *env) |
get the namespace list of the element
om_element | om element | |
env | environment |
axis2_qname_t*( * axiom_element_ops::get_qname)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *ele_node) |
axis2_qname_t struct , NULL on failure
axiom_children_iterator_t*( * axiom_element_ops::get_children)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
returns a list of children iterator iterators free function must be called by user
axiom_children_qname_iterator_t*( * axiom_element_ops::get_children_with_qname)(axiom_element_t *om_element, const axis2_env_t *env, axis2_qname_t *element_qname, axiom_node_t *element_node) |
returns a list of children iterator with qname returned iterator is freed when om element struct is freed
om_element | ||
env | ||
element_qname | ||
element_node |
axiom_element_t*( * axiom_element_ops::get_first_child_with_qname)(axiom_element_t *om_element, const axis2_env_t *env, axis2_qname_t *element_qname, axiom_node_t *element_node, axiom_node_t **child_node) |
returns the om_element corresponding to element_qname
axis2_status_t( * axiom_element_ops::remove_attribute)(axiom_element_t *om_element, const axis2_env_t *env, axiom_attribute_t *om_attribute) |
removes an attribute from the element attribute list user must free this attribute, element free function does not free attributes that are not is it's attribute list
om_element | ||
env | ||
om_attribute | attribute to be removed |
axis2_status_t( * axiom_element_ops::set_text)(axiom_element_t *om_element, const axis2_env_t *env, const axis2_char_t *text, axiom_node_t *element_node) |
Sets the text of the given element. caution - This method will wipe out all the text elements (and hence any mixed content) before setting the text
axis2_char_t*( * axiom_element_ops::get_text)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
select all the text children and concat them to a single string
element | node , the container node of this om element |
axiom_element_t*( * axiom_element_ops::get_first_element)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node, axiom_node_t **first_element_node) |
returns the first child om element of this om element node
element_node | the container node of this om_element |
axis2_char_t*( * axiom_element_ops::to_string)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
returns the serilized text of this element and its children
element_node | the container node this on element is contained |
axiom_child_element_iterator_t*( * axiom_element_ops::get_child_elements)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
returns an iterator with child elements of type AXIOM_ELEMENT iterator is freed when om_element node is freed
om_element | ||
element_node | ||
env | enviroment must not be null |
axis2_status_t( * axiom_element_ops::build)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
builds this om_element_node completely, This is only possible if the om_stax_builder is associated with the om_element_node,
om_element | om_element struct | |
env | environment | |
element_node | corresponding om element node of this om element struct |
axiom_namespace_t*( * axiom_element_ops::get_default_namespace)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *element_node) |
retrieves the default namespace of this element , if available,
om_element | pointer to om element | |
env | axis2_environment MUST Not be NULL |
axiom_namespace_t*( * axiom_element_ops::declare_default_namespace)(axiom_element_t *om_element, const axis2_env_t *env, axis2_char_t *uri) |
declared a default namespace explicitly
om_element | pointer to om element | |
env | environment MUST not be NULL | |
uri | namespace uri of the default namespace |
axiom_namespace_t*( * axiom_element_ops::find_namespace_uri)(axiom_element_t *om_element, const axis2_env_t *env, axis2_char_t *prefix, axiom_node_t *element_node) |
checks for the namespace in the context of this element with the given prefix
om_element | pointer to om_element | |
env | environment MUST not be NULL | |
om_element_node | pointer to this element node |
axis2_status_t( * axiom_element_ops::set_namespace_with_no_find_in_current_scope)(axiom_element_t *om_element, const axis2_env_t *env, axiom_namespace_t *om_ns) |
This will not search the namespace in the scope nor will declare in the current element, as in set_namespace. This will just assign the given namespace to the element.
om_ns | pointer to namespace to be set |
axis2_hash_t*( * axiom_element_ops::extract_attributes)(axiom_element_t *om_element, const axis2_env_t *env, axiom_node_t *ele_node) |
Extract attributes , returns a clones hash table of attributes, if attributes are associated with a namespace it is also cloned