org.apache.xerces.impl.dtd

Class DTDGrammar

public class DTDGrammar extends Object implements XMLDTDHandler, XMLDTDContentModelHandler, EntityState, Grammar

A DTD grammar. This class implements the XNI handler interfaces for DTD information so that it can build the approprate validation structures automatically from the callbacks.

Version: $Id: DTDGrammar.java,v 1.32 2005/03/07 23:28:41 mrglavas Exp $

Author: Eric Ye, IBM Jeffrey Rodriguez, IBM Andy Clark, IBM Neil Graham, IBM

UNKNOWN:

Nested Class Summary
protected static classDTDGrammar.QNameHashtable
A simple Hashtable implementation that takes a tuple (String, String) as the key and a int as value.
Field Summary
protected XMLAttributeDeclfAttributeDecl
Temporary Attribute decl.
protected intfCurrentAttributeIndex
Current attribute index.
protected intfCurrentElementIndex
Current element index.
protected XMLDTDContentModelSourcefDTDContentModelSource
protected XMLDTDSourcefDTDSource
protected XMLDTDDescriptionfGrammarDescription
protected booleanfReadingExternalDTD
fReadingExternalDTD
static intTOP_LEVEL_SCOPE
Top level scope (-1).
Constructor Summary
DTDGrammar(SymbolTable symbolTable, XMLDTDDescription desc)
Default constructor.
Method Summary
protected intaddContentSpecNode(short nodeType, String nodeValue)
Create an XMLContentSpec for a single non-leaf
protected intaddContentSpecNode(short nodeType, int leftNodeIndex, int rightNodeIndex)
Create an XMLContentSpec for a two child leaf
protected intaddUniqueLeafNode(String elementName)
create an XMLContentSpec for a leaf
voidany(Augmentations augs)
A content model of ANY.
voidattributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs)
An attribute declaration.
voidcomment(XMLString text, Augmentations augs)
A comment.
protected intcreateAttributeDecl()
protected intcreateContentSpec()
protected intcreateElementDecl()
if ( contentSpecIndex == -1 ) return null; /**
protected intcreateEntityDecl()
protected intcreateNotationDecl()
voidelement(String elementName, Augmentations augs)
A referenced element in a mixed or children content model.
voidelementDecl(String name, String contentModel, Augmentations augs)
An element declaration.
voidempty(Augmentations augs)
A content model of EMPTY.
voidendAttlist(Augmentations augs)
The end of an attribute list.
voidendConditional(Augmentations augs)
The end of a conditional section.
voidendContentModel(Augmentations augs)
The end of a content model.
voidendDTD(Augmentations augs)
The end of the DTD.
voidendExternalSubset(Augmentations augs)
The end of the DTD external subset.
voidendGroup(Augmentations augs)
The end of a group for mixed or children content models.
voidendParameterEntity(String name, Augmentations augs)
This method notifies the end of an entity.
voidexternalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
An external entity declaration.
booleangetAttributeDecl(int attributeDeclIndex, XMLAttributeDecl attributeDecl)
getAttributeDecl
intgetAttributeDeclIndex(int elementDeclIndex, String attributeDeclName)
booleangetAttributeDeclIsExternal(int attributeDeclIndex)
Returns true if the specified attribute declaration is external.
booleangetContentSpec(int contentSpecIndex, XMLContentSpec contentSpec)
getContentSpec
StringgetContentSpecAsString(int elementDeclIndex)
getContentSpecAsString
shortgetContentSpecType(int elementIndex)
make separate function for getting contentSpecType of element. we can avoid setting of the element values.
XMLDTDContentModelSourcegetDTDContentModelSource()
XMLDTDSourcegetDTDSource()
protected ContentModelValidatorgetElementContentModelValidator(int elementDeclIndex)
getElementContentModelValidator
booleangetElementDecl(int elementDeclIndex, XMLElementDecl elementDecl)
getElementDecl
intgetElementDeclIndex(String elementDeclName)
getElementDeclIndex
intgetElementDeclIndex(QName elementDeclQName)
Returns the element decl index.
booleangetElementDeclIsExternal(int elementDeclIndex)
Returns true if the specified element declaration is external.
booleangetEntityDecl(int entityDeclIndex, XMLEntityDecl entityDecl)
getEntityDecl
intgetEntityDeclIndex(String entityDeclName)
getEntityDeclIndex
intgetFirstAttributeDeclIndex(int elementDeclIndex)
getFirstAttributeDeclIndex
intgetFirstElementDeclIndex()
Returns the index of the first element declaration.
XMLGrammarDescriptiongetGrammarDescription()
intgetNextAttributeDeclIndex(int attributeDeclIndex)
getNextAttributeDeclIndex
intgetNextElementDeclIndex(int elementDeclIndex)
Returns the next index of the element declaration following the specified element declaration.
booleangetNotationDecl(int notationDeclIndex, XMLNotationDecl notationDecl)
getNotationDecl
intgetNotationDeclIndex(String notationDeclName)
getNotationDeclIndex
SymbolTablegetSymbolTable()
Returns the symbol table.
voidignoredCharacters(XMLString text, Augmentations augs)
Characters within an IGNORE conditional section.
protected voidinitializeContentModelStack()
Initialize content model stack.
voidinternalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs)
An internal entity declaration.
booleanisCDATAAttribute(QName elName, QName atName)
Returns whether the given attribute is of type CDATA or not
booleanisEntityDeclared(String name)
booleanisEntityUnparsed(String name)
booleanisNamespaceAware()
Returns true if this grammar is namespace aware.
voidnotationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
A notation declaration
voidoccurrence(short occurrence, Augmentations augs)
The occurrence count for a child in a children content model or for the mixed content model group.
voidpcdata(Augmentations augs)
The appearance of "#PCDATA" within a group signifying a mixed content model.
voidprintAttributes(int elementDeclIndex)
voidprintElements()
voidprocessingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction.
protected voidputElementNameMapping(QName name, int scope, int elementDeclIndex)
voidseparator(short separator, Augmentations augs)
The separator between choices or sequences of a mixed or children content model.
protected voidsetAttributeDecl(int elementDeclIndex, int attributeDeclIndex, XMLAttributeDecl attributeDecl)
protected voidsetContentSpec(int contentSpecIndex, XMLContentSpec contentSpec)
protected voidsetContentSpecIndex(int elementDeclIndex, int contentSpecIndex)
voidsetDTDContentModelSource(XMLDTDContentModelSource source)
voidsetDTDSource(XMLDTDSource source)
protected voidsetElementDecl(int elementDeclIndex, XMLElementDecl elementDecl)
protected voidsetEntityDecl(int entityDeclIndex, XMLEntityDecl entityDecl)
protected voidsetFirstAttributeDeclIndex(int elementDeclIndex, int newFirstAttrIndex)
protected voidsetNotationDecl(int notationDeclIndex, XMLNotationDecl notationDecl)
voidstartAttlist(String elementName, Augmentations augs)
The start of an attribute list.
voidstartConditional(short type, Augmentations augs)
The start of a conditional section.
voidstartContentModel(String elementName, Augmentations augs)
The start of a content model.
voidstartDTD(XMLLocator locator, Augmentations augs)
The start of the DTD.
voidstartExternalSubset(XMLResourceIdentifier identifier, Augmentations augs)
The start of the DTD external subset.
voidstartGroup(Augmentations augs)
A start of either a mixed or children content model.
voidstartParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies of the start of an entity.
voidtextDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
voidunparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs)
An unparsed entity declaration.

Field Detail

fAttributeDecl

protected XMLAttributeDecl fAttributeDecl
Temporary Attribute decl.

fCurrentAttributeIndex

protected int fCurrentAttributeIndex
Current attribute index.

fCurrentElementIndex

protected int fCurrentElementIndex
Current element index.

fDTDContentModelSource

protected XMLDTDContentModelSource fDTDContentModelSource

fDTDSource

protected XMLDTDSource fDTDSource

fGrammarDescription

protected XMLDTDDescription fGrammarDescription

fReadingExternalDTD

protected boolean fReadingExternalDTD
fReadingExternalDTD

TOP_LEVEL_SCOPE

public static final int TOP_LEVEL_SCOPE
Top level scope (-1).

Constructor Detail

DTDGrammar

public DTDGrammar(SymbolTable symbolTable, XMLDTDDescription desc)
Default constructor.

Method Detail

addContentSpecNode

protected int addContentSpecNode(short nodeType, String nodeValue)
Create an XMLContentSpec for a single non-leaf

Parameters: nodeType the type of XMLContentSpec to create - from XMLContentSpec.CONTENTSPECNODE_* nodeValue handle to an XMLContentSpec

Returns: handle to the newly create XMLContentSpec

addContentSpecNode

protected int addContentSpecNode(short nodeType, int leftNodeIndex, int rightNodeIndex)
Create an XMLContentSpec for a two child leaf

Parameters: nodeType the type of XMLContentSpec to create - from XMLContentSpec.CONTENTSPECNODE_* leftNodeIndex handle to an XMLContentSpec rightNodeIndex handle to an XMLContentSpec

Returns: handle to the newly create XMLContentSpec

addUniqueLeafNode

protected int addUniqueLeafNode(String elementName)
create an XMLContentSpec for a leaf

Parameters: elementName the name (Element) for the node

Returns: handle to the newly create XMLContentSpec

any

public void any(Augmentations augs)
A content model of ANY.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: DTDGrammar DTDGrammar

attributeDecl

public void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs)
An attribute declaration.

Parameters: elementName The name of the element that this attribute is associated with. attributeName The name of the attribute. type The attribute type. This value will be one of the following: "CDATA", "ENTITY", "ENTITIES", "ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION". enumeration If the type has the value "ENUMERATION", this array holds the allowed attribute values; otherwise, this array is null. defaultType The attribute default type. This value will be one of the following: "#FIXED", "#IMPLIED", "#REQUIRED", or null. defaultValue The attribute default value, or null if no default value is specified. nonNormalizedDefaultValue The attribute default value with no normalization performed, or null if no default value is specified. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

comment

public void comment(XMLString text, Augmentations augs)
A comment.

Parameters: text The text in the comment. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by application to signal an error.

createAttributeDecl

protected int createAttributeDecl()

createContentSpec

protected int createContentSpec()

createElementDecl

protected int createElementDecl()
if ( contentSpecIndex == -1 ) return null; /**

createEntityDecl

protected int createEntityDecl()

createNotationDecl

protected int createNotationDecl()

element

public void element(String elementName, Augmentations augs)
A referenced element in a mixed or children content model.

Parameters: elementName The name of the referenced element. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

elementDecl

public void elementDecl(String name, String contentModel, Augmentations augs)
An element declaration.

Parameters: name The name of the element. contentModel The element content model. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

empty

public void empty(Augmentations augs)
A content model of EMPTY.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: DTDGrammar DTDGrammar

endAttlist

public void endAttlist(Augmentations augs)
The end of an attribute list.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endConditional

public void endConditional(Augmentations augs)
The end of a conditional section.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endContentModel

public void endContentModel(Augmentations augs)
The end of a content model.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endDTD

public void endDTD(Augmentations augs)
The end of the DTD.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endExternalSubset

public void endExternalSubset(Augmentations augs)
The end of the DTD external subset.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endGroup

public void endGroup(Augmentations augs)
The end of a group for mixed or children content models.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

endParameterEntity

public void endParameterEntity(String name, Augmentations augs)
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.

Parameters: name The name of the entity. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

externalEntityDecl

public void externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
An external entity declaration.

Parameters: name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name. identifier An object containing all location information pertinent to this external entity declaration. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

getAttributeDecl

public boolean getAttributeDecl(int attributeDeclIndex, XMLAttributeDecl attributeDecl)
getAttributeDecl

Parameters: attributeDeclIndex attributeDecl The values of this structure are set by this call.

Returns: true if getAttributeDecl was able to fill in the value of attributeDecl

getAttributeDeclIndex

public int getAttributeDeclIndex(int elementDeclIndex, String attributeDeclName)

getAttributeDeclIsExternal

public boolean getAttributeDeclIsExternal(int attributeDeclIndex)
Returns true if the specified attribute declaration is external.

Parameters: attributeDeclIndex Attribute declaration index.

getContentSpec

public boolean getContentSpec(int contentSpecIndex, XMLContentSpec contentSpec)
getContentSpec

Parameters: contentSpecIndex contentSpec

Returns: true if find the requested contentSpec node, false otherwise

getContentSpecAsString

public String getContentSpecAsString(int elementDeclIndex)
getContentSpecAsString

Parameters: elementDeclIndex

Returns: String

getContentSpecType

public short getContentSpecType(int elementIndex)
make separate function for getting contentSpecType of element. we can avoid setting of the element values.

getDTDContentModelSource

public XMLDTDContentModelSource getDTDContentModelSource()

getDTDSource

public XMLDTDSource getDTDSource()

getElementContentModelValidator

protected ContentModelValidator getElementContentModelValidator(int elementDeclIndex)
getElementContentModelValidator

Parameters: elementDeclIndex

Returns: its ContentModelValidator if any.

getElementDecl

public boolean getElementDecl(int elementDeclIndex, XMLElementDecl elementDecl)
getElementDecl

Parameters: elementDeclIndex elementDecl The values of this structure are set by this call.

Returns: True if find the element, False otherwise.

getElementDeclIndex

public int getElementDeclIndex(String elementDeclName)
getElementDeclIndex

Parameters: elementDeclName

Returns: index of the elementDeclName in scope

getElementDeclIndex

public int getElementDeclIndex(QName elementDeclQName)
Returns the element decl index.

Parameters: elementDeclQName qualilfied name of the element

getElementDeclIsExternal

public boolean getElementDeclIsExternal(int elementDeclIndex)
Returns true if the specified element declaration is external.

Parameters: elementDeclIndex The element declaration index.

getEntityDecl

public boolean getEntityDecl(int entityDeclIndex, XMLEntityDecl entityDecl)
getEntityDecl

Parameters: entityDeclIndex entityDecl

Returns: true if getEntityDecl was able to fill entityDecl with the contents of the entity with index entityDeclIndex

getEntityDeclIndex

public int getEntityDeclIndex(String entityDeclName)
getEntityDeclIndex

Parameters: entityDeclName

Returns: the index of the EntityDecl

getFirstAttributeDeclIndex

public int getFirstAttributeDeclIndex(int elementDeclIndex)
getFirstAttributeDeclIndex

Parameters: elementDeclIndex

Returns: index of the first attribute for element declaration elementDeclIndex

getFirstElementDeclIndex

public int getFirstElementDeclIndex()
Returns the index of the first element declaration. This index is then used to query more information about the element declaration.

See Also: DTDGrammar DTDGrammar

getGrammarDescription

public XMLGrammarDescription getGrammarDescription()

getNextAttributeDeclIndex

public int getNextAttributeDeclIndex(int attributeDeclIndex)
getNextAttributeDeclIndex

Parameters: attributeDeclIndex

Returns: index of the next attribute of the attribute at attributeDeclIndex

getNextElementDeclIndex

public int getNextElementDeclIndex(int elementDeclIndex)
Returns the next index of the element declaration following the specified element declaration.

Parameters: elementDeclIndex The element declaration index.

getNotationDecl

public boolean getNotationDecl(int notationDeclIndex, XMLNotationDecl notationDecl)
getNotationDecl

Parameters: notationDeclIndex notationDecl

Returns: return true of getNotationDecl can fill notationDecl with information about the notation at notationDeclIndex.

getNotationDeclIndex

public int getNotationDeclIndex(String notationDeclName)
getNotationDeclIndex

Parameters: notationDeclName

Returns: the index if found a notation with the name, otherwise -1.

getSymbolTable

public SymbolTable getSymbolTable()
Returns the symbol table.

ignoredCharacters

public void ignoredCharacters(XMLString text, Augmentations augs)
Characters within an IGNORE conditional section.

Parameters: text The ignored text. augs Additional information that may include infoset augmentations.

initializeContentModelStack

protected void initializeContentModelStack()
Initialize content model stack.

internalEntityDecl

public void internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs)
An internal entity declaration.

Parameters: name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name. text The value of the entity. 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. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

isCDATAAttribute

public boolean isCDATAAttribute(QName elName, QName atName)
Returns whether the given attribute is of type CDATA or not

Parameters: elName The element name. atName The attribute name.

Returns: true if the attribute is of type CDATA

isEntityDeclared

public boolean isEntityDeclared(String name)

isEntityUnparsed

public boolean isEntityUnparsed(String name)

isNamespaceAware

public boolean isNamespaceAware()
Returns true if this grammar is namespace aware.

notationDecl

public void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
A notation declaration

Parameters: name The name of the notation. identifier An object containing all location information pertinent to this notation. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

occurrence

public void occurrence(short occurrence, Augmentations augs)
The occurrence count for a child in a children content model or for the mixed content model group.

Parameters: occurrence The occurrence count for the last element or group. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: org.apache.xerces.xni.XMLDTDContentModelHandler#OCCURS_ZERO_OR_ONE org.apache.xerces.xni.XMLDTDContentModelHandler#OCCURS_ZERO_OR_MORE org.apache.xerces.xni.XMLDTDContentModelHandler#OCCURS_ONE_OR_MORE

pcdata

public void pcdata(Augmentations augs)
The appearance of "#PCDATA" within a group signifying a mixed content model. This method will be the first called following the content model's startGroup().

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: DTDGrammar

printAttributes

public void printAttributes(int elementDeclIndex)

printElements

public void printElements()

processingInstruction

public void processingInstruction(String target, XMLString data, Augmentations augs)
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.

Parameters: target The target. data The data or null if none specified. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

putElementNameMapping

protected void putElementNameMapping(QName name, int scope, int elementDeclIndex)

separator

public void separator(short separator, Augmentations augs)
The separator between choices or sequences of a mixed or children content model.

Parameters: separator The type of children separator. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: org.apache.xerces.xni.XMLDTDContentModelHandler#SEPARATOR_CHOICE org.apache.xerces.xni.XMLDTDContentModelHandler#SEPARATOR_SEQUENCE

setAttributeDecl

protected void setAttributeDecl(int elementDeclIndex, int attributeDeclIndex, XMLAttributeDecl attributeDecl)

setContentSpec

protected void setContentSpec(int contentSpecIndex, XMLContentSpec contentSpec)

setContentSpecIndex

protected void setContentSpecIndex(int elementDeclIndex, int contentSpecIndex)

setDTDContentModelSource

public void setDTDContentModelSource(XMLDTDContentModelSource source)

setDTDSource

public void setDTDSource(XMLDTDSource source)

setElementDecl

protected void setElementDecl(int elementDeclIndex, XMLElementDecl elementDecl)

setEntityDecl

protected void setEntityDecl(int entityDeclIndex, XMLEntityDecl entityDecl)

setFirstAttributeDeclIndex

protected void setFirstAttributeDeclIndex(int elementDeclIndex, int newFirstAttrIndex)

setNotationDecl

protected void setNotationDecl(int notationDeclIndex, XMLNotationDecl notationDecl)

startAttlist

public void startAttlist(String elementName, Augmentations augs)
The start of an attribute list.

Parameters: elementName The name of the element that this attribute list is associated with. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

startConditional

public void startConditional(short type, Augmentations augs)
The start of a conditional section.

Parameters: type The type of the conditional section. This value will either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: XMLDTDHandler#CONDITIONAL_INCLUDE XMLDTDHandler#CONDITIONAL_IGNORE

startContentModel

public void startContentModel(String elementName, Augmentations augs)
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.

Parameters: elementName The name of the element. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

startDTD

public void startDTD(XMLLocator locator, Augmentations augs)
The start of the DTD.

Parameters: locator The document locator, or null if the document location cannot be reported during the parsing of the document DTD. However, it is strongly recommended that a locator be supplied that can at least report the base system identifier of the DTD. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

startExternalSubset

public void startExternalSubset(XMLResourceIdentifier identifier, Augmentations augs)
The start of the DTD external subset.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

startGroup

public void startGroup(Augmentations augs)
A start of either a mixed or children content model. A mixed content model will immediately be followed by a call to the pcdata() method. A children content model will contain additional groups and/or elements.

Parameters: augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

See Also: DTDGrammar DTDGrammar

startParameterEntity

public void startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
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 startParameterEntity method with the entity name "[dtd]" before calling the startDTD method.

Parameters: name The name of the parameter 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 parameter entities). augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

textDecl

public void textDecl(String version, String encoding, Augmentations augs)
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.

Parameters: version The XML version, or null if not specified. encoding The IANA encoding name of the entity. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

unparsedEntityDecl

public void unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs)
An unparsed entity declaration.

Parameters: name The name of the entity. identifier An object containing all location information pertinent to this entity. notation The name of the notation. augs Additional information that may include infoset augmentations.

Throws: XNIException Thrown by handler to signal an error.

Copyright © 1999-2005 Apache XML Project. All Rights Reserved.