Package com.sun.tools.xjc.reader.xmlschema.parser

Class CustomizationContextChecker

java.lang.Object

org.xml.sax.helpers.XMLFilterImpl

com.sun.tools.xjc.reader.xmlschema.parser.CustomizationContextChecker

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, XMLFilter, XMLReader

public class CustomizationContextChecker
extends XMLFilterImpl

Checks if binding declarations are placed where they are allowed.

For example, if a <jaxb:property> customization is given under the <xs:simpleContent> element, this class raises an error.

our main checkpoint of misplaced customizations are in BGMBuilder. There, we mark a customization whenever we use it. At the end of the day, we look for unmarked customizations and raise errors for them.

Between this approach and the JAXB spec 1.0 is a problem that the spec allows/prohibits customizations at schema element level, while BGMBuilder and XSOM works on schema component levels.

For example, a property customization is allowed on a complex type schema component, but it's only allowed on the <complexType> element. The spec team informed us that they would consider resolving this discrepancy in favor of RI, but meanwhile we need to detect errors correctly.

This filter is implemented for this purpose.

Customization and allowed locations

- globalBinding/schemaBinding schema - class complexType(*), modelGroupDecl, modelGroup, element - property attribute, element, any, modelGroup, modelGroupRef, complexType(*) - javaType simpleType(*) - typesafeEnumClass simpleType(*) - typesafeEnumMember simpleType(*), enumeration Components marked with '*' needs a check by this component since more than one schema element corresponds to one schema component of that type.

For simple types, customizations are allowed only under the <xs:simpleType> element, and for complex types they are allowed only under the <xs:cimplexType> element.

So the bottom line is that it would be suffice if we just make sure that no customization will be attached under other elements of simple types and complex types. Those are: - simpleType/restriction - list - union - complexType/(simple or complex)Content - complexType/(simple or complex)Content/(restriction of extension)

Author:

Kohsuke Kawaguchi ([email protected])

Constructor Summary

Constructors

Constructor	Description
CustomizationContextChecker(ErrorHandler _errorHandler)

Method Summary

Modifier and Type	Method	Description
void	endElement(String namespaceURI, String localName, String qName)
void	setDocumentLocator(Locator locator)
void	startElement(String namespaceURI, String localName, String qName, Attributes atts)

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

characters, endDocument, endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, ignorableWhitespace, notationDecl, parse, parse, processingInstruction, resolveEntity, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setParent, setProperty, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Details

CustomizationContextChecker

public CustomizationContextChecker(ErrorHandler _errorHandler)

Parameters:

_errorHandler - Detected errors will be sent to this object.

Method Details

startElement

public void startElement(String namespaceURI,
 String localName,
 String qName,
 Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class XMLFilterImpl

Throws:

SAXException

endElement

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

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class XMLFilterImpl

Throws:

SAXException

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class XMLFilterImpl