XML for Java EA2

com.ibm.xml.framework
Class XMLDTDScanner

java.lang.Object
  |
  +--com.ibm.xml.framework.XMLDTDScanner

public abstract class XMLDTDScanner
extends java.lang.Object
implements XMLScanner

Default implementation of an XML scanner.

Version:
Revision: %M% %I% %W% %Q%

Field Summary
protected  com.ibm.xml.readers.XMLDTDEntityHandler fEntityHandler
           
protected  com.ibm.xml.readers.XMLEntityHandler.EntityReader fEntityReader
           
protected  XMLErrorReporter fErrorReporter
           
protected  int fExternalSubsetReader
           
protected  int fReaderId
           
protected  com.ibm.xml.utils.StringPool fStringPool
           
protected static int SCANNER_STATE_COMMENT
           
protected static int SCANNER_STATE_CONTENTSPEC
           
protected static int SCANNER_STATE_DEFAULT_ATTRIBUTE_VALUE
           
protected static int SCANNER_STATE_DOCTYPEDECL
           
protected static int SCANNER_STATE_ENTITY_VALUE
           
protected static int SCANNER_STATE_MARKUP_DECL
           
protected static int SCANNER_STATE_PI
           
protected static int SCANNER_STATE_PUBIDLITERAL
           
protected static int SCANNER_STATE_SYSTEMLITERAL
           
protected static int SCANNER_STATE_TEXTDECL
           
protected static int SCANNER_STATE_UNKNOWN
           
 
Constructor Summary
XMLDTDScanner(com.ibm.xml.utils.StringPool stringPool, XMLErrorReporter errorReporter, com.ibm.xml.readers.XMLDTDEntityHandler entityHandler)
           
 
Method Summary
protected  void abortMarkup(int majorCode, int minorCode)
           
protected  void abortMarkup(int majorCode, int minorCode, int stringIndex1)
           
protected  void abortMarkup(int majorCode, int minorCode, int stringIndex1, int stringIndex2)
           
protected  void abortMarkup(int majorCode, int minorCode, java.lang.String string1)
           
protected abstract  int addAttDef(int elementIndex, int attName, int attType, int enumeration, int attDefaultType, int attDefaultValue)
           
protected abstract  int addContentSpecNode(int nodeType, int nodeValue)
           
protected abstract  int addContentSpecNode(int nodeType, int leftNodeIndex, int rightNodeIndex)
           
protected abstract  int addElementDecl(int elementTypeIndex)
           
protected abstract  int addElementDecl(int elementTypeIndex, int contentSpecType, int contentSpec)
           
protected abstract  int addExternalEntityDecl(int name, int publicId, int systemId)
           
protected abstract  int addExternalPEDecl(int name, int publicId, int systemId)
           
protected abstract  int addInternalEntityDecl(int name, int value, int location)
           
protected abstract  int addInternalPEDecl(int name, int value, int location)
           
protected abstract  void addNameToEnumeration(int enumIndex, int elementType, int attrName, int nameIndex, boolean isNotationType)
           
protected abstract  int addNotationDecl(int notationName, int publicId, int systemId)
           
protected abstract  int addUniqueLeafNode(int nameIndex)
           
protected abstract  int addUnparsedEntityDecl(int name, int publicId, int systemId, int notationName)
           
protected abstract  void callComment(int data)
           
protected abstract  void callProcessingInstruction(int piTarget, int piData)
           
protected abstract  int checkForAttributeNameWithPEReference(char fastcheck)
           
protected abstract  int checkForElementTypeWithPEReference(char fastchar)
           
protected abstract  int checkForNameWithPEReference(char fastcheck)
           
protected abstract  int checkForNmtokenWithPEReference(char fastcheck)
           
protected  int decreaseMarkupDepth()
           
protected abstract  void decreaseParenDepth()
           
protected abstract  void doctypeDecl(int rootElementType, int publicId, int systemId)
           
protected abstract  void endEnumeration(int enumIndex)
           
 void endOfInput(int entityNameIndex, boolean moreToFollow)
           
protected abstract  java.lang.String getContentSpecNodeAsString(int nodeIndex)
           
protected  boolean getReadingExternalEntity()
           
