FileDocCategorySizeDatePackage
DTDParser.javaAPI DocApache Xerces 3.0.118134Fri Sep 14 20:33:54 BST 2007org.apache.xerces.parsers

DTDParser

public abstract class DTDParser extends XMLGrammarParser implements org.apache.xerces.xni.XMLDTDHandler, org.apache.xerces.xni.XMLDTDContentModelHandler
version
$Id: DTDParser.java 447239 2006-09-18 05:08:26Z mrglavas $

Fields Summary
protected org.apache.xerces.xni.parser.XMLDTDScanner
fDTDScanner
fDTDScanner
Constructors Summary
public DTDParser(org.apache.xerces.util.SymbolTable symbolTable)

param
symbolTable

        super(symbolTable);
    
Methods Summary
public voidattributeDecl(java.lang.String elementName, java.lang.String attributeName, java.lang.String type, java.lang.String[] enumeration, java.lang.String defaultType, org.apache.xerces.xni.XMLString defaultValue, org.apache.xerces.xni.XMLString nonNormalizedDefaultValue, org.apache.xerces.xni.Augmentations augmentations)
An attribute declaration.

param
elementName The name of the element that this attribute is associated with.
param
attributeName The name of the attribute.
param
type The attribute type. This value will be one of the following: "CDATA", "ENTITY", "ENTITIES", "ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION".
param
enumeration If the type has the value "ENUMERATION", this array holds the allowed attribute values; otherwise, this array is null.
param
defaultType The attribute default type. This value will be one of the following: "#FIXED", "#IMPLIED", "#REQUIRED", or null.
param
defaultValue The attribute default value, or null if no default value is specified.
throws
XNIException Thrown by handler to signal an error.

    
public voidchildrenElement(java.lang.String elementName)
A referenced element in a children content model.

param
elementName The name of the referenced element.
throws
XNIException Thrown by handler to signal an error.
see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_CHILDREN

    
public voidchildrenEndGroup()
The end of a children group.

Note: This method is only called after a call to the startContentModel method where the type is TYPE_CHILDREN.

see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_CHILDREN

    
public voidchildrenOccurrence(short occurrence)
The occurrence count for a child in a children content model.

Note: This method is only called after a call to the startContentModel method where the type is TYPE_CHILDREN.

param
occurrence The occurrence count for the last children element or children group.
throws
XNIException Thrown by handler to signal an error.
see
XMLDTDContentModelHandler#OCCURS_ZERO_OR_ONE
see
XMLDTDContentModelHandler#OCCURS_ZERO_OR_MORE
see
XMLDTDContentModelHandler#OCCURS_ONE_OR_MORE
see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_CHILDREN

    
public voidchildrenSeparator(short separator)
The separator between choices or sequences of a children content model.

Note: This method is only called after a call to the startContentModel method where the type is TYPE_CHILDREN.

param
separator The type of children separator.
throws
XNIException Thrown by handler to signal an error.
see
XMLDTDContentModelHandler#SEPARATOR_CHOICE
see
XMLDTDContentModelHandler#SEPARATOR_SEQUENCE
see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_CHILDREN

    
public voidchildrenStartGroup()
The start of a children group.

Note: This method is only called after a call to the startContentModel method where the type is TYPE_CHILDREN.

Note: Children groups can be nested and have associated occurrence counts.

throws
XNIException Thrown by handler to signal an error.
see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_CHILDREN

    
public voidcomment(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augmentations)
A comment.

param
text The text in the comment.
throws
XNIException Thrown by application to signal an error.

    
public voidelementDecl(java.lang.String name, java.lang.String contentModel, org.apache.xerces.xni.Augmentations augmentations)
An element declaration.

param
name The name of the element.
param
contentModel The element content model.
throws
XNIException Thrown by handler to signal an error.

    
public voidendAttlist(org.apache.xerces.xni.Augmentations augmentations)
The end of an attribute list.

throws
XNIException Thrown by handler to signal an error.

    
public voidendConditional(org.apache.xerces.xni.Augmentations augmentations)
The end of a conditional section.

throws
XNIException Thrown by handler to signal an error.

    
public voidendContentModel()
The end of a content model.

throws
XNIException Thrown by handler to signal an error.

    
public voidendDTD(org.apache.xerces.xni.Augmentations augmentations)
The end of the DTD.

throws
XNIException Thrown by handler to signal an error.

    
public voidendEntity(java.lang.String name, org.apache.xerces.xni.Augmentations augmentations)
This method notifies the end of an entity. The DTD has the pseudo-name of "[dtd]" and parameter entity names start with '%'.

