Top Methods
org.eclipse.persistence.platform.xml

public Interface XMLPlatform

Known Direct Implementers
org.eclipse.persistence.platform.xml.jaxp.JAXPPlatform
Imports
java.net.URL, java.util.Map, org.eclipse.persistence.oxm.XMLDescriptor, org.w3c.dom.Document, .Element, .Node, .NodeList, .Text, org.xml.sax.ErrorHandler

Method Summary

Modifier and TypeMethod and Description
public Document

Returns:

the new document
createDocument
()

Creates a new document.

public Document

Returns:

the new document
createDocumentWithPublicIdentifier
(String
the name of the root element publicIdentifier the public identifier systemIdentifier the system identifier
name
,
String publicIdentifier, 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.

public Document

Returns:

the new document
createDocumentWithSystemIdentifier
(String
the name of the root element systemIdentifier the system identifier
name
,
String systemIdentifier)

Creates a new document with the specified system identifier in the DOCTYPE, and adds a root element with the specified name.

public boolean
public boolean

Returns:

if the text node represents a whitespace node.
isWhitespaceNode
(Text
a potential whitespace node
text
)

Check to see if the text node represents a whitespace node.

public void
namespaceQualifyFragment(Element
Element to qualify
next
)

public XMLParser

Returns:

a platform specific XML parser
newXMLParser
()

Return a concrete implementation of the XML parser abstraction that is compatible with the XML Platform.

public XMLParser

Returns:

a platform specific XML parser
newXMLParser
(Map<String, Boolean> parserFeatures)

Return a concrete implementation of the XML parser abstraction that is compatible with the XML Platform, based on these parser features.

public XMLTransformer

Returns:

a platform specific XML transformer
newXMLTransformer
()

Return a concrete implementation of the XML transformer abstraction that is compatible with the XML Platform.

public String

Returns:

the namespace URI for the specified prefix
resolveNamespacePrefix
(Node
the node to be looking for the namespace URI namespacePrefix the namespace prefix
contextNode
,
String namespacePrefix)

Return the namespace URI for the specified namespace prefix relative to the context node.

public NodeList

Returns:

the XPath result
selectNodesAdvanced
(Node
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
contextNode
,
String xPath, XMLNamespaceResolver xmlNamespaceResolver)

Execute advanced XPath statements that are required for TopLink EIS.

public Node
selectSingleNodeAdvanced(Node contextNode, String xPath, XMLNamespaceResolver xmlNamespaceResolver)

Execute advanced XPath statements that are required for TopLink EIS.

public void
setDisableSecureProcessing(boolean disableSecureProcessing)

public boolean

Returns:

true if the document fragment is valid, false otherwise
validate
(Element elem, XMLDescriptor xmlDescriptor, ErrorHandler handler)

Validates a document fragment against a complex type or element in the XML schema

public boolean

Returns:

true if the document is valid, else false
validateDocument
(Document
the document to be validated
document
,
URL
the XML Schema
xmlSchemaURL
,
ErrorHandler
a mechanism for selectively ignoring errors
errorHandler
)

Validate the document against the XML Schema

Method Detail

createDocumentback to summary
public Document createDocument() throws XMLPlatformException

Creates a new document.

Returns:Document

the new document

createDocumentWithPublicIdentifierback to summary
public Document createDocumentWithPublicIdentifier(String name, String publicIdentifier, 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:String

the name of the root element publicIdentifier the public identifier systemIdentifier the system identifier

Returns:Document

the new document

createDocumentWithSystemIdentifierback to summary
public Document createDocumentWithSystemIdentifier(String name, 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:String

the name of the root element systemIdentifier the system identifier

Returns:Document

the new document

isSecureProcessingDisabledback to summary
public boolean isSecureProcessingDisabled()
isWhitespaceNodeback to summary
public boolean isWhitespaceNode(Text text)

Check to see if the text node represents a whitespace node.

Parameters
text:Text

a potential whitespace node

Returns:boolean

if the text node represents a whitespace node.

namespaceQualifyFragmentback to summary
public void namespaceQualifyFragment(Element next)
Parameters
next:Element

Element to qualify

newXMLParserback to summary
public XMLParser newXMLParser()

Return a concrete implementation of the XML parser abstraction that is compatible with the XML Platform.

Returns:XMLParser

a platform specific XML parser

newXMLParserback to summary
public XMLParser newXMLParser(Map<String, Boolean> parserFeatures)

Return a concrete implementation of the XML parser abstraction that is compatible with the XML Platform, based on these parser features.

Returns:XMLParser

a platform specific XML parser

newXMLTransformerback to summary
public XMLTransformer newXMLTransformer()

Return a concrete implementation of the XML transformer abstraction that is compatible with the XML Platform.

Returns:XMLTransformer

a platform specific XML transformer

resolveNamespacePrefixback to summary
public String resolveNamespacePrefix(Node contextNode, String namespacePrefix) throws XMLPlatformException

Return the namespace URI for the specified namespace prefix relative to the context node.

Parameters
contextNode:Node

the node to be looking for the namespace URI namespacePrefix the namespace prefix

Returns:String

the namespace URI for the specified prefix

selectNodesAdvancedback to summary
public NodeList selectNodesAdvanced(Node contextNode, String xPath, XMLNamespaceResolver xmlNamespaceResolver) throws XMLPlatformException

Execute advanced XPath statements that are required for TopLink EIS.

Parameters
contextNode:Node

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:NodeList

the XPath result

selectSingleNodeAdvancedback to summary
public Node selectSingleNodeAdvanced(Node contextNode, String xPath, XMLNamespaceResolver xmlNamespaceResolver) throws XMLPlatformException

Execute advanced XPath statements that are required for TopLink EIS.

setDisableSecureProcessingback to summary
public void setDisableSecureProcessing(boolean disableSecureProcessing)
validateback to summary
public boolean validate(Element elem, XMLDescriptor xmlDescriptor, ErrorHandler handler) throws XMLPlatformException

Validates a document fragment against a complex type or element in the XML schema

Returns:boolean

true if the document fragment is valid, false otherwise

validateDocumentback to summary
public boolean validateDocument(Document document, URL xmlSchemaURL, ErrorHandler errorHandler) throws XMLPlatformException

Validate the document against the XML Schema

Parameters
document:Document

the document to be validated

xmlSchemaURL:URL

the XML Schema

errorHandler:ErrorHandler

a mechanism for selectively ignoring errors

Returns:boolean

true if the document is valid, else false