Package org.datanucleus.metadata.xml
Class AbstractXmlMetaDataHandler
java.lang.Object
org.xml.sax.helpers.DefaultHandler
org.datanucleus.metadata.xml.AbstractXmlMetaDataHandler
- All Implemented Interfaces:
ContentHandler
,DTDHandler
,EntityResolver
,ErrorHandler
- Direct Known Subclasses:
PersistenceXmlMetaDataHandler
Abstract handler for XML MetaData parsing.
This class is extended to handle processing of specific types of metadata.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringBuilder
parser bufferprotected ClassLoaderResolver
protected final EntityResolver
Entity Resolver to use (if required)protected final String
Filename containing the XML metadataprotected MetaData
The MetaData for this file (the end result of the parse process).protected final MetaDataManager
Manager for the MetaData.Stack of meta-data elements.protected boolean
Whether to validate while parsing. -
Constructor Summary
ConstructorsConstructorDescriptionAbstractXmlMetaDataHandler
(MetaDataManager mmgr, String filename, EntityResolver resolver) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(char[] ch, int start, int length) Notification handler for the "body" data inside an element.void
Parser error method.protected String
getAttr
(Attributes attrs, String key) Accessor for an attribute out of the attributes for an element.protected String
getAttr
(Attributes attrs, String key, String defaultValue) Accessor for an attribute out of the attributes for an element.Accessor for the MetaData for this file.protected MetaData
getStack()
Accessor for the current MetaData component.Accessor for the "body" text metadata.boolean
protected MetaData
popStack()
Method to remove the current MetaData component from the Stack.protected void
Method to add a MetaData component to the Stack.resolveEntity
(String publicId, String systemId) Method to resolve XML entities.void
setValidate
(boolean validate) Method to set whether to validate during the the handling.Methods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endElement, endPrefixMapping, fatalError, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning
-
Field Details
-
mmgr
Manager for the MetaData. -
clr
-
filename
Filename containing the XML metadata -
metadata
The MetaData for this file (the end result of the parse process). -
entityResolver
Entity Resolver to use (if required) -
charactersBuffer
parser buffer -
validate
protected boolean validateWhether to validate while parsing. -
stack
Stack of meta-data elements. The top of the stack is always the element being process at the moment. The elements are not the XML Element type but are things like ClassMetaData, PackageMetaData etc.
-
-
Constructor Details
-
AbstractXmlMetaDataHandler
Constructor.- Parameters:
mmgr
- Manager for the MetaDatafilename
- The filenameresolver
- Entity Resolver to use (null if not available)
-
-
Method Details
-
isPersistenceContext
public boolean isPersistenceContext() -
setValidate
public void setValidate(boolean validate) Method to set whether to validate during the the handling.- Parameters:
validate
- Whether to validate
-
getMetaData
Accessor for the MetaData for this file.- Returns:
- The MetaData.
-
error
Parser error method. If any syntactical errors are encountered on validation they will appear here and be logged as warnings. Just points the user to the line/column of their Meta-Data file for now.- Specified by:
error
in interfaceErrorHandler
- Overrides:
error
in classDefaultHandler
- Parameters:
e
- Parse Exception- Throws:
SAXException
- See Also:
-
getAttr
Accessor for an attribute out of the attributes for an element. Allows the specification of a default if no value is provided.- Parameters:
attrs
- The attributeskey
- Key for the attribute to returndefaultValue
- A default to impose if no value.- Returns:
- Value for the attribute with the specified key.
-
getAttr
Accessor for an attribute out of the attributes for an element.- Parameters:
attrs
- The attributeskey
- Key for the attribute to return- Returns:
- Value for the attribute with the specified key.
-
resolveEntity
Method to resolve XML entities. Uses the entity resolver (if provided) to check for local variants.- Specified by:
resolveEntity
in interfaceEntityResolver
- Overrides:
resolveEntity
in classDefaultHandler
- Parameters:
publicId
- The public id.systemId
- The system id.- Returns:
- Input Source for the URI.
- Throws:
SAXException
- See Also:
-
characters
Notification handler for the "body" data inside an element.- Specified by:
characters
in interfaceContentHandler
- Overrides:
characters
in classDefaultHandler
- Parameters:
ch
- The charactersstart
- The start position in the character array.length
- The length of the string.- Throws:
SAXException
- in parsing errors
-
getString
Accessor for the "body" text metadata. Resets the body text after access.- Returns:
- the string form of this metadata
-
getStack
Accessor for the current MetaData component.- Returns:
- The current MetaData component.
-
popStack
Method to remove the current MetaData component from the Stack.- Returns:
- Latest MetaData component.
-
pushStack
Method to add a MetaData component to the Stack.- Parameters:
md
- The component to add.
-