com.sun.msv.scanner.dtd

Class DTDHandlerBase

Implemented Interfaces:
DTDEventListener, EventListener

public class DTDHandlerBase
extends Object
implements DTDEventListener

do-nothing implementation of DTDEventHandler.

Fields inherited from interface com.sun.msv.scanner.dtd.DTDEventListener

CHOICE, CONTENT_MODEL_ANY, CONTENT_MODEL_CHILDREN, CONTENT_MODEL_EMPTY, CONTENT_MODEL_MIXED, OCCURENCE_ONCE, OCCURENCE_ONE_OR_MORE, OCCURENCE_ZERO_OR_MORE, OCCURENCE_ZERO_OR_ONE, SEQUENCE, USE_FIXED, USE_IMPLIED, USE_NORMAL, USE_REQUIRED

Method Summary

void
attributeDecl(String elementName, String attributeName, String attributeType, String[] enumeration, short attributeUse, String defaultValue)
For each entry in an ATTLIST declaration, this event will be fired.
void
characters(ch[] , int start, int length)
Receive notification of character data.
void
childElement(String elementName, short occurence)
void
comment(String n)
Receive notification that a comment has been read.
void
connector(short connectorType)
Connectors in one model group is guaranteed to be the same.
void
endCDATA()
Receive notification that the CDATA section finished.
void
endContentModel(String elementName, short contentModelType)
receives notification that parsing of content model is finished.
void
endDTD()
Receive notification of the end of a DTD.
void
endModelGroup(short occurence)
void
error(SAXParseException e)
void
externalGeneralEntityDecl(String n, String p, String s)
Receive notification of an external parsed general entity declaration event.
void
externalParameterEntityDecl(String n, String p, String s)
Receive notification of an external parameter entity declaration event.
void
fatalError(SAXParseException e)
void
ignorableWhitespace(ch[] , int start, int length)
Receive notification of ignorable whitespace in element content.
void
internalGeneralEntityDecl(String n, String v)
Receive notification of a internal general entity declaration event.
void
internalParameterEntityDecl(String n, String v)
Receive notification of a internal parameter entity declaration event.
void
mixedElement(String elementName)
receives notification of child element of mixed content model.
void
notationDecl(String name, String publicId, String systemId)
Receive notification of a Notation Declaration.
void
processingInstruction(String target, String data)
Receive notification of a Processing Instruction.
void
setDocumentLocator(Locator loc)
void
startCDATA()
Receive notification that a CDATA section is beginning.
void
startContentModel(String elementName, short contentModelType)
receives notification that parsing of content model is beginning.
void
startDTD(InputEntity in)
Receive notification of the beginning of the DTD.
void
startModelGroup()
void
unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Receive notification of an unparsed entity declaration.
void
warning(SAXParseException err)

Method Details

attributeDecl

public void attributeDecl(String elementName,
                          String attributeName,
                          String attributeType,
                          String[] enumeration,
                          short attributeUse,
                          String defaultValue)
            throws SAXException
For each entry in an ATTLIST declaration, this event will be fired.

DTD allows the same attributes to be declared more than once, and in that case the first one wins. I think this method will be only fired for the first one, but I need to check.

Specified by:
attributeDecl in interface DTDEventListener

characters

public void characters(ch[] ,
                       int start,
                       int length)
            throws SAXException
Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).

Specified by:
characters in interface DTDEventListener
Parameters:
start - The start position in the array.
length - The number of characters to read from the array.
See Also:
ignorableWhitespace(char[], int, int)

childElement

public void childElement(String elementName,
                         short occurence)
            throws SAXException
Specified by:
childElement in interface DTDEventListener

comment

public void comment(String n)
            throws SAXException
Receive notification that a comment has been read.

Note that processing instructions are the mechanism designed to hold information for consumption by applications, not comments. XML systems may rely on applications being able to access information found in processing instructions; this is not true of comments, which are typically discarded.

Specified by:
comment in interface DTDEventListener
Parameters:

connector

public void connector(short connectorType)
            throws SAXException
Connectors in one model group is guaranteed to be the same.

IOW, you'll never see an event sequence like (a|b,c)

Specified by:
connector in interface DTDEventListener

endCDATA

public void endCDATA()
            throws SAXException
Receive notification that the CDATA section finished.
Specified by:
endCDATA in interface DTDEventListener

endContentModel

public void endContentModel(String elementName,
                            short contentModelType)
            throws SAXException
receives notification that parsing of content model is finished.
Specified by:
endContentModel in interface DTDEventListener

endDTD

public void endDTD()
            throws SAXException
Receive notification of the end of a DTD. The parser will invoke this method only once.
Specified by:
endDTD in interface DTDEventListener

endModelGroup

public void endModelGroup(short occurence)
            throws SAXException
Specified by:
endModelGroup in interface DTDEventListener

