oracle.toplink.essentials.internal.ejb.cmp3.xml

Class XMLHelper

java.lang.Object

oracle.toplink.essentials.internal.ejb.cmp3.xml.XMLHelper

public class XMLHelper
extends Object

Utility class used for handling element inspection.

Since:

TopLink EJB 3.0 Reference Implementation

Author:

Guy Pelletier

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMLHelper(Document document, ClassLoader loader) INTERNAL:
	XMLHelper(Document document, String fileName, ClassLoader loader) INTERNAL:

Method Summary

Modifier and Type	Method and Description
List<String>	getCascadeTypes(Node node) INTERNAL:
Class	getClassForName(String className) INTERNAL:
Class	getClassForNode(Node node) INTERNAL: Return the Class for a given node.
ClassLoader	getClassLoader() INTERNAL: Get the loader.
String	getClassNameForNode(Node node) INTERNAL: Return the fully qualified class name for a given node.
Document	getDocument() INTERNAL: Return the instance document associated with this helper.
String	getDocumentName() INTERNAL: Return the instance document name associated with this helper.
String	getFetchTypeDefaultEAGER(Node node) INTERNAL:
String	getFetchTypeDefaultLAZY(Node node) INTERNAL:
String	getFullyQualifiedClassName(String className) INTERNAL: This convenience method will attempt to fully qualify a class name if required.
static String	getFullyQualifiedClassName(String className, String packageName) INTERNAL: This convenience method will attempt to fully qualify a class name if required.
String	getLoggingContextForDefaultMappingReferenceClass(Node mappingNode) INTERNAL: This convenience method determines the type of relationship mapping the node represents, and returns the appropriate logging context.
String	getMappedBy(Node node) INTERNAL:
Node	getNode(Node node, String xPath) INTERNAL: Get a node off the given node.
Node	getNode(Node node, String[] xPath) INTERNAL: Get a node off the given node.
Node	getNode(String[] xPath) INTERNAL: Get a node off the document node.
NodeList	getNodes(Node node, String xPath) INTERNAL:
NodeList	getNodes(Node node, String[] xPath) INTERNAL:
NodeList	getNodes(Node node, String xPath1, String xPath2) INTERNAL:
NodeList	getNodes(String[] xPath) INTERNAL: Get the nodes off the given node.
NodeList	getNodes(String xPath1, String xPath2) INTERNAL: Get the nodes off the given node.
String	getNodeTextValue(Node node, String xPath) INTERNAL:
String	getNodeTextValue(String xPath1, String xPath2) INTERNAL:
String	getNodeTextValue(String xPath1, String xPath2, String defaultValue) INTERNAL:
String	getNodeValue(Node node, String xPath) INTERNAL:
String	getNodeValue(Node node, String[] xPath) INTERNAL:
boolean	getNodeValue(Node node, String[] xPath, boolean defaultValue) INTERNAL:
Class	getNodeValue(Node node, String[] xPath, Class defaultValue) INTERNAL:
int	getNodeValue(Node node, String[] xPath, int defaultValue) INTERNAL:
String	getNodeValue(Node node, String[] xPath, String defaultValue) INTERNAL:
boolean	getNodeValue(Node node, String xPath, boolean defaultValue) INTERNAL:
Class	getNodeValue(Node node, String xPath, Class defaultValue) INTERNAL:
int	getNodeValue(Node node, String xPath, int defaultValue) INTERNAL:
String	getNodeValue(Node node, String xPath, String defaultValue) INTERNAL:
String	getNodeValue(String[] xPath) INTERNAL:
int	getNodeValue(String[] xPath, int defaultValue) INTERNAL:
String	getNodeValue(String[] xPath, String defaultValue) INTERNAL:
String	getPackage() INTERNAL:
Class	getTargetEntity(Node node) INTERNAL:
NodeList	getTextColumnNodes(Node node) INTERNAL:
boolean	hasNode(Node node, String xPath) INTERNAL:
boolean	isOptional(Node node) INTERNAL:
Node	locateEmbeddableNode(Class cls) INTERNAL: Locate a node in the DOM tree for a given class.
Node	locateEntityNode(Class cls) INTERNAL: Locate a node in the DOM tree for a given class.
Node	locateMappedSuperclassNode(Class cls) INTERNAL: Locate a node in the DOM tree for a given class.
Node	locateNode(Class cls) INTERNAL: Locate a node in the DOM tree for the given class.
Node	locateNodeForAttribute(Node node, String attributeName) INTERNAL: Locate a node in the DOM tree for a given attribute name.
Class	locateRootEntity(Class entityClass) INTERNAL: Return the root entity in an entity class hierarchy
boolean	nodeHasJoinColumns(Node node) INTERNAL: Indicates if a given node has a primary-key-join-column sub-element.
boolean	nodeHasPrimaryKeyJoinColumns(Node node) INTERNAL: Indicates if a given node has a primary-key-join-column sub-element.
static Document	parseDocument(InputStream xmlDocumentInputStream, String documentName, ClassLoader loader) INTERNAL: Build a DOM from an instance document using the provided URL.
void	setLoader(ClassLoader loader) INTERNAL: Update the loader after it changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLHelper

protected XMLHelper(Document document,
                    ClassLoader loader)

INTERNAL:

XMLHelper

public XMLHelper(Document document,
                 String fileName,
                 ClassLoader loader)

INTERNAL:

Method Detail

getCascadeTypes

public List<String> getCascadeTypes(Node node)

INTERNAL:

getClassForName

public Class getClassForName(String className)

INTERNAL:

getClassForNode

public Class getClassForNode(Node node)

INTERNAL: Return the Class for a given node. This method assumes that the node requires a class attribute, i.e. entity or mapped-superclass.

getClassNameForNode

public String getClassNameForNode(Node node)

INTERNAL: Return the fully qualified class name for a given node. This method assumes that the node requires a class attribute, i.e. entity or mapped-superclass.

getDocument

public Document getDocument()

INTERNAL: Return the instance document associated with this helper.

getDocumentName

public String getDocumentName()

INTERNAL: Return the instance document name associated with this helper.

getFetchTypeDefaultEAGER

public String getFetchTypeDefaultEAGER(Node node)

INTERNAL:

getFetchTypeDefaultLAZY

public String getFetchTypeDefaultLAZY(Node node)

INTERNAL:

getFullyQualifiedClassName

public String getFullyQualifiedClassName(String className)

INTERNAL: This convenience method will attempt to fully qualify a class name if required. This assumes that the className value is non-null, and a "qualified" class name contains at least one '.'

getFullyQualifiedClassName

public static String getFullyQualifiedClassName(String className,
                                                String packageName)

INTERNAL: This convenience method will attempt to fully qualify a class name if required. This assumes that the className value is non-null, and a "qualified" class name contains at least one '.'

getLoggingContextForDefaultMappingReferenceClass

public String getLoggingContextForDefaultMappingReferenceClass(Node mappingNode)

INTERNAL: This convenience method determines the type of relationship mapping the node represents, and returns the appropriate logging context.

getMappedBy

public String getMappedBy(Node node)

INTERNAL:

getNode

public Node getNode(Node node,
                    String xPath)

INTERNAL: Get a node off the given node.

getNode

public Node getNode(Node node,
                    String[] xPath)

INTERNAL: Get a node off the given node.

getNode

public Node getNode(String[] xPath)

INTERNAL: Get a node off the document node.

getNodes

public NodeList getNodes(String xPath1,
                         String xPath2)

INTERNAL: Get the nodes off the given node.

getNodes

public NodeList getNodes(String[] xPath)

INTERNAL: Get the nodes off the given node.

getNodeTextValue

public String getNodeTextValue(Node node,
                               String xPath)

INTERNAL:

getNodeTextValue

public String getNodeTextValue(String xPath1,
                               String xPath2)

INTERNAL:

getNodeTextValue

public String getNodeTextValue(String xPath1,
                               String xPath2,
                               String defaultValue)

INTERNAL:

getNodeValue

public String getNodeValue(Node node,
                           String xPath)

INTERNAL:

getNodeValue

public boolean getNodeValue(Node node,
                            String xPath,
                            boolean defaultValue)

INTERNAL:

getNodeValue

public Class getNodeValue(Node node,
                          String xPath,
                          Class defaultValue)

INTERNAL:

getNodeValue

public int getNodeValue(Node node,
                        String xPath,
                        int defaultValue)

INTERNAL:

getNodeValue

public String getNodeValue(Node node,
                           String xPath,
                           String defaultValue)

INTERNAL:

getNodes

public NodeList getNodes(Node node,
                         String xPath)

INTERNAL:

getNodes

public NodeList getNodes(Node node,
                         String xPath1,
                         String xPath2)

INTERNAL:

getNodes

public NodeList getNodes(Node node,
                         String[] xPath)

INTERNAL:

getNodeValue

public boolean getNodeValue(Node node,
                            String[] xPath,
                            boolean defaultValue)

INTERNAL:

getNodeValue

public Class getNodeValue(Node node,
                          String[] xPath,
                          Class defaultValue)

INTERNAL:

getNodeValue

public int getNodeValue(Node node,
                        String[] xPath,
                        int defaultValue)

INTERNAL:

getNodeValue

public String getNodeValue(Node node,
                           String[] xPath,
                           String defaultValue)

INTERNAL:

getNodeValue

public String getNodeValue(Node node,
                           String[] xPath)

INTERNAL:

getNodeValue

public String getNodeValue(String[] xPath)

INTERNAL:

getNodeValue

public int getNodeValue(String[] xPath,
                        int defaultValue)

INTERNAL:

getNodeValue

public String getNodeValue(String[] xPath,
                           String defaultValue)

INTERNAL:

getPackage

public String getPackage()

INTERNAL:

getTargetEntity

public Class getTargetEntity(Node node)

INTERNAL:

getTextColumnNodes

public NodeList getTextColumnNodes(Node node)

INTERNAL:

hasNode

public boolean hasNode(Node node,
                       String xPath)

INTERNAL:

isOptional

public boolean isOptional(Node node)

INTERNAL:

locateEmbeddableNode

public Node locateEmbeddableNode(Class cls)

INTERNAL: Locate a node in the DOM tree for a given class.

locateEntityNode

public Node locateEntityNode(Class cls)

INTERNAL: Locate a node in the DOM tree for a given class.

locateMappedSuperclassNode

public Node locateMappedSuperclassNode(Class cls)

INTERNAL: Locate a node in the DOM tree for a given class.

locateNode

public Node locateNode(Class cls)

INTERNAL: Locate a node in the DOM tree for the given class. Will look for an entity, embeddable, or mapped-superclass node with @class matching the class name.

locateNodeForAttribute

public Node locateNodeForAttribute(Node node,
                                   String attributeName)

INTERNAL: Locate a node in the DOM tree for a given attribute name.

locateRootEntity

public Class locateRootEntity(Class entityClass)

INTERNAL: Return the root entity in an entity class hierarchy

nodeHasPrimaryKeyJoinColumns

public boolean nodeHasPrimaryKeyJoinColumns(Node node)

INTERNAL: Indicates if a given node has a primary-key-join-column sub-element.

nodeHasJoinColumns

public boolean nodeHasJoinColumns(Node node)

INTERNAL: Indicates if a given node has a primary-key-join-column sub-element.

parseDocument

public static Document parseDocument(InputStream xmlDocumentInputStream,
                                     String documentName,
                                     ClassLoader loader)

INTERNAL: Build a DOM from an instance document using the provided URL.

setLoader

public void setLoader(ClassLoader loader)

INTERNAL: Update the loader after it changes.

getClassLoader

public ClassLoader getClassLoader()

INTERNAL: Get the loader.