Package org.datanucleus.api.jpa.metadata

Class JPAXmlMetaDataHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.datanucleus.metadata.xml.AbstractXmlMetaDataHandler

org.datanucleus.api.jpa.metadata.JPAXmlMetaDataHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class JPAXmlMetaDataHandler
extends org.datanucleus.metadata.xml.AbstractXmlMetaDataHandler

Parser handler for JPA XML MetaData. Implements DefaultHandler and handles the extracting of MetaData for JPA from the XML elements/attributes. This class simply constructs the MetaData representation mirroring what is in the XML MetaData file. It has no knowledge of the class(es) that it represents, simply the information in the XML MetaData file. The knowledge of the classes is imposed on the representation at a later stage where necessary.

Operates the parse process using a Stack. XML MetaData components are added to the stack as they are encountered and created. They are then popped off the stack when the end element is encountered.

Field Summary

Fields inherited from class org.datanucleus.metadata.xml.AbstractXmlMetaDataHandler

charactersBuffer, clr, entityResolver, filename, metadata, mmgr, stack, validate

Constructor Summary

Constructors

Constructor	Description
JPAXmlMetaDataHandler(org.datanucleus.metadata.MetaDataManager mgr, String filename, EntityResolver resolver)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	endElement(String uri, String localName, String qName)	Handler method called at the end of an element.
protected org.datanucleus.metadata.ClassMetaData	newClassObject(org.datanucleus.metadata.PackageMetaData pmd, Attributes attrs, boolean embeddedOnly)	Utility to create a new class component.
protected org.datanucleus.metadata.AbstractMemberMetaData	newEmbeddedFieldObject(org.datanucleus.metadata.MetaData md, String name)	Utility to create a new embedded field/property component.
protected org.datanucleus.metadata.AbstractMemberMetaData	newFieldObject(org.datanucleus.metadata.AbstractClassMetaData acmd, Attributes attrs, String dfgDefault)	Utility to create a new field/property component and add it to the class as required.
protected org.datanucleus.metadata.AbstractMemberMetaData	newOverriddenEmbeddedFieldObject(org.datanucleus.metadata.EmbeddedMetaData embmd, String memberName, String columnName)	Recursive method to process embedded member overrides.
protected org.datanucleus.metadata.AbstractMemberMetaData	newOverriddenEmbeddedFieldObject(org.datanucleus.metadata.EmbeddedMetaData embmd, Attributes attrs)	Utility to create a new field entry for a field/property in a superclass.
protected org.datanucleus.metadata.AbstractMemberMetaData	newOverriddenFieldObject(org.datanucleus.metadata.MetaData md, Attributes attrs)	Utility to create a new field entry for a field/property in a superclass.
protected org.datanucleus.metadata.AbstractMemberMetaData	newPKFieldObject(org.datanucleus.metadata.AbstractClassMetaData acmd, Attributes attrs)	Utility to create a new primary key field/property component.
protected org.datanucleus.metadata.AbstractMemberMetaData	newTransientFieldObject(org.datanucleus.metadata.MetaData md, String name)	Utility to create a new transient field/property component.
void	startElement(String uri, String localName, String qName, Attributes attrs)	Handler method called at the start of an element.

Methods inherited from class org.datanucleus.metadata.xml.AbstractXmlMetaDataHandler

characters, error, getAttr, getAttr, getMetaData, getStack, getString, isPersistenceContext, popStack, pushStack, resolveEntity, setValidate

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, fatalError, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

JPAXmlMetaDataHandler

public JPAXmlMetaDataHandler(org.datanucleus.metadata.MetaDataManager mgr,
                             String filename,
                             EntityResolver resolver)

Constructor. Protected to prevent instantiation.

Parameters:

mgr - the metadata manager

filename - The name of the file to parse

resolver - Entity Resolver to use (null if not available)

Method Detail

newClassObject

protected org.datanucleus.metadata.ClassMetaData newClassObject(org.datanucleus.metadata.PackageMetaData pmd,
                                                                Attributes attrs,
                                                                boolean embeddedOnly)

Utility to create a new class component.

Parameters:

pmd - The parent PackageMetaData

attrs - The attributes

embeddedOnly - Whether this class is embedded-only

Returns:

The ClassMetaData

newFieldObject

protected org.datanucleus.metadata.AbstractMemberMetaData newFieldObject(org.datanucleus.metadata.AbstractClassMetaData acmd,
                                                                         Attributes attrs,
                                                                         String dfgDefault)

Utility to create a new field/property component and add it to the class as required. If the field/property already exists

Parameters:

acmd - The parent class MetaData

attrs - The attributes

dfgDefault - The default for DFG for this field if not specified

Returns:

The FieldMetaData/PropertyMetaData

newPKFieldObject

protected org.datanucleus.metadata.AbstractMemberMetaData newPKFieldObject(org.datanucleus.metadata.AbstractClassMetaData acmd,
                                                                           Attributes attrs)

Utility to create a new primary key field/property component.

Parameters:

acmd - The parent class MetaData

attrs - Attributes of the "id" element

Returns:

The FieldMetaData/PropertyMetaData

newTransientFieldObject

protected org.datanucleus.metadata.AbstractMemberMetaData newTransientFieldObject(org.datanucleus.metadata.MetaData md,
                                                                                  String name)

Utility to create a new transient field/property component.

Parameters:

md - The parent MetaData

name - Name of the transient field

Returns:

The FieldMetaData/PropertyMetaData

newEmbeddedFieldObject

protected org.datanucleus.metadata.AbstractMemberMetaData newEmbeddedFieldObject(org.datanucleus.metadata.MetaData md,
                                                                                 String name)

Utility to create a new embedded field/property component.

Parameters:

md - The parent MetaData

name - Name of the embedded field

Returns:

The FieldMetaData/PropertyMetaData

newOverriddenFieldObject

protected org.datanucleus.metadata.AbstractMemberMetaData newOverriddenFieldObject(org.datanucleus.metadata.MetaData md,
                                                                                   Attributes attrs)

Utility to create a new field entry for a field/property in a superclass.

Parameters:

md - The parent MetaData

attrs - Attributes of the element

Returns:

The FieldMetaData/PropertyMetaData

newOverriddenEmbeddedFieldObject

protected org.datanucleus.metadata.AbstractMemberMetaData newOverriddenEmbeddedFieldObject(org.datanucleus.metadata.EmbeddedMetaData embmd,
                                                                                           Attributes attrs)

Utility to create a new field entry for a field/property in a superclass.

Parameters:

embmd - The parent MetaData

attrs - Attributes of the "id" element

Returns:

The FieldMetaData/PropertyMetaData

newOverriddenEmbeddedFieldObject

protected org.datanucleus.metadata.AbstractMemberMetaData newOverriddenEmbeddedFieldObject(org.datanucleus.metadata.EmbeddedMetaData embmd,
                                                                                           String memberName,
                                                                                           String columnName)

Recursive method to process embedded member overrides.

Parameters:

embmd - The parent MetaData

memberName - The member name being overridden

columnName - Column name to override it with

Returns:

The FieldMetaData/PropertyMetaData

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes attrs)
                  throws SAXException

Handler method called at the start of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Parameters:

uri - URI of the tag

localName - Local name

qName - Element name

attrs - Attributes for this element

Throws:

SAXException - in parsing errors

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

Handler method called at the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Parameters:

uri - URI of the tag

localName - local name

qName - Name of element just ending

Throws:

SAXException - in parsing errors