/usr/include/axis2-1.6.0/axiom_element.h is in libaxis2c-dev 1.6.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef AXIOM_ELEMENT_H
#define AXIOM_ELEMENT_H
#include <axiom_namespace.h>
#include <axiom_attribute.h>
#include <axiom_output.h>
#include <axiom_node.h>
#include <axiom_children_iterator.h>
#include <axiom_children_qname_iterator.h>
#include <axiom_child_element_iterator.h>
#include <axutil_hash.h>
#include <axutil_utils.h>
#ifdef __cplusplus
extern "C"
{
#endif
typedef struct axiom_element axiom_element_t;
/**
* @defgroup axiom_element element
* @ingroup axiom_om
* @{
*/
/**
* Creates an AXIOM element with given local name
* @param env Environment. MUST NOT be NULL.
* @param parent parent of the element node to be created. can be NULL.
* @param localname local name of the elment. cannot be NULL.
* @param ns namespace of the element. can be NULL.
* If the value of the namespace has not already been declared
* then the namespace structure ns will be declared and will be
* freed when the tree is freed.
* If the value of the namespace has already been declared using
* another namespace structure then the namespace structure ns
* will be freed.
* @param node This is an out parameter. cannot be NULL.
* Returns the node corresponding to the comment created.
* Node type will be set to AXIOM_ELEMENT
* @return a pointer to the newly created element struct
*/
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
axiom_element_create(
const axutil_env_t * env,
axiom_node_t * parent,
const axis2_char_t * localname,
axiom_namespace_t * ns,
axiom_node_t ** node);
/**
* Creates an AXIOM element with given qname
* @param env Environment. MUST NOT be NULL.
* @param parent parent of the element node to be created. can be NULL.
* @param qname qname of the elment.cannot be NULL.
* @param node This is an out parameter. cannot be NULL.
* Returns the node corresponding to the comment created.
* Node type will be set to AXIOM_ELEMENT
* @return a pointer to the newly created element struct
*/
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
axiom_element_create_with_qname(
const axutil_env_t * env,
axiom_node_t * parent,
const axutil_qname_t * qname,
axiom_node_t ** node);
/*
* Find a namespace in the scope of the document.
* Start to find from the given node and go up the hierarchy.
* @param om_element pointer to om_element_struct contained in
* node ,
* @param env Environment. MUST NOT be NULL.
* @param node node containing an instance of an AXIOM element,cannot be NULL.
* @param uri namespace uri..
* @param prefix namespace prefix. can be NULL.
* @return pointer to the namespace, if found, else NULL. On error, returns
* NULL and sets error code in environment,s error
*/
AXIS2_EXTERN axiom_namespace_t *AXIS2_CALL
axiom_element_find_namespace(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * node,
const axis2_char_t * uri,
const axis2_char_t * prefix);
/**
* Declare a namespace in current element (in the scope of this element ).
* It checks to see if it is already declared.
* @param om_element contained in the om node struct
* @param env Environment. MUST NOT be NULL.
* @param node node containing an instance of an AXIOM element.
* @param ns pointer to the namespace struct to be declared
* @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_declare_namespace(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * node,
axiom_namespace_t * ns);
/**
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
* @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE.
*
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_declare_namespace_assume_param_ownership(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_namespace_t * ns);
/**
* Finds a namespace using qname
* Start to find from the given node and go up the hierarchy.
* @param om_element om_element contained in node
* @param env Environment. MUST NOT be NULL.
* @param node node containing an instance of an AXIOM element, cannot be NULL.
* @param qname qname of the namespace to be found. cannot be NULL.
* @return pointer to the namespace, if found, else NULL. On error, returns
* NULL and sets the error code in environment's error struct.
*/
AXIS2_EXTERN axiom_namespace_t *AXIS2_CALL
axiom_element_find_namespace_with_qname(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * node,
axutil_qname_t * qname);
/**
* Adds an attribute to current element The current element takes responsibility of the assigned attribute
* @param om_element element to which the attribute is to be added.cannot be NULL.
* @param env Environment. MUST NOT be NULL.
* @param attribute attribute to be added.
* @param node axiom_node_t node that om_element is contained in
* @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_add_attribute(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_attribute_t * attribute,
axiom_node_t * node);
/**
* Gets (finds) the attribute with the given qname
* @param element element whose attribute is to be found.
* @param env Environment. MUST NOT be NULL.
* @qname qname qname of the attribute to be found. should not be NULL.
* @return 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_EXTERN axiom_attribute_t *AXIS2_CALL
axiom_element_get_attribute(
axiom_element_t * om_element,
const axutil_env_t * env,
axutil_qname_t * qname);
/**
* Gets (finds) the attribute value with the given qname
* @param element element whose attribute is to be found.
* @param env Environment. MUST NOT be NULL.
* @qname qname qname of the attribute to be found. should not be NULL.
* @return the attribute value with given qname if found, else NULL.
* On error, returns NULL and sets the error code in environment's error struct.
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_element_get_attribute_value(
axiom_element_t * om_element,
const axutil_env_t * env,
axutil_qname_t * qname);
/**
* Frees given element
* @param element AXIOM element to be freed.
* @param env Environment. MUST NOT be NULL.
* @return satus of the op. AXIS2_SUCCESS on success ,AXIS2_FAILURE on error.
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_element_free(
axiom_element_t * element,
const axutil_env_t * env);
/**
* Serializes the start part of the given element
* @param element element to be serialized.
* @param env Environment. MUST NOT be NULL.
* @param om_output AXIOM output handler to be used in serializing
* @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_serialize_start_part(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_output_t * om_output,
axiom_node_t * ele_node);
/**
* Serializes the end part of the given element. serialize_start_part must
* have been called before calling this method.
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
* @param om_output AXIOM output handler to be used in serializing
* @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_serialize_end_part(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_output_t * om_output);
/**
* finds a namespace in current element's scope,
* by uri or prefix or both
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param uri namespace uri, may be null
* @param prefix prefix
* @return axiom_namespace_t if found, else return NULL
*/
AXIS2_EXTERN axiom_namespace_t *AXIS2_CALL
axiom_element_find_declared_namespace(
axiom_element_t * om_element,
const axutil_env_t * env,
const axis2_char_t * uri,
const axis2_char_t * prefix);
/**
* returns the localname of this element
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @returns localname of element, returns NULL on error.
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_element_get_localname(
axiom_element_t * om_element,
const axutil_env_t * env);
/**
* set the localname of this element
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @localname text value to be set as localname
* @returns status code of op, AXIS2_SUCCESS on success,
* AXIS2_FAILURE on error.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_set_localname(
axiom_element_t * om_element,
const axutil_env_t * env,
const axis2_char_t * localname);
/**
* get the namespace of om_element
* @param om_element om_element struct
* @param env environemt, MUST NOT be NULL.
* @returns pointer to axiom_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_EXTERN axiom_namespace_t *AXIS2_CALL
axiom_element_get_namespace(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * ele_node);
/**
* set the namespace of the element
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param ns pointer to namespace
* If the value of the namespace has not already been declared
* then the namespace structure ns will be declared and will be
* freed when the tree is freed.
* @returns status code of the op, with error code
* set to environment's error
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_set_namespace(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_namespace_t * ns,
axiom_node_t * node);
/**
* unconditionally set the namespace of the element
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param ns pointer to namespace
* The namespace ns is assumed to have been declared already.
* @returns status code of the op, with error code
* set to environment's error
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_set_namespace_assume_param_ownership(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_namespace_t * ns);
/**
* get the attribute list of the element
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @returns axutil_hash poiner to attributes hash
* This hash table is read only
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axiom_element_get_all_attributes(
axiom_element_t * om_element,
const axutil_env_t * env);
/**
* get the namespace list of the element
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @returns axutil_hash pointer to namespaces hash
* this hash table is read only
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axiom_element_get_namespaces(
axiom_element_t * om_element,
const axutil_env_t * env);
/**
*@return qname of this element
* the returned qname should not be externaly freed
* when om_element struct is freed qname is also
* freed
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param ele_node pointer to this element node
*
* @returns axutil_qname_t struct , NULL on failure
*/
AXIS2_EXTERN axutil_qname_t *AXIS2_CALL
axiom_element_get_qname(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * ele_node);
/**
* returns a list of children iterator
* returned iterator is freed when om_element struct
* is freed
* iterators reset function must be called by user
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param element_node pointer to this element node
*
*/
AXIS2_EXTERN axiom_children_iterator_t *AXIS2_CALL
axiom_element_get_children(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * element_node);
/**
* returns a list of children iterator with qname
* returned iterator is freed when om element struct
* is freed
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param element_node pointer to this element node
* @returns children qname iterator struct
*/
AXIS2_EXTERN axiom_children_qname_iterator_t *AXIS2_CALL
axiom_element_get_children_with_qname(
axiom_element_t * om_element,
const axutil_env_t * env,
axutil_qname_t * element_qname,
axiom_node_t * element_node);
/**
* Returns the om_element corresponding to element_qname
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param element_qname qname of the element
* @param om_node pointer to this element node
* @param element_node
* @param child_node
* @returns children qname iterator struct
*/
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
axiom_element_get_first_child_with_qname(
axiom_element_t * om_element,
const axutil_env_t * env,
axutil_qname_t * element_qname,
axiom_node_t * element_node,
axiom_node_t ** child_node);
/**
* 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
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_attribute attribute to be removed
* @return AXIS2_SUCCESS if attribute was found and removed, else
* AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_remove_attribute(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_attribute_t * om_attribute);
/**
* 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
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param text text to set.
* @param element_node node of element.
* @return AXIS2_SUCCESS if attribute was found and removed, else
* AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_set_text(
axiom_element_t * om_element,
const axutil_env_t * env,
const axis2_char_t * text,
axiom_node_t * element_node);
/**
* Select all the text children and concat them to a single string. The string
* returned by this method call will be free by axiom when this method is called again.
* So it is recomended to have a copy of the return value if this method is going to
* be called more that once and the return values of the earlier calls are important.
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param element node , the container node of this om element
* @return the contanated text of all text childrens text values
* return null if no text children is avilable or on error
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_element_get_text(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * element_node);
/**
* returns the first child om element of this om element node
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
* @return om_element if one is availble otherwise return NULL
*/
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
axiom_element_get_first_element(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * element_node,
axiom_node_t ** first_element_node);
/**
* returns the serilized text of this element and its children
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param element_node the container node this on element is contained
* @return a char array of xml , returns NULL on error
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_element_to_string(
axiom_element_t * om_element,
const axutil_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
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param element_node
* @returns axiom_child_element_iterator_t , NULL on error
*/
AXIS2_EXTERN axiom_child_element_iterator_t *AXIS2_CALL
axiom_element_get_child_elements(
axiom_element_t * om_element,
const axutil_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,
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
* @param element_node corresponding om element node of this om element
* struct
* @returns AXIS2_SUCCESS if this element node was successfully completed,
* otherwise returns AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_build(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * element_node);
/**
* retrieves the default namespace of this element , if available,
* @param om_element pointer to om element
* @param env axutil_environment MUST Not be NULL
* @param element_node corresponding om element node of this om element
* @returns pointer to default namespace if availale , NULL otherwise
*/
AXIS2_EXTERN axiom_namespace_t *AXIS2_CALL
axiom_element_get_default_namespace(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * element_node);
/**
* declared a default namespace explicitly
* @param om_element pointer to om element
* @param env environment MUST not be NULL
* @param uri namespace uri of the default namespace
* @returns the declared namespace
*/
AXIS2_EXTERN axiom_namespace_t *AXIS2_CALL
axiom_element_declare_default_namespace(
axiom_element_t * om_element,
const axutil_env_t * env,
axis2_char_t * uri);
/**
* checks for the namespace in the context of this element
* with the given prefix
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_element_node pointer to this element node
* @returns pointer to relevent namespace
*/
AXIS2_EXTERN axiom_namespace_t *AXIS2_CALL
axiom_element_find_namespace_uri(
axiom_element_t * om_element,
const axutil_env_t * env,
const axis2_char_t * prefix,
axiom_node_t * element_node);
/**
*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.
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
* @param om_ns pointer to namespace to be set
* @returns
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_set_namespace_with_no_find_in_current_scope(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_namespace_t * om_ns);
/**
* Extract attributes , returns a clones hash table of attributes,
* if attributes are associated with a namespace it is also cloned
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
*
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axiom_element_extract_attributes(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * ele_node);
/**
* Returns the attribute value as a string for the given element
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param attr_name the attribute name
*
* @return the attribute value as a string
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axiom_element_get_attribute_value_by_name(
axiom_element_t * om_ele,
const axutil_env_t * env,
axis2_char_t * attr_name);
/**
* Create an OM Element and an OM node from given string params
* @param env environment MUST not be NULL
* @param parent pointer to this parent element node
* @param localname the locanmae of the element
* @param ns the namespace of the element
* @param node the reference ot the created node
* @return
*/
AXIS2_EXTERN axiom_element_t *AXIS2_CALL
axiom_element_create_str(
const axutil_env_t * env,
axiom_node_t * parent,
axutil_string_t * localname,
axiom_namespace_t * ns,
axiom_node_t ** node);
/**
* Returns the Local name of the element
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
*
* @return the Local name of the element
*/
AXIS2_EXTERN axutil_string_t *AXIS2_CALL
axiom_element_get_localname_str(
axiom_element_t * om_element,
const axutil_env_t * env);
/**
* Set the Local name of the element
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param localname the Local name of the element
*
* @return
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axiom_element_set_localname_str(
axiom_element_t * om_element,
const axutil_env_t * env,
axutil_string_t * localname);
/**
* Return whether the element is empty or not
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
*
* @return AXIS2_TRUE if empty AXIS2_FALSE if not empty
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axiom_element_get_is_empty(
axiom_element_t * om_element,
const axutil_env_t * env);
/**
* Set whether the element is empty or not
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param is_empty AXIS2_TRUE if empty AXIS2_FALSE if not empty
*
* @return VOID
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_element_set_is_empty(
axiom_element_t * om_element,
const axutil_env_t * env,
axis2_bool_t is_empty);
/**
* Collect all the namespaces with distinct prefixes in
* the parents of the given element. Effectively this
* is the set of namespaces declared above this element
* that are inscope at this element and might be used
* by it or its children.
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
* @returns pointer to hash of relevent namespaces
*/
AXIS2_EXTERN axutil_hash_t * AXIS2_CALL
axiom_element_gather_parent_namespaces(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * om_node);
/**
* If the provided namespace used by the provided element
* is one of the namespaces from the parent of the root
* root element, redeclares that namespace at the root element
* and removes it from the hash of parent namespaces
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
* @param ns pointer to namespace to redeclare
* @param root_element pointer to the subtree root element node
* @param inscope_namespaces pointer to hash of parent namespaces
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_element_use_parent_namespace(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * om_node,
axiom_namespace_t *ns,
axiom_element_t * root_element,
axutil_hash_t *inscope_namespaces);
/**
* Examines the subtree beginning at the provided element
* For each element or attribute, if it refers to a namespace
* declared in a parent of the subtree root element, redeclares
* that namespace at the level of the subtree root and removes
* it from the set of parent namespaces in scope and not yet
* declared
* @param om_element pointer to om_element
* @param env environment MUST not be NULL
* @param om_node pointer to this element node
*
* @param root_element pointer to the subtree root element node
* @param inscope_namespaces pointer to hash of parent namespaces
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_element_redeclare_parent_namespaces(
axiom_element_t * om_element,
const axutil_env_t * env,
axiom_node_t * om_node,
axiom_element_t * root_element,
axutil_hash_t *inscope_namespaces);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIOM_ELEMENT_H */
|