org.jpox.enhancer.metadata
Class EnhancerMetaDataParser

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      org.jpox.metadata.MetaDataParser
          org.jpox.enhancer.metadata.EnhancerMetaDataParser

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class EnhancerMetaDataParser
extends org.jpox.metadata.MetaDataParser

Parser for metadata used in the Enhancer. Overrides the default MetaDataParser by defining class and field components to use our versions.

Version:

$Revision: 1.7 $

Field Summary

protected static org.jpox.util.Localiser

LOCALISER_ENH Message Resource

Fields inherited from class org.jpox.metadata.MetaDataParser

latestElement, LOCALISER, metadata, stack

Constructor Summary

protected

EnhancerMetaDataParser(org.jpox.metadata.MetaDataManager mdm, java.lang.String filename) Constructor.

Method Summary

protected org.jpox.metadata.ClassMetaData	newClassObject(org.jpox.metadata.PackageMetaData pmd, org.xml.sax.Attributes attrs) Utility to create a new class component.
protected org.jpox.metadata.FieldMetaData	newFieldObject(org.jpox.metadata.MetaData md, org.xml.sax.Attributes attrs) Utility to create a new field component.
protected org.jpox.metadata.PropertyMetaData	newPropertyObject(org.jpox.metadata.MetaData md, org.xml.sax.Attributes attrs) Utility to create a new property component.
static org.jpox.metadata.FileMetaData	parseMetaData(java.net.URL url, boolean validate, org.jpox.metadata.MetaDataManager mdm) Method to parse a JDO MetaData file given the URL of the file.
static org.jpox.metadata.FileMetaData	parseMetaDataFile(java.lang.String fileName, boolean validate, org.jpox.metadata.MetaDataManager mdm) PMethod to parse a MetaData file given the filename.
static org.jpox.metadata.FileMetaData	parseMetaDataStream(java.io.InputStream in, boolean validate, org.jpox.metadata.MetaDataManager mdm, java.lang.String filename) PMethod to parse a MetaData file via an InputStream.

Methods inherited from class org.jpox.metadata.MetaDataParser

characters, endDocument, endElement, error, getAttr, getAttr, getMetaData, getStack, getString, popStack, pushStack, resolveEntity, startDocument, startElement

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

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

Methods inherited from class java.lang.Object

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

Field Detail

LOCALISER_ENH

protected static org.jpox.util.Localiser LOCALISER_ENH

Message Resource

Constructor Detail

EnhancerMetaDataParser

protected EnhancerMetaDataParser(org.jpox.metadata.MetaDataManager mdm,
                                 java.lang.String filename)

Constructor. Protected to prevent instantiation.

Parameters:

mdm - the metadata manager

filename - Name of the file (if applicable)

Method Detail

parseMetaData

public static org.jpox.metadata.FileMetaData parseMetaData(java.net.URL url,
                                                           boolean validate,
                                                           org.jpox.metadata.MetaDataManager mdm)

Method to parse a JDO MetaData file given the URL of the file.

Parameters:

url - Url of the file

validate - Whether to validate against the DTD as well

mdm - the metadata manager

Returns:

The MetaData for this file

Throws:

javax.jdo.JDOException - thrown if error occurred

parseMetaDataFile

public static org.jpox.metadata.FileMetaData parseMetaDataFile(java.lang.String fileName,
                                                               boolean validate,
                                                               org.jpox.metadata.MetaDataManager mdm)

PMethod to parse a MetaData file given the filename.

Parameters:

fileName - Name of the file

validate - Whether to validate the MetaData

mdm - the metadata manager

Throws:

javax.jdo.JDOException - if error occored

parseMetaDataStream

public static org.jpox.metadata.FileMetaData parseMetaDataStream(java.io.InputStream in,
                                                                 boolean validate,
                                                                 org.jpox.metadata.MetaDataManager mdm,
                                                                 java.lang.String filename)

PMethod to parse a MetaData file via an InputStream.

Parameters:

in - read stream

validate - Whether to validate the metadata

mdm - the metadata manager

filename - Name of the file (if known)

Returns:

new FileMetaData object

Throws:

java.lang.RuntimeException - if error occored

newClassObject

protected org.jpox.metadata.ClassMetaData newClassObject(org.jpox.metadata.PackageMetaData pmd,
                                                         org.xml.sax.Attributes attrs)

Utility to create a new class component. Overrides the method in MetaDataParser since we want to create a EnhancerClassMetaData and want to register it.

Overrides:

newClassObject in class org.jpox.metadata.MetaDataParser

Parameters:

pmd - The parent PackageMetaData

attrs - The attributes

Returns:

The ClassMetaData

newPropertyObject

protected org.jpox.metadata.PropertyMetaData newPropertyObject(org.jpox.metadata.MetaData md,
                                                               org.xml.sax.Attributes attrs)

Utility to create a new property component.

Overrides:

newPropertyObject in class org.jpox.metadata.MetaDataParser

Parameters:

md - The parent MetaData

attrs - The attributes

Returns:

The PropertyMetaData

newFieldObject

protected org.jpox.metadata.FieldMetaData newFieldObject(org.jpox.metadata.MetaData md,
                                                         org.xml.sax.Attributes attrs)

Utility to create a new field component. Overrides the method in MetaDataParser since we want to create a EnhancerFieldMetaData.

Overrides:

newFieldObject in class org.jpox.metadata.MetaDataParser

Parameters:

md - The parent MetaData

attrs - The attributes

Returns:

The FieldMetaData