jdk7u.jaxp.org.apache.xerces.external.impl

Class XMLNSDocumentScannerImpl

java.lang.Object

jdk7u.jaxp.org.apache.xerces.external.impl.XMLScanner

jdk7u.jaxp.org.apache.xerces.external.impl.XMLDocumentFragmentScannerImpl

jdk7u.jaxp.org.apache.xerces.external.impl.XMLDocumentScannerImpl

jdk7u.jaxp.org.apache.xerces.external.impl.XMLNSDocumentScannerImpl

All Implemented Interfaces:

XMLEntityHandler, XMLComponent, XMLDocumentScanner, XMLDocumentSource, XMLBufferListener

public class XMLNSDocumentScannerImpl
extends XMLDocumentScannerImpl

This class adds the functionality of namespace processing. This class has been modified as per the new design which is more suited to efficiently build pull parser. Lot of improvements have been done and the code has been added to support stax functionality/features. This class scans an XML document, checks if document has a DTD, and if DTD is not found the scanner will remove the DTD Validator from the pipeline and perform namespace binding.

Version:

$Id: XMLNSDocumentScannerImpl.java,v 1.11 2010-11-01 04:39:41 joehw Exp $

Author:

Neeraj Bajaj, Sun Microsystems, Venugopal Rao K, Sun Microsystems, Elena Litani, IBM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XMLNSDocumentScannerImpl.NSContentDriver Driver to handle content scanning.

Nested classes/interfaces inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLDocumentScannerImpl

XMLDocumentScannerImpl.ContentDriver, XMLDocumentScannerImpl.DTDDriver, XMLDocumentScannerImpl.PrologDriver, XMLDocumentScannerImpl.TrailingMiscDriver, XMLDocumentScannerImpl.XMLDeclDriver

Nested classes/interfaces inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLDocumentFragmentScannerImpl

XMLDocumentFragmentScannerImpl.Driver, XMLDocumentFragmentScannerImpl.Element, XMLDocumentFragmentScannerImpl.ElementStack, XMLDocumentFragmentScannerImpl.ElementStack2, XMLDocumentFragmentScannerImpl.FragmentContentDriver

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	fBindNamespaces If is true, the dtd validator is no longer in the pipeline and the scanner should bind namespaces
protected boolean	fNotAddNSDeclAsAttribute Default value of this feature is false, when in Stax mode this should be true
protected boolean	fPerformValidation If validating parser, make sure we report an error in the scanner if DTD grammar is missing.

Fields inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLDocumentScannerImpl

DISALLOW_DOCTYPE_DECL_FEATURE, DOCUMENT_SCANNER, DTD_SCANNER, fAddedListener, fDoctypeName, fDoctypePublicId, fDoctypeSystemId, fDTDDecl, fDTDDriver, fDTDScanner, fEndPos, fLoadExternalDTD, fNamespaceContext, fPrologDriver, fReadingDTD, fScanEndElement, fSeenDoctypeDecl, fSeenInternalSubset, fStartPos, fTrailingMiscDriver, fValidationManager, fXMLDeclDriver, LOAD_EXTERNAL_DTD, NAMESPACE_CONTEXT, SCANNER_STATE_DTD_EXTERNAL, SCANNER_STATE_DTD_EXTERNAL_DECLS, SCANNER_STATE_DTD_INTERNAL_DECLS, SCANNER_STATE_NO_SUCH_ELEMENT_EXCEPTION, SCANNER_STATE_PROLOG, SCANNER_STATE_TRAILING_MISC, SCANNER_STATE_XML_DECL, VALIDATION_MANAGER

Fields inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLDocumentFragmentScannerImpl

DEBUG, DEBUG_COALESCE, DEBUG_NEXT, DEBUG_START_END_ELEMENT, dtdGrammarUtil, ENTITY_RESOLVER, fAccessExternalDTD, fAdd, fAddDefaultAttr, fAttributeQName, fAttributes, fContentBuffer, fContentDriver, fCurrentElement, fDeclaredEncoding, fDisallowDoctype, fDocumentHandler, fDriver, fElementAttributeLimit, fElementQName, fElementRawname, fElementStack, fElementStack2, fEmptyElement, fEntityStack, fEntityStore, fExternalSubsetResolver, fHasExternalDTD, fInScanContent, fIsCoalesce, fLastSectionWasCData, fLastSectionWasCharacterData, fLastSectionWasEntityReference, fMarkupDepth, fNotifyBuiltInRefs, foundBuiltInRefs, fPIData, fPITarget, fReadingAttributes, fReplaceEntityReferences, fReportCdataEvent, fScannerLastState, fScannerState, fScanToEnd, fShouldSkip, fSkip, fStandalone, fStandaloneSet, fStrictURI, fStringBuffer, fStringBuffer2, fSupportDTD, fSupportExternalEntities, fTempString, fTempString2, fUsebuffer, fVersion, NOTIFY_BUILTIN_REFS, SCANNER_STATE_ATTRIBUTE, SCANNER_STATE_ATTRIBUTE_VALUE, SCANNER_STATE_BUILT_IN_REFS, SCANNER_STATE_CDATA, SCANNER_STATE_CHAR_REFERENCE, SCANNER_STATE_CHARACTER_DATA, SCANNER_STATE_COMMENT, SCANNER_STATE_CONTENT, SCANNER_STATE_DOCTYPE, SCANNER_STATE_END_ELEMENT_TAG, SCANNER_STATE_END_OF_INPUT, SCANNER_STATE_PI, SCANNER_STATE_REFERENCE, SCANNER_STATE_ROOT_ELEMENT, SCANNER_STATE_START_ELEMENT_TAG, SCANNER_STATE_START_OF_MARKUP, SCANNER_STATE_TERMINATED, SCANNER_STATE_TEXT_DECL, STANDARD_URI_CONFORMANT

Fields inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLScanner

attributeValueCache, DEBUG_ATTR_NORMALIZATION, ENTITY_MANAGER, ERROR_REPORTER, fAmpSymbol, fAposSymbol, fAttributeCacheInitDone, fAttributeCacheUsedCount, fCharRefLiteral, fEncodingSymbol, fEntityDepth, fEntityManager, fEntityScanner, fErrorReporter, fEvent, fGtSymbol, fLimitAnalyzer, fLtSymbol, fNamespaces, fNotifyCharRefs, fParserSettings, fPropertyManager, fQuotSymbol, fReportEntity, fResourceIdentifier, fScanningAttribute, fSecurityManager, fStandaloneSymbol, fStringBufferIndex, fSymbolTable, fValidation, fVersionSymbol, NAMESPACES, NOTIFY_CHAR_REFS, PARSER_SETTINGS, stringBufferCache, SYMBOL_TABLE, VALIDATION

Constructor Summary

Constructors

Constructor and Description
XMLNSDocumentScannerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected XMLDocumentFragmentScannerImpl.Driver	createContentDriver() Creates a content driver.
int	next() return the next state on the input
void	reset(PropertyManager propertyManager) Resets the fields of this scanner.
void	reset(XMLComponentManager componentManager) Resets the component.
protected void	scanAttribute(XMLAttributesImpl attributes) Scans an attribute.
protected boolean	scanStartElement() Scans a start element.
void	setDTDValidator(XMLDTDValidatorFilter dtd) The scanner is responsible for removing DTD validator from the pipeline if it is not needed.

Methods inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLDocumentScannerImpl

endEntity, getCharacterEncodingScheme, getDTDDecl, getFeatureDefault, getNamespaceContext, getPropertyDefault, getRecognizedFeatures, getRecognizedProperties, getScannerStateName, getScannetState, refresh, scanDoctypeDecl, setEndDTDScanState, setFeature, setInputSource, setProperty, startEntity

Methods inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLDocumentFragmentScannerImpl

getAttributeIterator, getCharacterData, getComment, getDocumentHandler, getDriverName, getElementQName, getEntityName, getPIData, getPITarget, getString, hasAttributes, isStandAlone, refresh, scanAttribute, scanCDATASection, scanCharReference, scanComment, scanContent, scanDocument, scanEndElement, scanEntityReference, scanPIData, scanXMLDeclOrTextDecl, seekCloseOfStartTag, setDocumentHandler, setDriver, setScannerState, skipElement, standaloneSet

Methods inherited from class jdk7u.jaxp.org.apache.xerces.external.impl.XMLScanner

getFeature, isInvalid, isInvalidLiteral, isValidNameChar, isValidNameStartChar, isValidNCName, normalizeWhitespace, reportFatalError, reset, scanAttributeValue, scanCharReferenceValue, scanComment, scanExternalID, scanPI, scanPseudoAttribute, scanPubidLiteral, scanSurrogates, scanXMLDeclOrTextDecl, setPropertyManager, versionSupported

Methods inherited from class java.lang.Object

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

Field Detail

fBindNamespaces

protected boolean fBindNamespaces

If is true, the dtd validator is no longer in the pipeline and the scanner should bind namespaces

fPerformValidation

protected boolean fPerformValidation

If validating parser, make sure we report an error in the scanner if DTD grammar is missing.

fNotAddNSDeclAsAttribute

protected boolean fNotAddNSDeclAsAttribute

Default value of this feature is false, when in Stax mode this should be true

Constructor Detail

XMLNSDocumentScannerImpl

public XMLNSDocumentScannerImpl()

Method Detail

reset

public void reset(PropertyManager propertyManager)

Resets the fields of this scanner.

Overrides:

reset in class XMLDocumentScannerImpl

reset

public void reset(XMLComponentManager componentManager)
           throws XMLConfigurationException

Description copied from class: XMLDocumentScannerImpl

Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.

Specified by:

reset in interface XMLComponent

Overrides:

reset in class XMLDocumentScannerImpl

Parameters:

componentManager - The component manager.

Throws:

XMLConfigurationException

next

public int next()
         throws IOException,
                XNIException

return the next state on the input

Specified by:

next in interface XMLDocumentScanner

Overrides:

next in class XMLDocumentScannerImpl

Returns:

int

Throws:

IOException

XNIException

setDTDValidator

public void setDTDValidator(XMLDTDValidatorFilter dtd)

The scanner is responsible for removing DTD validator from the pipeline if it is not needed.

Parameters:

previous - The filter component before DTDValidator

dtdValidator - The DTDValidator

next - The documentHandler after the DTDValidator

scanStartElement

protected boolean scanStartElement()
                            throws IOException,
                                   XNIException

Scans a start element. This method will handle the binding of namespace information and notifying the handler of the start of the element.

 [44] EmptyElemTag ::= '<' Name (S Attribute)* S? '/>'
 [40] STag ::= '<' Name (S Attribute)* S? '>'
 

Note: This method assumes that the leading '<' character has been consumed.

Note: This method uses the fElementQName and fAttributes variables. The contents of these variables will be destroyed. The caller should copy important information out of these variables before calling this method.

Overrides:

scanStartElement in class XMLDocumentFragmentScannerImpl

Returns:

True if element is empty. (i.e. It matches production [44].

Throws:

IOException

XNIException

scanAttribute

protected void scanAttribute(XMLAttributesImpl attributes)
                      throws IOException,
                             XNIException

Scans an attribute.

 [41] Attribute ::= Name Eq AttValue
 

Note: This method assumes that the next character on the stream is the first character of the attribute name.

Note: This method uses the fAttributeQName and fQName variables. The contents of these variables will be destroyed.

Parameters:

attributes - The attributes list for the scanned attribute.

Throws:

IOException

XNIException

createContentDriver

protected XMLDocumentFragmentScannerImpl.Driver createContentDriver()

Creates a content driver.

Overrides:

createContentDriver in class XMLDocumentScannerImpl