Package org.eclipse.persistence.platform.xml

Interface XMLPlatform

  • All Known Implementing Classes:
    JAXPPlatform
    public interface XMLPlatform

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.w3c.dom.Document createDocument()
      Creates a new document.
      org.w3c.dom.Document createDocumentWithPublicIdentifier​(java.lang.String name, java.lang.String publicIdentifier, java.lang.String systemIdentifier)
      Creates a new document with the specified public and system identifiers in the DOCTYPE, and adds a root element with the specified name.
      org.w3c.dom.Document createDocumentWithSystemIdentifier​(java.lang.String name, java.lang.String systemIdentifier)
      Creates a new document with the specified system identifier in the DOCTYPE, and adds a root element with the specified name.
      boolean isSecureProcessingDisabled()  
      boolean isWhitespaceNode​(org.w3c.dom.Text text)
      Check to see if the text node represents a whitespace node.
      void namespaceQualifyFragment​(org.w3c.dom.Element next)  
      XMLParser newXMLParser()
      Return a concrete implementation of the XML parser abstraction that is compatible with the XML Platform.
      XMLParser newXMLParser​(java.util.Map<java.lang.String,​java.lang.Boolean> parserFeatures)
      Return a concrete implementation of the XML parser abstraction that is compatible with the XML Platform, based on these parser features.
      XMLTransformer newXMLTransformer()
      Return a concrete implementation of the XML transformer abstraction that is compatible with the XML Platform.
      java.lang.String resolveNamespacePrefix​(org.w3c.dom.Node contextNode, java.lang.String namespacePrefix)
      Return the namespace URI for the specified namespace prefix relative to the context node.
      org.w3c.dom.NodeList selectNodesAdvanced​(org.w3c.dom.Node contextNode, java.lang.String xPath, XMLNamespaceResolver xmlNamespaceResolver)
      Execute advanced XPath statements that are required for TopLink EIS.
      org.w3c.dom.Node selectSingleNodeAdvanced​(org.w3c.dom.Node contextNode, java.lang.String xPath, XMLNamespaceResolver xmlNamespaceResolver)
      Execute advanced XPath statements that are required for TopLink EIS.
      void setDisableSecureProcessing​(boolean disableSecureProcessing)  
      boolean validate​(org.w3c.dom.Element elem, XMLDescriptor xmlDescriptor, org.xml.sax.ErrorHandler handler)
      Validates a document fragment against a complex type or element in the XML schema
      boolean validateDocument​(org.w3c.dom.Document document, java.net.URL xmlSchemaURL, org.xml.sax.ErrorHandler errorHandler)
      Validate the document against the XML Schema

    • Method Detail

      • createDocumentWithPublicIdentifier

        org.w3c.dom.Document createDocumentWithPublicIdentifier​(java.lang.String name,
                                                        java.lang.String publicIdentifier,
                                                        java.lang.String systemIdentifier)
                                                 throws XMLPlatformException
        Creates a new document with the specified public and system identifiers in the DOCTYPE, and adds a root element with the specified name.
        Parameters:
        name - the name of the root element publicIdentifier the public identifier systemIdentifier the system identifier
        Returns:
        the new document
        Throws:
        XMLPlatformException

      • createDocumentWithSystemIdentifier

        org.w3c.dom.Document createDocumentWithSystemIdentifier​(java.lang.String name,
                                                        java.lang.String systemIdentifier)
                                                 throws XMLPlatformException
        Creates a new document with the specified system identifier in the DOCTYPE, and adds a root element with the specified name.
        Parameters:
        name - the name of the root element systemIdentifier the system identifier
        Returns:
        the new document
        Throws:
        XMLPlatformException

      • isWhitespaceNode

        boolean isWhitespaceNode​(org.w3c.dom.Text text)
        Check to see if the text node represents a whitespace node.
        Parameters:
        text - a potential whitespace node
        Returns:
        if the text node represents a whitespace node.

      • resolveNamespacePrefix

        java.lang.String resolveNamespacePrefix​(org.w3c.dom.Node contextNode,
                                        java.lang.String namespacePrefix)
                                 throws XMLPlatformException
        Return the namespace URI for the specified namespace prefix relative to the context node.
        Parameters:
        contextNode - the node to be looking for the namespace URI namespacePrefix the namespace prefix
        Returns:
        the namespace URI for the specified prefix
        Throws:
        XMLPlatformException

      • selectNodesAdvanced

        org.w3c.dom.NodeList selectNodesAdvanced​(org.w3c.dom.Node contextNode,
                                         java.lang.String xPath,
                                         XMLNamespaceResolver xmlNamespaceResolver)
                                  throws XMLPlatformException
        Execute advanced XPath statements that are required for TopLink EIS.
        Parameters:
        contextNode - the node relative to which the XPath statement will be executed. xPath the XPath statement namespaceResolver used to resolve namespace prefixes to the corresponding namespace URI
        Returns:
        the XPath result
        Throws:
        XMLPlatformException

      • selectSingleNodeAdvanced

        org.w3c.dom.Node selectSingleNodeAdvanced​(org.w3c.dom.Node contextNode,
                                          java.lang.String xPath,
                                          XMLNamespaceResolver xmlNamespaceResolver)
                                   throws XMLPlatformException
        Execute advanced XPath statements that are required for TopLink EIS.
        Parameters:
        contextNode -
        xPath -
        xmlNamespaceResolver -
        Returns:
        Throws:
        XMLPlatformException

      • newXMLParser

        XMLParser newXMLParser()
        Return a concrete implementation of the XML parser abstraction that is compatible with the XML Platform.
        Returns:
        a platform specific XML parser

      • newXMLParser

        XMLParser newXMLParser​(java.util.Map<java.lang.String,​java.lang.Boolean> parserFeatures)
        Return a concrete implementation of the XML parser abstraction that is compatible with the XML Platform, based on these parser features.
        Returns:
        a platform specific XML parser

      • newXMLTransformer

        XMLTransformer newXMLTransformer()
        Return a concrete implementation of the XML transformer abstraction that is compatible with the XML Platform.
        Returns:
        a platform specific XML transformer

      • validateDocument

        boolean validateDocument​(org.w3c.dom.Document document,
                         java.net.URL xmlSchemaURL,
                         org.xml.sax.ErrorHandler errorHandler)
                  throws XMLPlatformException
        Validate the document against the XML Schema
        Parameters:
        document - the document to be validated
        xmlSchemaURL - the XML Schema
        errorHandler - a mechanism for selectively ignoring errors
        Returns:
        true if the document is valid, else false
        Throws:
        XMLPlatformException

      • validate

        boolean validate​(org.w3c.dom.Element elem,
                 XMLDescriptor xmlDescriptor,
                 org.xml.sax.ErrorHandler handler)
          throws XMLPlatformException
        Validates a document fragment against a complex type or element in the XML schema
        Returns:
        true if the document fragment is valid, false otherwise
        Throws:
        XMLPlatformException

      • namespaceQualifyFragment

        void namespaceQualifyFragment​(org.w3c.dom.Element next)
        Parameters:
        next - Element to qualify

      • setDisableSecureProcessing

        void setDisableSecureProcessing​(boolean disableSecureProcessing)

      • isSecureProcessingDisabled

        boolean isSecureProcessingDisabled()