protected  int getScannerState()
           
protected  int increaseMarkupDepth()
           
protected abstract  void increaseParenDepth()
           
protected abstract  void literalDataAppend(char ch)
           
protected abstract  void literalDataAppend(int toCopy, int length)
           
protected abstract  int literalDataIndex(int dataOffset, int dataLength)
           
protected abstract  int literalDataLength()
           
protected  int markupDepth()
           
protected abstract  int parenDepth()
           
 void readerChange(com.ibm.xml.readers.XMLEntityHandler.EntityReader nextReader, int nextReaderId)
           
protected  void reportFatalXMLError(int majorCode, int minorCode)
           
protected  void reportFatalXMLError(int majorCode, int minorCode, int stringIndex1)
           
protected  void reportFatalXMLError(int majorCode, int minorCode, int stringIndex1, int stringIndex2)
           
protected  void reportFatalXMLError(int majorCode, int minorCode, java.lang.String string1)
           
protected  void reportFatalXMLError(int majorCode, int minorCode, java.lang.String string1, java.lang.String string2)
           
protected  void reportFatalXMLError(int majorCode, int minorCode, java.lang.String string1, java.lang.String string2, java.lang.String string3)
           
 void reset(com.ibm.xml.utils.StringPool stringPool, XMLErrorReporter errorReporter, com.ibm.xml.readers.XMLDTDEntityHandler entityHandler)
           
protected  void restoreScannerState(int scannerState)
           
protected abstract  int saveCurrentLocation()
           
protected  void scanDecls(boolean extSubset)
           
protected  int scanDefaultAttValue(int elementType, int attDefName, int attDefType, int attDefEnumeration)
           
protected  boolean scanDoctypeDecl()
           
protected abstract  int scanElementType(char fastchar)
           
protected abstract  void setParenDepth(int parenDepth)
           
protected  int setScannerState(int scannerState)
           
protected  void skipPastEndOfCurrentMarkup()
           
protected abstract  int startEnumeration()
           
protected abstract  void startReadingFromExternalSubset(int publicId, int systemId)
           
protected abstract  void stopReadingFromExternalSubset()
           
protected abstract  boolean validEncName(java.lang.String encoding)
           
protected abstract  int validPublicId(java.lang.String publicId)
           
protected abstract  boolean validVersionNum(java.lang.String version)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fStringPool

protected com.ibm.xml.utils.StringPool fStringPool

fErrorReporter

protected XMLErrorReporter fErrorReporter

fEntityHandler

protected com.ibm.xml.readers.XMLDTDEntityHandler fEntityHandler

fEntityReader

protected com.ibm.xml.readers.XMLEntityHandler.EntityReader fEntityReader

fReaderId

protected int fReaderId

fExternalSubsetReader

protected int fExternalSubsetReader

SCANNER_STATE_UNKNOWN

protected static final int SCANNER_STATE_UNKNOWN

SCANNER_STATE_DOCTYPEDECL

protected static final int SCANNER_STATE_DOCTYPEDECL

SCANNER_STATE_MARKUP_DECL

protected static final int SCANNER_STATE_MARKUP_DECL

SCANNER_STATE_TEXTDECL

protected static final int SCANNER_STATE_TEXTDECL

SCANNER_STATE_COMMENT

protected static final int SCANNER_STATE_COMMENT

SCANNER_STATE_PI

protected static final int SCANNER_STATE_PI

SCANNER_STATE_DEFAULT_ATTRIBUTE_VALUE

protected static final int SCANNER_STATE_DEFAULT_ATTRIBUTE_VALUE

SCANNER_STATE_CONTENTSPEC

protected static final int SCANNER_STATE_CONTENTSPEC

SCANNER_STATE_ENTITY_VALUE

protected static final int SCANNER_STATE_ENTITY_VALUE

SCANNER_STATE_SYSTEMLITERAL

protected static final int SCANNER_STATE_SYSTEMLITERAL

SCANNER_STATE_PUBIDLITERAL

protected static final int SCANNER_STATE_PUBIDLITERAL
Constructor Detail

XMLDTDScanner