error

public void error(SAXParseException e)
            throws SAXException
Specified by:
error in interface DTDEventListener

externalGeneralEntityDecl

public void externalGeneralEntityDecl(String n,
                                      String p,
                                      String s)
            throws SAXException
Receive notification of an external parsed general entity declaration event.

If a system identifier is present, and it is a relative URL, the parser will have resolved it fully before passing it through this method to a listener.

Specified by:
externalGeneralEntityDecl in interface DTDEventListener
Parameters:

externalParameterEntityDecl

public void externalParameterEntityDecl(String n,
                                        String p,
                                        String s)
            throws SAXException
Receive notification of an external parameter entity declaration event.

If a system identifier is present, and it is a relative URL, the parser will have resolved it fully before passing it through this method to a listener.

Specified by:
externalParameterEntityDecl in interface DTDEventListener
Parameters:

fatalError

public void fatalError(SAXParseException e)
            throws SAXException
Specified by:
fatalError in interface DTDEventListener

ignorableWhitespace

public void ignorableWhitespace(ch[] ,
                                int start,
                                int length)
            throws SAXException
Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Specified by:
ignorableWhitespace in interface DTDEventListener
Parameters:
start - The start position in the array.
length - The number of characters to read from the array.
See Also:
characters(char[], int, int)

internalGeneralEntityDecl

public void internalGeneralEntityDecl(String n,
                                      String v)
            throws SAXException
Receive notification of a internal general entity declaration event.
Specified by:
internalGeneralEntityDecl in interface DTDEventListener
Parameters:

internalParameterEntityDecl

public void internalParameterEntityDecl(String n,
                                        String v)
            throws SAXException
Receive notification of a internal parameter entity declaration event.
Specified by:
internalParameterEntityDecl in interface DTDEventListener
Parameters:

mixedElement

public void mixedElement(String elementName)
            throws SAXException
receives notification of child element of mixed content model. this method is called for each child element.
Specified by:
mixedElement in interface DTDEventListener

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
            throws SAXException
Receive notification of a Notation Declaration. Notation declarations are used by elements and entities for identifying embedded non-XML data.
Specified by:
notationDecl in interface DTDEventListener
Parameters:
name - The notation name, referred to by entities and elements.
publicId - The public identifier
systemId - The system identifier

processingInstruction

public void processingInstruction(String target,
                                  String data)
            throws SAXException
Receive notification of a Processing Instruction. Processing instructions contain information meaningful to the application.
Specified by:
processingInstruction in interface DTDEventListener
Parameters:
target - The target of the proceessing instruction which should have meaning to the application.
data - The instruction itself which should contain valid XML characters.

setDocumentLocator

public void setDocumentLocator(Locator loc)
Specified by:
setDocumentLocator in interface DTDEventListener

startCDATA

public void startCDATA()
            throws SAXException
Receive notification that a CDATA section is beginning. Data in a CDATA section is is reported through the appropriate event, either characters() or ignorableWhitespace.
Specified by:
startCDATA in interface DTDEventListener

startContentModel

public void startContentModel(String elementName,
                              short contentModelType)
            throws SAXException
receives notification that parsing of content model is beginning.
Specified by:
startContentModel in interface DTDEventListener
Parameters:
elementName - name of the element whose content model is going to be defined.
contentModelType - DTDEventListener.CONTENT_MODEL_EMPTY this element has EMPTY content model. This notification will be immediately followed by the corresponding endContentModel. DTDEventListener.CONTENT_MODEL_ANY this element has ANY content model. This notification will be immediately followed by the corresponding endContentModel. DTDEventListener.CONTENT_MODEL_MIXED this element has mixed content model. #PCDATA will not be reported. each child element will be reported by mixedElement method. DTDEventListener.CONTENT_MODEL_CHILDREN this elemen has child content model. The actual content model will be reported by childElement, startModelGroup, endModelGroup, and connector methods. Possible call sequences are: START := MODEL_GROUP MODEL_GROUP := startModelGroup TOKEN (connector TOKEN)* endModelGroup TOKEN := childElement | MODEL_GROUP

startDTD

public void startDTD(InputEntity in)
            throws SAXException
Receive notification of the beginning of the DTD.
Specified by:
startDTD in interface DTDEventListener
Parameters:
in - Current input entity.

startModelGroup

public void startModelGroup()
            throws SAXException
Specified by:
startModelGroup in interface DTDEventListener

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
            throws SAXException
Receive notification of an unparsed entity declaration. Unparsed entities are non-XML data.
Specified by:
unparsedEntityDecl in interface DTDEventListener
Parameters:
name - The name of the unparsed entity.
publicId - The public identifier
systemId - The system identifier
notationName - The associated notation

warning

public void warning(SAXParseException err)
            throws SAXException
Specified by:
warning in interface DTDEventListener