The scanner acts as the source for the document information which is communicated to the document handler. 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.

Note

This scanner should only be used when the namespace processing is on!

This component requires the following features and properties from the component manager that uses it:

http://xml.org/sax/features/namespaces {true} -- if the value of this feature is set to false this scanner must not be used.
http://xml.org/sax/features/validation
http://apache.org/xml/features/nonvalidating/load-external-dtd
http://apache.org/xml/features/scanner/notify-char-refs
http://apache.org/xml/features/scanner/notify-builtin-refs
http://apache.org/xml/properties/internal/symbol-table
http://apache.org/xml/properties/internal/error-reporter
http://apache.org/xml/properties/internal/entity-manager
http://apache.org/xml/properties/internal/dtd-scanner

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	XML11NSDocumentScannerImpl.NS11ContentDispatcher Dispatcher to handle content scanning.

Field Summary

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
private XMLDTDValidatorFilter	fDTDValidator DTD validator
protected boolean	fPerformValidation If validating parser, make sure we report an error in the scanner if DTD grammar is missing.
private boolean	fSawSpace Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.fSawSpace. Saw spaces after element name or between attributes.

Constructor Summary

Access	Constructor and Description
public	XML11NSDocumentScannerImpl()

Method Summary

Modifier and Type	Method and Description
protected XMLDocumentFragmentScannerImpl.Dispatcher	createContentDispatcher() Overrides org.apache.xerces.impl.XMLDocumentScannerImpl.createContentDispatcher. Creates a content dispatcher.
public void	reset(XMLComponentManager The component manager. componentManager) Overrides org.apache.xerces.impl.XMLDocumentScannerImpl.reset. Implements org.apache.xerces.xni.parser.XMLComponent.reset. Resets the component.
protected void	scanAttribute(XMLAttributesImpl The attributes list for the scanned attribute. attributes) Scans an attribute.
protected int	Returns: The element depth. scanEndElement() Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanEndElement. Scans an end element.
protected boolean	Returns: True if element is empty. (i.e. It matches production [44]. scanStartElement() Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanStartElement. Scans a start element.
protected boolean	Returns: True if element is empty. scanStartElementAfterName() Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanStartElementAfterName. Scans the remainder of a start or empty tag after the element name.
protected void	scanStartElementName() Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanStartElementName. Scans the name of an element in a start or empty tag.
public void	setDTDValidator(XMLDTDValidatorFilter the DTD validator from the pipeline validator) The scanner is responsible for removing DTD validator from the pipeline if it is not needed.

Inherited from org.apache.xerces.impl.XML11DocumentScannerImpl:: getVersionNotSupportedKey isInvalid isInvalidLiteral isUnchangedByNormalization isValidNameChar isValidNameStartChar isValidNameStartHighSurrogate isValidNCName normalizeWhitespace normalizeWhitespace scanAttributeValue scanContent scanPubidLiteral versionSupported

Field Detail

fBindNamespaces	back to summary
protected boolean fBindNamespaces If is true, the dtd validator is no longer in the pipeline and the scanner should bind namespaces

fDTDValidator	back to summary
private XMLDTDValidatorFilter fDTDValidator DTD validator

fPerformValidation	back to summary
protected boolean fPerformValidation If validating parser, make sure we report an error in the scanner if DTD grammar is missing.

fSawSpace	back to summary
private boolean fSawSpace Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.fSawSpace. Saw spaces after element name or between attributes. This is reserved for the case where scanning of a start element spans several methods, as is the case when scanning the start of a root element where a DTD external subset may be read after scanning the element name.

fSawSpace

back to summary

private boolean fSawSpace

Hides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.fSawSpace.

Saw spaces after element name or between attributes. This is reserved for the case where scanning of a start element spans several methods, as is the case when scanning the start of a root element where a DTD external subset may be read after scanning the element name.

Constructor Detail

XML11NSDocumentScannerImpl	back to summary
public XML11NSDocumentScannerImpl()

Method Detail

createContentDispatcher	back to summary
protected XMLDocumentFragmentScannerImpl.Dispatcher createContentDispatcher() Overrides org.apache.xerces.impl.XMLDocumentScannerImpl.createContentDispatcher. Creates a content dispatcher.

createContentDispatcher

back to summary

protected XMLDocumentFragmentScannerImpl.Dispatcher createContentDispatcher()

Overrides org.apache.xerces.impl.XMLDocumentScannerImpl.createContentDispatcher.

Creates a content dispatcher.

reset	back to summary
public void reset(XMLComponentManager componentManager) throws XMLConfigurationException Overrides org.apache.xerces.impl.XMLDocumentScannerImpl.reset. Implements org.apache.xerces.xni.parser.XMLComponent.reset. Doc from org.apache.xerces.impl.XMLDocumentScannerImpl.reset. Resets the component. The component can query the component manager about any features and properties that affect the operation of the component. Parameters componentManager:XMLComponentManager The component manager.

reset

back to summary

public void reset(XMLComponentManager componentManager) throws XMLConfigurationException

Overrides org.apache.xerces.impl.XMLDocumentScannerImpl.reset.

Implements org.apache.xerces.xni.parser.XMLComponent.reset.

Doc from org.apache.xerces.impl.XMLDocumentScannerImpl.reset.

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

Parameters

componentManager:XMLComponentManager: The component manager.

scanAttribute	back to summary
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:XMLAttributesImpl The attributes list for the scanned attribute.

scanAttribute

back to summary

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:XMLAttributesImpl: The attributes list for the scanned attribute.

scanEndElement	back to summary
protected int scanEndElement() throws IOException, XNIException Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanEndElement. Scans an end element. [42] ETag ::= '</' Name S? '>' Note This method uses the fElementQName variable. The contents of this variable will be destroyed. The caller should copy the needed information out of this variable before calling this method. Returns:int The element depth.

scanEndElement

back to summary

protected int scanEndElement() throws IOException, XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanEndElement.

Scans an end element.

[42] ETag ::= '</' Name S? '>'

Note

This method uses the fElementQName variable. The contents of this variable will be destroyed. The caller should copy the needed information out of this variable before calling this method.

Returns:int: The element depth.

scanStartElement	back to summary
protected boolean scanStartElement() throws IOException, XNIException Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanStartElement. 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. Returns:boolean True if element is empty. (i.e. It matches production [44].

scanStartElement

back to summary

protected boolean scanStartElement() throws IOException, XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanStartElement.

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.

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

scanStartElementAfterName back to summary

scanStartElementAfterName	back to summary
protected boolean scanStartElementAfterName() throws IOException, XNIException Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanStartElementAfterName. Scans the remainder of a start or empty tag after the element name. Returns:boolean True if element is empty. See Also `scanStartElement`

protected boolean scanStartElementAfterName() throws IOException, XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanStartElementAfterName.

Scans the remainder of a start or empty tag after the element name.

Returns:boolean: True if element is empty.
See Also: scanStartElement

scanStartElementName back to summary

scanStartElementName	back to summary
protected void scanStartElementName() throws IOException, XNIException Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanStartElementName. Scans the name of an element in a start or empty tag. See Also `scanStartElement()`

protected void scanStartElementName() throws IOException, XNIException

Overrides org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanStartElementName.

Scans the name of an element in a start or empty tag.

See Also: scanStartElement()

setDTDValidator	back to summary
public void setDTDValidator(XMLDTDValidatorFilter validator) The scanner is responsible for removing DTD validator from the pipeline if it is not needed. Parameters validator:XMLDTDValidatorFilter the DTD validator from the pipeline

setDTDValidator

back to summary

public void setDTDValidator(XMLDTDValidatorFilter validator)

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

Parameters

validator:XMLDTDValidatorFilter: the DTD validator from the pipeline

org.apache.xerces.impl back to summary

protected final Class XML11NSDocumentScannerImpl.NS11ContentDispatcher

Class Inheritance

extends ContentDispatcher

java.lang.Object
org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.FragmentContentDispatcher
org.apache.xerces.impl.XMLDocumentScannerImpl.ContentDispatcher
org.apache.xerces.impl.XML11NSDocumentScannerImpl.NS11ContentDispatcher

Dispatcher to handle content scanning.

Constructor Summary

Access	Constructor and Description
protected	NS11ContentDispatcher()

Method Summary

Modifier and Type	Method and Description
private void	reconfigurePipeline() Re-configures pipeline by removing the DTD validator if no DTD grammar exists.
protected boolean	Returns: True if the caller should stop and return true which allows the scanner to switch to a new scanning dispatcher. A return value of false indicates that the content dispatcher should continue as normal. scanRootElementHook() Overrides org.apache.xerces.impl.XMLDocumentScannerImpl.ContentDispatcher.scanRootElementHook. Scan for root element hook.

Inherited from org.apache.xerces.impl.XMLDocumentScannerImpl.ContentDispatcher:: elementDepthIsZeroHook endOfFileHook resolveExternalSubsetAndRead scanForDoctypeHook

Constructor Detail

NS11ContentDispatcher	back to summary
protected NS11ContentDispatcher()

Method Detail

reconfigurePipeline	back to summary
private void reconfigurePipeline() Re-configures pipeline by removing the DTD validator if no DTD grammar exists. If no validator exists in the pipeline or there is no DTD grammar, namespace binding is performed by the scanner in the enclosing class.

scanRootElementHook	back to summary
protected boolean scanRootElementHook() throws IOException, XNIException Overrides org.apache.xerces.impl.XMLDocumentScannerImpl.ContentDispatcher.scanRootElementHook. Scan for root element hook. This method is a hook for subclasses to add code that handles scanning for the root element. This method will also attempt to remove DTD validator from the pipeline, if there is no DTD grammar. If DTD validator is no longer in the pipeline bind namespaces in the scanner. Returns:boolean True if the caller should stop and return true which allows the scanner to switch to a new scanning dispatcher. A return value of false indicates that the content dispatcher should continue as normal.

scanRootElementHook

back to summary

protected boolean scanRootElementHook() throws IOException, XNIException

Overrides org.apache.xerces.impl.XMLDocumentScannerImpl.ContentDispatcher.scanRootElementHook.

Scan for root element hook. This method is a hook for subclasses to add code that handles scanning for the root element. This method will also attempt to remove DTD validator from the pipeline, if there is no DTD grammar. If DTD validator is no longer in the pipeline bind namespaces in the scanner.

Returns:boolean: True if the caller should stop and return true which allows the scanner to switch to a new scanning dispatcher. A return value of false indicates that the content dispatcher should continue as normal.

public Class XML11NSDocumentScannerImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected final Class XML11NSDocumentScannerImpl.NS11ContentDispatcher

Constructor Summary

Method Summary

Constructor Detail

Method Detail