public XMLDTDScanner(com.ibm.xml.utils.StringPool stringPool,
                     XMLErrorReporter errorReporter,
                     com.ibm.xml.readers.XMLDTDEntityHandler entityHandler)
Method Detail

getReadingExternalEntity

protected boolean getReadingExternalEntity()

markupDepth

protected final int markupDepth()

increaseMarkupDepth

protected final int increaseMarkupDepth()

decreaseMarkupDepth

protected final int decreaseMarkupDepth()

reset

public void reset(com.ibm.xml.utils.StringPool stringPool,
                  XMLErrorReporter errorReporter,
                  com.ibm.xml.readers.XMLDTDEntityHandler entityHandler)
           throws java.lang.Exception

saveCurrentLocation

protected abstract int saveCurrentLocation()
                                    throws java.lang.Exception

literalDataAppend

protected abstract void literalDataAppend(int toCopy,
                                          int length)
                                   throws java.lang.Exception

literalDataAppend

protected abstract void literalDataAppend(char ch)
                                   throws java.lang.Exception

literalDataLength

protected abstract int literalDataLength()
                                  throws java.lang.Exception

literalDataIndex

protected abstract int literalDataIndex(int dataOffset,
                                        int dataLength)
                                 throws java.lang.Exception

validVersionNum

protected abstract boolean validVersionNum(java.lang.String version)
                                    throws java.lang.Exception

validEncName

protected abstract boolean validEncName(java.lang.String encoding)
                                 throws java.lang.Exception

validPublicId

protected abstract int validPublicId(java.lang.String publicId)
                              throws java.lang.Exception

setParenDepth

protected abstract void setParenDepth(int parenDepth)
                               throws java.lang.Exception

parenDepth

protected abstract int parenDepth()
                           throws java.lang.Exception

increaseParenDepth

protected abstract void increaseParenDepth()
                                    throws java.lang.Exception

decreaseParenDepth

protected abstract void decreaseParenDepth()
                                    throws java.lang.Exception

doctypeDecl

protected abstract void doctypeDecl(int rootElementType,
                                    int publicId,
                                    int systemId)
                             throws java.lang.Exception

startReadingFromExternalSubset

protected abstract void startReadingFromExternalSubset(int publicId,
                                                       int systemId)
                                                throws java.lang.Exception

stopReadingFromExternalSubset

protected abstract void stopReadingFromExternalSubset()
                                               throws java.lang.Exception

addElementDecl

protected abstract int addElementDecl(int elementTypeIndex)
                               throws java.lang.Exception

addElementDecl

protected abstract int addElementDecl(int elementTypeIndex,
                                      int contentSpecType,
                                      int contentSpec)
                               throws java.lang.Exception

addAttDef

protected abstract int addAttDef(int elementIndex,
                                 int attName,
                                 int attType,
                                 int enumeration,
                                 int attDefaultType,
                                 int attDefaultValue)
                          throws java.lang.Exception

addUniqueLeafNode

protected abstract int addUniqueLeafNode(int nameIndex)
                                  throws java.lang.Exception

addContentSpecNode

protected abstract int addContentSpecNode(int nodeType,
                                          int nodeValue)
                                   throws java.lang.Exception

addContentSpecNode

protected abstract int addContentSpecNode(int nodeType,
                                          int leftNodeIndex,
                                          int rightNodeIndex)
                                   throws java.lang.Exception

getContentSpecNodeAsString

protected abstract java.lang.String getContentSpecNodeAsString(int nodeIndex)
                                                        throws java.lang.Exception

addInternalPEDecl

protected abstract int addInternalPEDecl(int name,
                                         int value,
                                         int location)
                                  throws java.lang.Exception

addExternalPEDecl

protected abstract int addExternalPEDecl(int name,
                                         int publicId,
                                         int systemId)
                                  throws java.lang.Exception

addInternalEntityDecl

protected abstract int addInternalEntityDecl(int name,
                                             int value,
                                             int location)
                                      throws java.lang.Exception

addExternalEntityDecl

protected abstract int addExternalEntityDecl(int name,
                                             int publicId,
                                             int systemId)
                                      throws java.lang.Exception

addUnparsedEntityDecl

protected abstract int addUnparsedEntityDecl(int name,
                                             int publicId,
                                             int systemId,
                                             int notationName)
                                      throws java.lang.Exception

