Module eclipselink

Package org.eclipse.persistence.platform.xml

Interface XMLPlatform

All Known Implementing Classes:

JAXPPlatform, XDKPlatform

public interface XMLPlatform

Method Summary

Modifier and Type	Method	Description
Document	createDocument()	Creates a new document.
Document	createDocumentWithPublicIdentifier(String 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.
Document	createDocumentWithSystemIdentifier(String name, 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(Text text)	Check to see if the text node represents a whitespace node.
void	namespaceQualifyFragment(Element next)
XMLParser	newXMLParser()	Return a concrete implementation of the XML parser abstraction that is compatible with the XML Platform.
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.
XMLTransformer	newXMLTransformer()	Return a concrete implementation of the XML transformer abstraction that is compatible with the XML Platform.
String	resolveNamespacePrefix(Node contextNode, String namespacePrefix)	Return the namespace URI for the specified namespace prefix relative to the context node.
NodeList	selectNodesAdvanced(Node contextNode, String xPath, XMLNamespaceResolver xmlNamespaceResolver)	Execute advanced XPath statements that are required for TopLink EIS.
Node	selectSingleNodeAdvanced(Node contextNode, String xPath, XMLNamespaceResolver xmlNamespaceResolver)	Execute advanced XPath statements that are required for TopLink EIS.
void	setDisableSecureProcessing(boolean disableSecureProcessing)
boolean	validate(Element elem, XMLDescriptor xmlDescriptor, ErrorHandler handler)	Validates a document fragment against a complex type or element in the XML schema
boolean	validateDocument(Document document, URL xmlSchemaURL, ErrorHandler errorHandler)	Validate the document against the XML Schema

Method Detail

createDocument

Document createDocument()
                 throws XMLPlatformException

Creates a new document.

Returns:

the new document

Throws:

XMLPlatformException

createDocumentWithPublicIdentifier

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 - the name of the root element publicIdentifier the public identifier systemIdentifier the system identifier

Returns:

the new document

Throws:

XMLPlatformException

createDocumentWithSystemIdentifier

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 - the name of the root element systemIdentifier the system identifier

Returns:

the new document

Throws:

XMLPlatformException

isWhitespaceNode

boolean isWhitespaceNode(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

String resolveNamespacePrefix(Node contextNode,
                              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

NodeList selectNodesAdvanced(Node contextNode,
                             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

Node selectSingleNodeAdvanced(Node contextNode,
                              String xPath,
                              XMLNamespaceResolver xmlNamespaceResolver)
                       throws XMLPlatformException

Execute advanced XPath statements that are required for TopLink EIS.

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

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(Document document,
                         URL xmlSchemaURL,
                         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(Element elem,
                 XMLDescriptor xmlDescriptor,
                 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(Element next)

Parameters:

next - Element to qualify

setDisableSecureProcessing

void setDisableSecureProcessing(boolean disableSecureProcessing)

isSecureProcessingDisabled

boolean isSecureProcessingDisabled()