BEA Systems, Inc.
WebLogic Server 8.1 API Reference

weblogic.apache.xerces.impl
Class XMLScanner

java.lang.Object
  |
  +--weblogic.apache.xerces.impl.XMLScanner
Direct Known Subclasses:
XMLDocumentFragmentScannerImpl, XMLDTDScannerImpl
public abstract class XMLScanner
extends java.lang.Object
implements XMLComponent

This class is responsible for holding scanning methods common to scanning the XML document structure and content as well as the DTD structure and content. Both XMLDocumentScanner and XMLDTDScanner inherit from this base class.

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

Field Summary
protected static boolean DEBUG_ATTR_NORMALIZATION
          Debug attribute normalization.
protected static java.lang.String ENTITY_MANAGER
          Property identifier: entity manager.
protected static java.lang.String ERROR_REPORTER
          Property identifier: error reporter.
protected static java.lang.String fAmpSymbol
          Symbol: "amp".
protected static java.lang.String fAposSymbol
          Symbol: "apos".
protected  java.lang.String fCharRefLiteral
          Literal value of the last character refence scanned.
protected static java.lang.String fEncodingSymbol
          Symbol: "encoding".
protected  int fEntityDepth
          Entity depth.
protected  XMLEntityManager fEntityManager
          Entity manager.
protected  XMLEntityScanner fEntityScanner
          Entity scanner.
protected  XMLErrorReporter fErrorReporter
          Error reporter.
protected static java.lang.String fGtSymbol
          Symbol: "gt".
protected static java.lang.String fLtSymbol
          Symbol: "lt".
protected  boolean fNotifyCharRefs
          Character references notification.
protected static java.lang.String fQuotSymbol
          Symbol: "quot".
protected  boolean fReportEntity
          Report entity boundary.
protected  XMLResourceIdentifierImpl fResourceIdentifier
           
protected  boolean fScanningAttribute
          Scanning attribute.
protected static java.lang.String fStandaloneSymbol
          Symbol: "standalone".
protected  SymbolTable fSymbolTable
          Symbol table.
protected  boolean fValidation
          Validation.
protected static java.lang.String fVersionSymbol
          Symbol: "version".
protected static java.lang.String NOTIFY_CHAR_REFS
          Feature identifier: notify character references.
protected static java.lang.String SYMBOL_TABLE
          Property identifier: symbol table.
protected static java.lang.String VALIDATION
          Feature identifier: validation.
 
Constructor Summary
XMLScanner()
           
 
Method Summary
 void endEntity(java.lang.String name)
          This method notifies the end of an entity.
 boolean getFeature(java.lang.String featureId)
           
protected  void normalizeWhitespace(XMLString value)
          Normalize whitespace in an XMLString converting all whitespace characters to space characters.
protected  void reportFatalError(java.lang.String msgId, java.lang.Object[] args)
          Convenience function used in all XML scanners.
protected  void reset()
           
 void reset(XMLComponentManager componentManager)
           
protected  void scanAttributeValue(XMLString value, XMLString nonNormalizedValue, java.lang.String atName, XMLAttributes attributes, int attrIndex, boolean checkEntities)
          Scans an attribute value and normalizes whitespace converting all whitespace characters to space characters.
protected  int scanCharReferenceValue(XMLStringBuffer buf, XMLStringBuffer buf2)
          Scans a character reference and append the corresponding chars to the specified buffer.
protected  void scanComment(XMLStringBuffer text)
          Scans a comment.
protected  void scanExternalID(java.lang.String[] identifiers, boolean optionalSystemId)
          Scans External ID and return the public and system IDs.
protected  void scanPI()
          Scans a processing instruction.
protected  void scanPIData(java.lang.String target, XMLString data)
          Scans a processing data.
 java.lang.String scanPseudoAttribute(boolean scanningTextDecl, XMLString value)
          Scans a pseudo attribute.
protected  boolean scanPubidLiteral(XMLString literal)
          Scans public ID literal.
protected  boolean scanSurrogates(XMLStringBuffer buf)
          Scans surrogates and append them to the specified buffer.
protected  void scanXMLDeclOrTextDecl(boolean scanningTextDecl, java.lang.String[] pseudoAttributeValues)
          Scans an XML or text declaration.
 void setFeature(java.lang.String featureId, boolean value)
           
 void setProperty(java.lang.String propertyId, java.lang.Object value)
          Sets the value of a property during parsing.
 void startEntity(java.lang.String name, XMLResourceIdentifier identifier, java.lang.String encoding)
          This method notifies of the start of an entity.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VALIDATION