startEnumeration

protected abstract int startEnumeration()
                                 throws java.lang.Exception

addNameToEnumeration

protected abstract void addNameToEnumeration(int enumIndex,
                                             int elementType,
                                             int attrName,
                                             int nameIndex,
                                             boolean isNotationType)
                                      throws java.lang.Exception

endEnumeration

protected abstract void endEnumeration(int enumIndex)
                                throws java.lang.Exception

addNotationDecl

protected abstract int addNotationDecl(int notationName,
                                       int publicId,
                                       int systemId)
                                throws java.lang.Exception

callComment

protected abstract void callComment(int data)
                             throws java.lang.Exception

callProcessingInstruction

protected abstract void callProcessingInstruction(int piTarget,
                                                  int piData)
                                           throws java.lang.Exception

scanElementType

protected abstract int scanElementType(char fastchar)
                                throws java.lang.Exception

checkForElementTypeWithPEReference

protected abstract int checkForElementTypeWithPEReference(char fastchar)
                                                   throws java.lang.Exception

checkForAttributeNameWithPEReference

protected abstract int checkForAttributeNameWithPEReference(char fastcheck)
                                                     throws java.lang.Exception

checkForNameWithPEReference

protected abstract int checkForNameWithPEReference(char fastcheck)
                                            throws java.lang.Exception

checkForNmtokenWithPEReference

protected abstract int checkForNmtokenWithPEReference(char fastcheck)
                                               throws java.lang.Exception

reportFatalXMLError

protected void reportFatalXMLError(int majorCode,
                                   int minorCode)
                            throws java.lang.Exception

reportFatalXMLError

protected void reportFatalXMLError(int majorCode,
                                   int minorCode,
                                   int stringIndex1)
                            throws java.lang.Exception

reportFatalXMLError

protected void reportFatalXMLError(int majorCode,
                                   int minorCode,
                                   java.lang.String string1)
                            throws java.lang.Exception

reportFatalXMLError

protected void reportFatalXMLError(int majorCode,
                                   int minorCode,
                                   int stringIndex1,
                                   int stringIndex2)
                            throws java.lang.Exception

reportFatalXMLError

protected void reportFatalXMLError(int majorCode,
                                   int minorCode,
                                   java.lang.String string1,
                                   java.lang.String string2)
                            throws java.lang.Exception

reportFatalXMLError

protected void reportFatalXMLError(int majorCode,
                                   int minorCode,
                                   java.lang.String string1,
                                   java.lang.String string2,
                                   java.lang.String string3)
                            throws java.lang.Exception

abortMarkup

protected void abortMarkup(int majorCode,
                           int minorCode)
                    throws java.lang.Exception

abortMarkup

protected void abortMarkup(int majorCode,
                           int minorCode,
                           int stringIndex1)
                    throws java.lang.Exception

abortMarkup

protected void abortMarkup(int majorCode,
                           int minorCode,
                           java.lang.String string1)
                    throws java.lang.Exception

abortMarkup

protected void abortMarkup(int majorCode,
                           int minorCode,
                           int stringIndex1,
                           int stringIndex2)
                    throws java.lang.Exception

skipPastEndOfCurrentMarkup

protected void skipPastEndOfCurrentMarkup()
                                   throws java.lang.Exception

setScannerState

protected int setScannerState(int scannerState)

getScannerState

protected int getScannerState()

restoreScannerState

protected void restoreScannerState(int scannerState)

readerChange

public void readerChange(com.ibm.xml.readers.XMLEntityHandler.EntityReader nextReader,
                         int nextReaderId)
                  throws java.lang.Exception

endOfInput

public void endOfInput(int entityNameIndex,
                       boolean moreToFollow)
                throws java.lang.Exception

scanDoctypeDecl

protected boolean scanDoctypeDecl()
                           throws java.lang.Exception

scanDecls

protected void scanDecls(boolean extSubset)
                  throws java.lang.Exception

scanDefaultAttValue

protected int scanDefaultAttValue(int elementType,
                                  int attDefName,
                                  int attDefType,
                                  int attDefEnumeration)
                           throws java.lang.Exception

XML for Java EA2