Note: Since the DTD is an entity, the handler will be notified of the end of the DTD entity by calling the endEntity method with the entity name "[dtd]" after calling the endDTD method.

param
name The name of the entity.
throws
XNIException Thrown by handler to signal an error.

    
public voidendExternalSubset(org.apache.xerces.xni.Augmentations augmentations)
The end of the external subset.

throws
XNIException Thrown by handler to signal an error.

    
public voidexternalEntityDecl(java.lang.String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augmentations)
An external entity declaration.

param
name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.
param
identifier An object containing all location information pertinent to this entity.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

    
public org.apache.xerces.impl.dtd.DTDGrammargetDTDGrammar()
getDTDGrammar

return
the grammar created by this parser

        return null;
    
public voidinternalEntityDecl(java.lang.String name, org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.XMLString nonNormalizedText, org.apache.xerces.xni.Augmentations augmentations)
An internal entity declaration.

param
name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.
param
text The value of the entity.
param
nonNormalizedText The non-normalized value of the entity. This value contains the same sequence of characters that was in the internal entity declaration, without any entity references expanded.
throws
XNIException Thrown by handler to signal an error.

    
public voidmixedElement(java.lang.String elementName)
A referenced element in a mixed content model. If the mixed content model only allows text content, then this method will not be called for that model. However, if this method is called for a mixed content model, then the zero or more occurrence count is implied.

Note: This method is only called after a call to the startContentModel method where the type is TYPE_MIXED.

param
elementName The name of the referenced element.
throws
XNIException Thrown by handler to signal an error.
see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_MIXED

    
public voidnotationDecl(java.lang.String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augmentations)
A notation declaration

param
name The name of the notation.
param
identifier An object containing all location information pertinent to this notation.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.

    
public voidprocessingInstruction(java.lang.String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.Augmentations augmentations)
A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.

Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.

param
target The target.
param
data The data or null if none specified.
throws
XNIException Thrown by handler to signal an error.

    
public voidstartAttlist(java.lang.String elementName, org.apache.xerces.xni.Augmentations augmentations)
The start of an attribute list.

param
elementName The name of the element that this attribute list is associated with.
throws
XNIException Thrown by handler to signal an error.

    
public voidstartConditional(short type, org.apache.xerces.xni.Augmentations augmentations)
The start of a conditional section.

param
type The type of the conditional section. This value will either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.
throws
XNIException Thrown by handler to signal an error.
see
XMLDTDHandler#CONDITIONAL_INCLUDE
see
XMLDTDHandler#CONDITIONAL_IGNORE

    
public voidstartContentModel(java.lang.String elementName, short type)
The start of a content model. Depending on the type of the content model, specific methods may be called between the call to the startContentModel method and the call to the endContentModel method.

param
elementName The name of the element.
param
type The content model type.
throws
XNIException Thrown by handler to signal an error.
see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_EMPTY
see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_ANY
see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_MIXED
see
org.apache.xerces.impl.dtd.XMLElementDecl#TYPE_CHILDREN

    
public voidstartDTD(org.apache.xerces.xni.XMLLocator locator, org.apache.xerces.xni.Augmentations augmentations)
The start of the DTD.

throws
XNIException Thrown by handler to signal an error.

    
public voidstartEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String encoding)
This method notifies of the start of an entity. The DTD has the pseudo-name of "[dtd]" and parameter entity names start with '%'.

Note: Since the DTD is an entity, the handler will be notified of the start of the DTD entity by calling the startEntity method with the entity name "[dtd]" before calling the startDTD method.

param
name The name of the entity.
param
publicId The public identifier of the entity if the entity is external, null otherwise.
param
systemId The system identifier of the entity if the entity is external, null otherwise.
param
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 parameter entities).
throws
XNIException Thrown by handler to signal an error.

    
public voidstartExternalSubset(org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augmentations)
The start of the external subset.

throws
XNIException Thrown by handler to signal an error.

    
public voidtextDecl(java.lang.String version, java.lang.String encoding)
Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the startEntity call.

Note: This method is only called for external parameter entities referenced in the DTD.

param
version The XML version, or null if not specified.
param
encoding The IANA encoding name of the entity.
throws
XNIException Thrown by handler to signal an error.

    
public voidunparsedEntityDecl(java.lang.String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, java.lang.String notation, org.apache.xerces.xni.Augmentations augmentations)
An unparsed entity declaration.

param
name The name of the entity.
param
identifier An object containing all location information pertinent to this entity.
param
notation The name of the notation.
param
augmentations Additional information that may include infoset augmentations.
throws
XNIException Thrown by handler to signal an error.