Top Description Constructors Methods
com.sun.msv.scanner.dtd

public Class DTDHandlerBase

extends Object
implements DTDEventListener
Class Inheritance
All Implemented Interfaces
com.sun.msv.scanner.dtd.DTDEventListener, java.util.EventListener
Imports
org.xml.sax.Locator, .SAXException, .SAXParseException
do-nothing implementation of DTDEventHandler.

Constructor Summary

AccessConstructor and Description
public
DTDHandlerBase()

Method Summary

Modifier and TypeMethod and Description
public void
attributeDecl(String elementName, String attributeName, String attributeType, String[] enumeration, short attributeUse, String defaultValue)

Implements com.sun.msv.scanner.dtd.DTDEventListener.attributeDecl.

For each entry in an ATTLIST declaration, this event will be fired.
public void
characters(char[]
The characters from the DTD.
ch, int
The start position in the array.
start, int
The number of characters to read from the array.
length)

Implements com.sun.msv.scanner.dtd.DTDEventListener.characters.

Receive notification of character data.
public void
childElement(String elementName, short occurence)

Implements com.sun.msv.scanner.dtd.DTDEventListener.childElement.

public void
comment(String
the text within the comment delimiters.
n)

Implements com.sun.msv.scanner.dtd.DTDEventListener.comment.

Receive notification that a comment has been read.
public void
connector(short connectorType)

Implements com.sun.msv.scanner.dtd.DTDEventListener.connector.

Connectors in one model group is guaranteed to be the same.
public void
endCDATA()

Implements com.sun.msv.scanner.dtd.DTDEventListener.endCDATA.

Receive notification that the CDATA section finished.
public void
endContentModel(String elementName, short contentModelType)

Implements com.sun.msv.scanner.dtd.DTDEventListener.endContentModel.

receives notification that parsing of content model is finished.
public void
endDTD()

Implements com.sun.msv.scanner.dtd.DTDEventListener.endDTD.

Receive notification of the end of a DTD.
public void
endModelGroup(short occurence)

Implements com.sun.msv.scanner.dtd.DTDEventListener.endModelGroup.

public void
error(SAXParseException e)

Implements com.sun.msv.scanner.dtd.DTDEventListener.error.

public void
externalGeneralEntityDecl(String
The entity name.
n, String
The entity's public identifier, or null if none was given.
p, String
The entity's system identifier.
s)

Implements com.sun.msv.scanner.dtd.DTDEventListener.externalGeneralEntityDecl.

Receive notification of an external parsed general entity declaration event.
public void
externalParameterEntityDecl(String
The parameter entity name.
n, String
The entity's public identifier, or null if none was given.
p, String
The entity's system identifier.
s)

Implements com.sun.msv.scanner.dtd.DTDEventListener.externalParameterEntityDecl.

Receive notification of an external parameter entity declaration event.
public void
fatalError(SAXParseException e)

Implements com.sun.msv.scanner.dtd.DTDEventListener.fatalError.

public void
ignorableWhitespace(char[]
The characters from the DTD.
ch, int
The start position in the array.
start, int
The number of characters to read from the array.
length)

Implements com.sun.msv.scanner.dtd.DTDEventListener.ignorableWhitespace.

Receive notification of ignorable whitespace in element content.
public void
internalGeneralEntityDecl(String
The internal general entity name.
n, String
The value of the entity, which may include unexpanded entity references. Character references will have been expanded.
v)

Implements com.sun.msv.scanner.dtd.DTDEventListener.internalGeneralEntityDecl.

Receive notification of a internal general entity declaration event.
public void
internalParameterEntityDecl(String
The internal parameter entity name.
n, String
The value of the entity, which may include unexpanded entity references. Character references will have been expanded.
v)

Implements com.sun.msv.scanner.dtd.DTDEventListener.internalParameterEntityDecl.

Receive notification of a internal parameter entity declaration event.
public void
mixedElement(String elementName)

Implements com.sun.msv.scanner.dtd.DTDEventListener.mixedElement.

