Package org.apache.axiom.om.util

Class ElementHelper

java.lang.Object
org.apache.axiom.om.util.ElementHelper
public class ElementHelper extends Object
Helper class to provide extra utility stuff against elements. The code is designed to work with any element implementation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ElementHelper(org.apache.axiom.om.OMElement element)
    Constructs and binds to an element.

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.apache.axiom.om.OMElement
    getChildWithName(org.apache.axiom.om.OMElement parent, String childName)
    Deprecated.
    please use OMElement.getFirstChildWithName(qname) instead!
    static String
    getContentID(XMLStreamReader parser)
     
    static String
    getContentID(XMLStreamReader parser, String charsetEncoding)
    Deprecated.
    use getContentID(XMLStreamReader) instead (see AXIOM-129)
    static String
    getContentIDFromHref(String href)
    Extract the content ID from a href attribute value, i.e. from a URI following the cid: scheme defined by RFC2392.
    static Reader
    getTextAsStream(org.apache.axiom.om.OMElement element, boolean cache)
    Deprecated.
    Use OMElement.getTextAsStream(boolean) instead.
    static org.apache.axiom.om.OMElement
    importOMElement(org.apache.axiom.om.OMElement omElement, org.apache.axiom.om.OMFactory omFactory)
    Deprecated.
    Use OMFactory.importInformationItem(OMInformationItem) instead.
    QName
    resolveQName(String qname)
    Deprecated.
    The algorithm used by this method is incorrect.
    QName
    resolveQName(String qname, boolean defaultToParentNameSpace)
    Deprecated.
    The algorithm used by this method is incorrect.
    static void
    setNewElement(org.apache.axiom.om.OMElement parent, org.apache.axiom.om.OMElement myElement, org.apache.axiom.om.OMElement newElement)
    Deprecated. 
    static org.apache.axiom.soap.SOAPHeaderBlock
    toSOAPHeaderBlock(org.apache.axiom.om.OMElement omElement, org.apache.axiom.soap.SOAPFactory factory)
    Deprecated.
    Use SOAPFactory.createSOAPHeaderBlock(OMElement) instead.
    static void
    writeTextTo(org.apache.axiom.om.OMElement element, Writer out, boolean cache)
    Deprecated.
    Use OMElement.writeTextTo(Writer, boolean) instead.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ElementHelper

      public ElementHelper(org.apache.axiom.om.OMElement element)
      Constructs and binds to an element.
      Parameters:
      element - element to work with

  • Method Details

    • resolveQName

      public QName resolveQName(String qname, boolean defaultToParentNameSpace)
      Deprecated.
      The algorithm used by this method is incorrect. See AXIOM-356 for more details.

    • resolveQName

      public QName resolveQName(String qname)
      Deprecated.
      The algorithm used by this method is incorrect. See AXIOM-356 for more details.

    • setNewElement

      public static void setNewElement(org.apache.axiom.om.OMElement parent, org.apache.axiom.om.OMElement myElement, org.apache.axiom.om.OMElement newElement)
      Deprecated.

    • getChildWithName

      public static org.apache.axiom.om.OMElement getChildWithName(org.apache.axiom.om.OMElement parent, String childName)
      Deprecated.
      please use OMElement.getFirstChildWithName(qname) instead!

    • getContentID

      public static String getContentID(XMLStreamReader parser, String charsetEncoding)
      Deprecated.
      use getContentID(XMLStreamReader) instead (see AXIOM-129)

    • getContentID

      public static String getContentID(XMLStreamReader parser)

    • getContentIDFromHref

      public static String getContentIDFromHref(String href)
      Extract the content ID from a href attribute value, i.e. from a URI following the cid: scheme defined by RFC2392.
      Parameters:
      href - the value of the href attribute
      Returns:
      the corresponding content ID

    • importOMElement

      public static org.apache.axiom.om.OMElement importOMElement(org.apache.axiom.om.OMElement omElement, org.apache.axiom.om.OMFactory omFactory)
      Deprecated.
      Use OMFactory.importInformationItem(OMInformationItem) instead.
      Some times two OMElements needs to be added to the same object tree. But in Axiom, a single tree should always contain object created from the same type of factory (eg: LinkedListImplFactory, DOMFactory, etc.,). If one OMElement is created from a different factory than that of the factory which was used to create the object in the existing tree, we need to convert the new OMElement to match to the factory of existing object tree. This method will convert omElement to the given omFactory.
      See Also:

    • toSOAPHeaderBlock

      public static org.apache.axiom.soap.SOAPHeaderBlock toSOAPHeaderBlock(org.apache.axiom.om.OMElement omElement, org.apache.axiom.soap.SOAPFactory factory) throws Exception
      Deprecated.
      Use SOAPFactory.createSOAPHeaderBlock(OMElement) instead.
      This is a method to convert regular OMElements to SOAPHeaderBlocks.
      Parameters:
      omElement -
      factory -
      Returns:
      TODO
      Throws:
      Exception

    • getTextAsStream

      public static Reader getTextAsStream(org.apache.axiom.om.OMElement element, boolean cache)
      Deprecated.
      Use OMElement.getTextAsStream(boolean) instead.

    • writeTextTo

      public static void writeTextTo(org.apache.axiom.om.OMElement element, Writer out, boolean cache) throws XMLStreamException, IOException
      Deprecated.
      Use OMElement.writeTextTo(Writer, boolean) instead.
      Throws:
      XMLStreamException
      IOException