protected static final java.lang.String VALIDATION
Feature identifier: validation.

NOTIFY_CHAR_REFS

protected static final java.lang.String NOTIFY_CHAR_REFS
Feature identifier: notify character references.

SYMBOL_TABLE

protected static final java.lang.String SYMBOL_TABLE
Property identifier: symbol table.

ERROR_REPORTER

protected static final java.lang.String ERROR_REPORTER
Property identifier: error reporter.

ENTITY_MANAGER

protected static final java.lang.String ENTITY_MANAGER
Property identifier: entity manager.

DEBUG_ATTR_NORMALIZATION

protected static final boolean DEBUG_ATTR_NORMALIZATION
Debug attribute normalization.

fValidation

protected boolean fValidation
Validation. This feature identifier is: http://xml.org/sax/features/validation

fNotifyCharRefs

protected boolean fNotifyCharRefs
Character references notification.

fSymbolTable

protected SymbolTable fSymbolTable
Symbol table.

fErrorReporter

protected XMLErrorReporter fErrorReporter
Error reporter.

fEntityManager

protected XMLEntityManager fEntityManager
Entity manager.

fEntityScanner

protected XMLEntityScanner fEntityScanner
Entity scanner.

fEntityDepth

protected int fEntityDepth
Entity depth.

fCharRefLiteral

protected java.lang.String fCharRefLiteral
Literal value of the last character refence scanned.

fScanningAttribute

protected boolean fScanningAttribute
Scanning attribute.

fReportEntity

protected boolean fReportEntity
Report entity boundary.

fVersionSymbol

protected static final java.lang.String fVersionSymbol
Symbol: "version".

fEncodingSymbol

protected static final java.lang.String fEncodingSymbol
Symbol: "encoding".

fStandaloneSymbol

protected static final java.lang.String fStandaloneSymbol
Symbol: "standalone".

fAmpSymbol

protected static final java.lang.String fAmpSymbol
Symbol: "amp".

fLtSymbol

protected static final java.lang.String fLtSymbol
Symbol: "lt".

fGtSymbol

protected static final java.lang.String fGtSymbol
Symbol: "gt".

fQuotSymbol

protected static final java.lang.String fQuotSymbol
Symbol: "quot".

fAposSymbol

protected static final java.lang.String fAposSymbol
Symbol: "apos".

fResourceIdentifier

protected XMLResourceIdentifierImpl fResourceIdentifier
Constructor Detail

XMLScanner

public XMLScanner()
Method Detail

reset

public void reset(XMLComponentManager componentManager)
           throws XMLConfigurationException
Specified by:
reset in interface XMLComponent

Parameters:
componentManager - The component manager.
Throws:
SAXException - Throws exception if required features and properties cannot be found.

setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.Object value)
                 throws XMLConfigurationException
Sets the value of a property during parsing.
Specified by:
setProperty in interface XMLComponent

Parameters:
propertyId -  
value -  

setFeature

public void setFeature(java.lang.String featureId,
                       boolean value)
                throws XMLConfigurationException
Specified by:
setFeature in interface XMLComponent

getFeature

public boolean getFeature(java.lang.String featureId)
                   throws XMLConfigurationException

reset

protected void reset()

scanXMLDeclOrTextDecl

protected void scanXMLDeclOrTextDecl(boolean scanningTextDecl,
                                     java.lang.String[] pseudoAttributeValues)
                              throws java.io.IOException,
                                     XNIException
