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
|
/*
* Copyright (c) 1998, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.platform.xml;
import java.net.URL;
import java.util.Map;
import org.eclipse.persistence.oxm.XMLDescriptor;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Text;
import org.xml.sax.ErrorHandler;
public interface XMLPlatform {
/**
* Creates a new document.
* @return the new document
* @throws XMLPlatformException
*/
public Document createDocument() 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.
* @param name the name of the root element
* publicIdentifier the public identifier
* systemIdentifier the system identifier
* @return the new document
* @throws XMLPlatformException
*/
public Document createDocumentWithPublicIdentifier(String name, String publicIdentifier, 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.
* @param name the name of the root element
* systemIdentifier the system identifier
* @return the new document
* @throws XMLPlatformException
*/
public Document createDocumentWithSystemIdentifier(String name, String systemIdentifier) throws XMLPlatformException;
/**
* Check to see if the text node represents a whitespace node.
* @param text a potential whitespace node
* @return if the text node represents a whitespace node.
*/
public boolean isWhitespaceNode(Text text);
/**
* Return the namespace URI for the specified namespace prefix
* relative to the context node.
* @param contextNode the node to be looking for the namespace
* URI
* namespacePrefix the namespace prefix
* @return the namespace URI for the specified prefix
* @throws XMLPlatformException
*/
public String resolveNamespacePrefix(Node contextNode, String namespacePrefix) throws XMLPlatformException;
/**
* Execute advanced XPath statements that are required for TopLink EIS.
* @param 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
* @return the XPath result
* @throws XMLPlatformException
*/
public NodeList selectNodesAdvanced(Node contextNode, String xPath, XMLNamespaceResolver xmlNamespaceResolver) throws XMLPlatformException;
/**
* Execute advanced XPath statements that are required for TopLink EIS.
* @param contextNode
* @param xPath
* @param xmlNamespaceResolver
* @return
* @throws XMLPlatformException
*/
public Node selectSingleNodeAdvanced(Node contextNode, String xPath, XMLNamespaceResolver xmlNamespaceResolver) throws XMLPlatformException;
/**
* Return a concrete implementation of the XML parser abstraction that is
* compatible with the XML Platform.
* @return a platform specific XML parser
*/
public XMLParser newXMLParser();
/**
* Return a concrete implementation of the XML parser abstraction that is
* compatible with the XML Platform, based on these parser features.
* @return a platform specific XML parser
*/
public XMLParser newXMLParser(Map<String, Boolean> parserFeatures);
/**
* Return a concrete implementation of the XML transformer abstraction that is
* compatible with the XML Platform.
* @return a platform specific XML transformer
*/
public XMLTransformer newXMLTransformer();
/**
* Validate the document against the XML Schema
* @param document the document to be validated
* @param xmlSchemaURL the XML Schema
* @param errorHandler a mechanism for selectively ignoring errors
* @return true if the document is valid, else false
* @throws XMLPlatformException
*/
public boolean validateDocument(Document document, URL xmlSchemaURL, ErrorHandler errorHandler) throws XMLPlatformException;
/**
* Validates a document fragment against a complex type or element in the XML schema
*
* @return true if the document fragment is valid, false otherwise
*/
public boolean validate(Element elem, XMLDescriptor xmlDescriptor, ErrorHandler handler) throws XMLPlatformException;
/**
*
* @param next Element to qualify
*/
public void namespaceQualifyFragment(Element next);
void setDisableSecureProcessing(boolean disableSecureProcessing);
boolean isSecureProcessingDisabled();
}
|