receives notification of child element of mixed content model.
public void
notationDecl(String
The notation name, referred to by entities and elements.
name, String
The public identifier
publicId, String
The system identifier
systemId)

Implements com.sun.msv.scanner.dtd.DTDEventListener.notationDecl.

Receive notification of a Notation Declaration.
public void
processingInstruction(String
The target of the proceessing instruction which should have meaning to the application.
target, String
The instruction itself which should contain valid XML characters.
data)

Implements com.sun.msv.scanner.dtd.DTDEventListener.processingInstruction.

Receive notification of a Processing Instruction.
public void
setDocumentLocator(Locator loc)

Implements com.sun.msv.scanner.dtd.DTDEventListener.setDocumentLocator.

public void
startCDATA()

Implements com.sun.msv.scanner.dtd.DTDEventListener.startCDATA.

Receive notification that a CDATA section is beginning.
public void
startContentModel(String
name of the element whose content model is going to be defined.
elementName, short
CONTENT_MODEL_EMPTY this element has EMPTY content model. This notification will be immediately followed by the corresponding endContentModel. CONTENT_MODEL_ANY this element has ANY content model. This notification will be immediately followed by the corresponding endContentModel. CONTENT_MODEL_MIXED this element has mixed content model. #PCDATA will not be reported. each child element will be reported by mixedElement method. 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
contentModelType)

Implements com.sun.msv.scanner.dtd.DTDEventListener.startContentModel.

receives notification that parsing of content model is beginning.
public void
startDTD(InputEntity
Current input entity.
in)

Implements com.sun.msv.scanner.dtd.DTDEventListener.startDTD.

Receive notification of the beginning of the DTD.
public void
startModelGroup()

Implements com.sun.msv.scanner.dtd.DTDEventListener.startModelGroup.

public void
unparsedEntityDecl(String
The name of the unparsed entity.
name, String
The public identifier
publicId, String
The system identifier
systemId, String
The associated notation
notationName)

Implements com.sun.msv.scanner.dtd.DTDEventListener.unparsedEntityDecl.

Receive notification of an unparsed entity declaration.
public void
warning(SAXParseException err)

Implements com.sun.msv.scanner.dtd.DTDEventListener.warning.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

DTDHandlerBaseback to summary
public DTDHandlerBase()

Method Detail

attributeDeclback to summary
public void attributeDecl(String elementName, String attributeName, String attributeType, String[] enumeration, short attributeUse, String defaultValue) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.attributeDecl.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.attributeDecl.

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.

charactersback to summary
public void characters(char[] ch, int start, int length) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.characters.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.characters.

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).

Parameters
ch:char[]

The characters from the DTD.

start:int

The start position in the array.

length:int

The number of characters to read from the array.

childElementback to summary
public void childElement(String elementName, short occurence) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.childElement.

commentback to summary
public void comment(String n) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.comment.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.comment.

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.

Parameters
n:String

the text within the comment delimiters.

connectorback to summary
public void connector(short connectorType) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.connector.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.connector.

Connectors in one model group is guaranteed to be the same.

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

Returns:void

CHOICE or SEQUENCE.

endCDATAback to summary
public void endCDATA() throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.endCDATA.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.endCDATA.

Receive notification that the CDATA section finished.

endContentModelback to summary
public void endContentModel(String elementName, short contentModelType) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.endContentModel.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.endContentModel.

receives notification that parsing of content model is finished.

endDTDback to summary
public void endDTD() throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.endDTD.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.endDTD.

Receive notification of the end of a DTD. The parser will invoke this method only once.

endModelGroupback to summary
public void endModelGroup(short occurence) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.endModelGroup.

errorback to summary
public void error(SAXParseException e) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.error.

externalGeneralEntityDeclback to summary
public void externalGeneralEntityDecl(String n, String p, String s) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.externalGeneralEntityDecl.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.externalGeneralEntityDecl.

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.

Parameters
n:String

The entity name.

p:String

The entity's public identifier, or null if none was given.

s:String

The entity's system identifier.

externalParameterEntityDeclback to summary
public void externalParameterEntityDecl(String n, String p, String s) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.externalParameterEntityDecl.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.externalParameterEntityDecl.

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.

Parameters
n:String

The parameter entity name.

p:String

The entity's public identifier, or null if none was given.

s:String

The entity's system identifier.

fatalErrorback to summary
public void fatalError(SAXParseException e) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.fatalError.

ignorableWhitespaceback to summary
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.ignorableWhitespace.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.ignorableWhitespace.

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.

Parameters
ch:char[]

The characters from the DTD.

start:int

The start position in the array.

length:int

The number of characters to read from the array.

internalGeneralEntityDeclback to summary
public void internalGeneralEntityDecl(String n, String v) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.internalGeneralEntityDecl.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.internalGeneralEntityDecl.

Receive notification of a internal general entity declaration event.

Parameters
n:String

The internal general entity name.

v:String

The value of the entity, which may include unexpanded entity references. Character references will have been expanded.

internalParameterEntityDeclback to summary
public void internalParameterEntityDecl(String n, String v) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.internalParameterEntityDecl.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.internalParameterEntityDecl.

Receive notification of a internal parameter entity declaration event.

Parameters
n:String

The internal parameter entity name.

v:String

The value of the entity, which may include unexpanded entity references. Character references will have been expanded.

mixedElementback to summary
public void mixedElement(String elementName) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.mixedElement.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.mixedElement.

receives notification of child element of mixed content model. this method is called for each child element.

notationDeclback to summary
public void notationDecl(String name, String publicId, String systemId) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.notationDecl.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.notationDecl.

Receive notification of a Notation Declaration. Notation declarations are used by elements and entities for identifying embedded non-XML data.

Parameters
name:String

The notation name, referred to by entities and elements.

publicId:String

The public identifier

systemId:String

The system identifier

processingInstructionback to summary
public void processingInstruction(String target, String data) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.processingInstruction.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.processingInstruction.

Receive notification of a Processing Instruction. Processing instructions contain information meaningful to the application.

Parameters
target:String

The target of the proceessing instruction which should have meaning to the application.

data:String

The instruction itself which should contain valid XML characters.

setDocumentLocatorback to summary
public void setDocumentLocator(Locator loc)

Implements com.sun.msv.scanner.dtd.DTDEventListener.setDocumentLocator.

startCDATAback to summary
public void startCDATA() throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.startCDATA.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.startCDATA.

Receive notification that a CDATA section is beginning. Data in a CDATA section is is reported through the appropriate event, either characters() or ignorableWhitespace.

startContentModelback to summary
public void startContentModel(String elementName, short contentModelType) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.startContentModel.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.startContentModel.

receives notification that parsing of content model is beginning.

Parameters
elementName:String

name of the element whose content model is going to be defined.

contentModelType:short

CONTENT_MODEL_EMPTY this element has EMPTY content model. This notification will be immediately followed by the corresponding endContentModel. CONTENT_MODEL_ANY this element has ANY content model. This notification will be immediately followed by the corresponding endContentModel. CONTENT_MODEL_MIXED this element has mixed content model. #PCDATA will not be reported. each child element will be reported by mixedElement method. 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

startDTDback to summary
public void startDTD(InputEntity in) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.startDTD.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.startDTD.

Receive notification of the beginning of the DTD.

Parameters
in:InputEntity

Current input entity.

startModelGroupback to summary
public void startModelGroup() throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.startModelGroup.

unparsedEntityDeclback to summary
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.unparsedEntityDecl.

Doc from com.sun.msv.scanner.dtd.DTDEventListener.unparsedEntityDecl.

Receive notification of an unparsed entity declaration. Unparsed entities are non-XML data.

Parameters
name:String

The name of the unparsed entity.

publicId:String

The public identifier

systemId:String

The system identifier

notationName:String

The associated notation

warningback to summary
public void warning(SAXParseException err) throws SAXException

Implements com.sun.msv.scanner.dtd.DTDEventListener.warning.