Scans an XML or text declaration. 

 [23] XMLDecl ::= ''
 [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ")
 [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' |  "'" EncName "'" )
 [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*
 [32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'")
                 | ('"' ('yes' | 'no') '"'))

 [77] TextDecl ::= ''

Parameters:
scanningTextDecl - True if a text declaration is to be scanned instead of an XML declaration.
pseudoAttributeValues - An array of size 3 to return the version, encoding and standalone pseudo attribute values (in that order). Note: This method uses fString, anything in it at the time of calling is lost.

scanPseudoAttribute

public java.lang.String scanPseudoAttribute(boolean scanningTextDecl,
                                            XMLString value)
                                     throws java.io.IOException,
                                            XNIException
Scans a pseudo attribute.

Parameters:
scanningTextDecl - True if scanning this pseudo-attribute for a TextDecl; false if scanning XMLDecl. This flag is needed to report the correct type of error.
value - The string to fill in with the attribute value.
Returns:
The name of the attribute Note: This method uses fStringBuffer2, anything in it at the time of calling is lost.

scanPI

protected void scanPI()
               throws java.io.IOException,
                      XNIException
Scans a processing instruction. 

 [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
 [17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))
Note: This method uses fString, anything in it at the time of calling is lost.

scanPIData

protected void scanPIData(java.lang.String target,
                          XMLString data)
                   throws java.io.IOException,
                          XNIException
Scans a processing data. This is needed to handle the situation where a document starts with a processing instruction whose target name starts with "xml". (e.g. xmlfoo) Note: This method uses fStringBuffer, anything in it at the time of calling is lost.

Parameters:
target - The PI target
data - The string to fill in with the data

scanComment

protected void scanComment(XMLStringBuffer text)
                    throws java.io.IOException,
                           XNIException
Scans a comment. 

 [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

Note: Called after scanning past '<!--' Note: This method uses fString, anything in it at the time of calling is lost.

Parameters:
text - The buffer to fill in with the text.

scanAttributeValue

protected void scanAttributeValue(XMLString value,
                                  XMLString nonNormalizedValue,
                                  java.lang.String atName,
                                  XMLAttributes attributes,
                                  int attrIndex,
                                  boolean checkEntities)
                           throws java.io.IOException,
                                  XNIException
Scans an attribute value and normalizes whitespace converting all whitespace characters to space characters. [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'"

Parameters:
value - The XMLString to fill in with the value.
nonNormalizedValue - The XMLString to fill in with the non-normalized value.
atName - The name of the attribute being parsed (for error msgs).
attributes - The attributes list for the scanned attribute.
attrIndex - The index of the attribute to use from the list.
checkEntities - true if undeclared entities should be reported as VC violation, false if undeclared entities should be reported as WFC violation. Note: This method uses fStringBuffer2, anything in it at the time of calling is lost.

scanExternalID

protected void scanExternalID(java.lang.String[] identifiers,
                              boolean optionalSystemId)
                       throws java.io.IOException,
                              XNIException
Scans External ID and return the public and system IDs.

Parameters:
identifiers - An array of size 2 to return the system id, and public id (in that order).
optionalSystemId - Specifies whether the system id is optional. Note: This method uses fString and fStringBuffer, anything in them at the time of calling is lost.

scanPubidLiteral

protected boolean scanPubidLiteral(XMLString literal)
                            throws java.io.IOException,
                                   XNIException
Scans public ID literal. [12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'" [13] PubidChar::= #x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%] The returned string is normalized according to the following rule, from http://www.w3.org/TR/REC-xml#dt-pubid: Before a match is attempted, all strings of white space in the public identifier must be normalized to single space characters (#x20), and leading and trailing white space must be removed.

Parameters:
literal - The string to fill in with the public ID literal.

normalizeWhitespace

protected void normalizeWhitespace(XMLString value)
Normalize whitespace in an XMLString converting all whitespace characters to space characters.

startEntity

public void startEntity(java.lang.String name,
                        XMLResourceIdentifier identifier,
                        java.lang.String encoding)
                 throws XNIException
This method notifies of the start of an entity. The document entity has the pseudo-name of "[xml]" the DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entities are just specified by their name.

Parameters:
name - The name of the entity.
identifier - The resource identifier.
encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
Throws:
XNIException - Thrown by handler to signal an error.

endEntity

public void endEntity(java.lang.String name)
               throws XNIException
This method notifies the end of an entity. The document entity has the pseudo-name of "[xml]" the DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entities are just specified by their name.

Parameters:
name - The name of the entity.
Throws:
XNIException - Thrown by handler to signal an error.

scanCharReferenceValue

protected int scanCharReferenceValue(XMLStringBuffer buf,
                                     XMLStringBuffer buf2)
                              throws java.io.IOException,
                                     XNIException
Scans a character reference and append the corresponding chars to the specified buffer. 

 [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'
Note: This method uses fStringBuffer, anything in it at the time of calling is lost.

Parameters:
buf - the character buffer to append chars to
buf2 - the character buffer to append non-normalized chars to
Returns:
the character value or (-1) on conversion failure

scanSurrogates

protected boolean scanSurrogates(XMLStringBuffer buf)
                          throws java.io.IOException,
                                 XNIException
Scans surrogates and append them to the specified buffer.

Note: This assumes the current char has already been identified as a high surrogate.

Parameters:
buf - The StringBuffer to append the read surrogates to.

reportFatalError

protected void reportFatalError(java.lang.String msgId,
                                java.lang.Object[] args)
                         throws XNIException
Convenience function used in all XML scanners.

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs81