org.datanucleus.store.xml

Class XMLUtils

java.lang.Object

org.datanucleus.store.xml.XMLUtils

public class XMLUtils
extends Object

Utilities for XML datastores.

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static org.datanucleus.metadata.AbstractClassMetaData	findMetaDataForNode(Document doc, org.datanucleus.metadata.AbstractClassMetaData acmd, org.datanucleus.metadata.MetaDataManager mmgr, String value, org.datanucleus.ClassLoaderResolver clr) Accessor for correct inheritance level of an object with a specified PK field value.
static Node	findNode(Document doc, org.datanucleus.state.ObjectProvider op) Accessor for the Node with the specified identity (if present).
static String	getDefaultRootXPath() Convenience method to return the default root element name to use if none specified.
static String	getElementNameForClass(org.datanucleus.metadata.AbstractClassMetaData cmd) Method to return the name of the XML element where we store the objects of the specified type.
static String	getElementNameForMember(org.datanucleus.metadata.AbstractMemberMetaData mmd, org.datanucleus.metadata.FieldRole role) Method to return the name of the XML element to use for the specified field/property.
static Class	getElementTypeForMember(org.datanucleus.metadata.AbstractMemberMetaData mmd, org.datanucleus.ClassLoaderResolver clr) Method to return the type of the XML element to use for the specified field/property.
static String	getJAXBDefaultNameForName(String name) Convenience method to return the JAXB default for the name of a class/field.
static String	getXPathForClass(org.datanucleus.metadata.AbstractClassMetaData cmd) Method to return the XPath where the specified class is located in the XML file.
static org.datanucleus.state.ObjectProvider	prepareXMLObjectForUse(Object obj, org.datanucleus.ExecutionContext ec, org.datanucleus.metadata.AbstractClassMetaData acmd) Convenience method to take an object returned by XML (from a query for example), and prepare it for passing to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

prepareXMLObjectForUse

public static org.datanucleus.state.ObjectProvider prepareXMLObjectForUse(Object obj,
                                                          org.datanucleus.ExecutionContext ec,
                                                          org.datanucleus.metadata.AbstractClassMetaData acmd)

Convenience method to take an object returned by XML (from a query for example), and prepare it for passing to the user. Makes sure there is a ObjectProvider connected, with all fields marked as loaded.

Parameters:

obj - The object (from XML)

ec - execution context

acmd - ClassMetaData for the object

Returns:

The ObjectProvider for this object

findMetaDataForNode

public static org.datanucleus.metadata.AbstractClassMetaData findMetaDataForNode(Document doc,
                                                                 org.datanucleus.metadata.AbstractClassMetaData acmd,
                                                                 org.datanucleus.metadata.MetaDataManager mmgr,
                                                                 String value,
                                                                 org.datanucleus.ClassLoaderResolver clr)

Accessor for correct inheritance level of an object with a specified PK field value.

Parameters:

doc - The document

acmd - Metadata for the class to start from

mmgr - Metadata manager

value - value of PK field to search for

clr - ClassLoader resolver

Returns:

Metadata for the class that this is an instance of.

findNode

public static Node findNode(Document doc,
            org.datanucleus.state.ObjectProvider op)

Accessor for the Node with the specified identity (if present).

Parameters:

doc - The document

op - ObjectProvider

Returns:

The object

Throws:

org.datanucleus.exceptions.NucleusObjectNotFoundException - if the document is null

getElementTypeForMember

public static Class getElementTypeForMember(org.datanucleus.metadata.AbstractMemberMetaData mmd,
                            org.datanucleus.ClassLoaderResolver clr)

Method to return the type of the XML element to use for the specified field/property. Null implies no value defined

Parameters:

mmd - Metadata for the field/property

clr - ClassLoader resolver

Returns:

The type

getXPathForClass

public static String getXPathForClass(org.datanucleus.metadata.AbstractClassMetaData cmd)

Method to return the XPath where the specified class is located in the XML file. Firstly tries "xpath" extension on the class, otherwise uses the "schema" for the class, or package, or file. If no definition is found returns null.

Parameters:

cmd - Metadata for the class

Returns:

The XPath name

getDefaultRootXPath

public static String getDefaultRootXPath()

Convenience method to return the default root element name to use if none specified.

Returns:

The root element name

getElementNameForClass

public static String getElementNameForClass(org.datanucleus.metadata.AbstractClassMetaData cmd)

Method to return the name of the XML element where we store the objects of the specified type. Uses "name" extension on the class, otherwise the table name for the class, otherwise tries to respect inheritance strategy settings, otherwise uses the lowercase form of the class name.

Parameters:

cmd - Metadata for the class

Returns:

Name of the XML element where we store objects of this type

getElementNameForMember

public static String getElementNameForMember(org.datanucleus.metadata.AbstractMemberMetaData mmd,
                             org.datanucleus.metadata.FieldRole role)

Method to return the name of the XML element to use for the specified field/property. Tries the extension "name" for the component being named, otherwise uses the column name, otherwise falls back to the JAXB default (if a field), or a predefined default if a component of a collection/array/map.

Parameters:

mmd - Metadata for the field/property

role - Role within this field

Returns:

The name

getJAXBDefaultNameForName

public static String getJAXBDefaultNameForName(String name)

Convenience method to return the JAXB default for the name of a class/field. Simply changes the first character to lowercase.

Parameters:

name - The original name

Returns:

The JAXB name