Class DTDGrammar
- All Implemented Interfaces:
EntityState
,org.apache.xerces.xni.grammars.Grammar
,org.apache.xerces.xni.XMLDTDContentModelHandler
,org.apache.xerces.xni.XMLDTDHandler
INTERNAL:
- Usage of this class is not supported. It may be altered or removed at any time.
- Version:
- $Id: DTDGrammar.java 1357390 2012-07-04 20:20:20Z mrglavas $
- Author:
- Eric Ye, IBM, Jeffrey Rodriguez, IBM, Andy Clark, IBM, Neil Graham, IBM
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static final class
A simple Hashtable implementation that takes a tuple (String, String) as the key and a int as value. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final XMLAttributeDecl
Temporary Attribute decl.protected int
Current attribute index.protected int
Current element index.protected org.apache.xerces.xni.parser.XMLDTDContentModelSource
protected org.apache.xerces.xni.parser.XMLDTDSource
protected XMLDTDDescription
protected boolean
fReadingExternalDTDstatic final int
Top level scope (-1).Fields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler
OCCURS_ONE_OR_MORE, OCCURS_ZERO_OR_MORE, OCCURS_ZERO_OR_ONE, SEPARATOR_CHOICE, SEPARATOR_SEQUENCE
Fields inherited from interface org.apache.xerces.xni.XMLDTDHandler
CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE
-
Constructor Summary
ConstructorsConstructorDescriptionDTDGrammar
(SymbolTable symbolTable, XMLDTDDescription desc) Default constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected int
addContentSpecNode
(short nodeType, int leftNodeIndex, int rightNodeIndex) Create an XMLContentSpec for a two child leafprotected int
addContentSpecNode
(short nodeType, String nodeValue) Create an XMLContentSpec for a single non-leafprotected void
addContentSpecToElement
(XMLElementDecl elementDecl) Adds the content spec to the given element declaration.protected int
addUniqueLeafNode
(String elementName) create an XMLContentSpec for a leafvoid
any
(org.apache.xerces.xni.Augmentations augs) A content model of ANY.void
attributeDecl
(String elementName, String attributeName, String type, String[] enumeration, String defaultType, org.apache.xerces.xni.XMLString defaultValue, org.apache.xerces.xni.XMLString nonNormalizedDefaultValue, org.apache.xerces.xni.Augmentations augs) An attribute declaration.void
comment
(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) A comment.protected int
protected int
protected int
protected int
protected int
void
A referenced element in a mixed or children content model.void
elementDecl
(String name, String contentModel, org.apache.xerces.xni.Augmentations augs) An element declaration.void
empty
(org.apache.xerces.xni.Augmentations augs) A content model of EMPTY.void
endAttlist
(org.apache.xerces.xni.Augmentations augs) The end of an attribute list.void
endConditional
(org.apache.xerces.xni.Augmentations augs) The end of a conditional section.void
endContentModel
(org.apache.xerces.xni.Augmentations augs) The end of a content model.void
endDTD
(org.apache.xerces.xni.Augmentations augs) The end of the DTD.void
endExternalSubset
(org.apache.xerces.xni.Augmentations augs) The end of the DTD external subset.void
endGroup
(org.apache.xerces.xni.Augmentations augs) The end of a group for mixed or children content models.void
endParameterEntity
(String name, org.apache.xerces.xni.Augmentations augs) This method notifies the end of an entity.void
externalEntityDecl
(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) An external entity declaration.boolean
getAttributeDecl
(int attributeDeclIndex, XMLAttributeDecl attributeDecl) getAttributeDeclint
getAttributeDeclIndex
(int elementDeclIndex, String attributeDeclName) boolean
getAttributeDeclIsExternal
(int attributeDeclIndex) Returns true if the specified attribute declaration is external.boolean
getContentSpec
(int contentSpecIndex, XMLContentSpec contentSpec) getContentSpecgetContentSpecAsString
(int elementDeclIndex) getContentSpecAsStringint
getContentSpecIndex
(int elementDeclIndex) Returns the index to the content spec for the given element declaration, or-1
if the element declaration index was invalid.short
getContentSpecType
(int elementIndex) make separate function for getting contentSpecType of element.org.apache.xerces.xni.parser.XMLDTDContentModelSource
org.apache.xerces.xni.parser.XMLDTDSource
protected ContentModelValidator
getElementContentModelValidator
(int elementDeclIndex) getElementContentModelValidatorboolean
getElementDecl
(int elementDeclIndex, XMLElementDecl elementDecl) getElementDeclint
getElementDeclIndex
(String elementDeclName) getElementDeclIndexint
getElementDeclIndex
(org.apache.xerces.xni.QName elementDeclQName) Returns the element decl index.boolean
getElementDeclIsExternal
(int elementDeclIndex) Returns true if the specified element declaration is external.boolean
getEntityDecl
(int entityDeclIndex, XMLEntityDecl entityDecl) getEntityDeclint
getEntityDeclIndex
(String entityDeclName) getEntityDeclIndexint
getFirstAttributeDeclIndex
(int elementDeclIndex) getFirstAttributeDeclIndexint
Returns the index of the first element declaration.org.apache.xerces.xni.grammars.XMLGrammarDescription
get theXMLGrammarDescription
associated with this objectint
getNextAttributeDeclIndex
(int attributeDeclIndex) getNextAttributeDeclIndexint
getNextElementDeclIndex
(int elementDeclIndex) Returns the next index of the element declaration following the specified element declaration.boolean
getNotationDecl
(int notationDeclIndex, XMLNotationDecl notationDecl) getNotationDeclint
getNotationDeclIndex
(String notationDeclName) getNotationDeclIndexReturns the symbol table.void
ignoredCharacters
(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) Characters within an IGNORE conditional section.protected void
Initialize content model stack.void
internalEntityDecl
(String name, org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.XMLString nonNormalizedText, org.apache.xerces.xni.Augmentations augs) An internal entity declaration.boolean
isCDATAAttribute
(org.apache.xerces.xni.QName elName, org.apache.xerces.xni.QName atName) Returns whether the given attribute is of type CDATA or notboolean
isEntityDeclared
(String name) Query method to check if entity with this name was declared.boolean
isEntityUnparsed
(String name) Query method to check if entity is unparsed.boolean
Returns true if this grammar is namespace aware.void
notationDecl
(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) A notation declarationvoid
occurrence
(short occurrence, org.apache.xerces.xni.Augmentations augs) The occurrence count for a child in a children content model or for the mixed content model group.void
pcdata
(org.apache.xerces.xni.Augmentations augs) The appearance of "#PCDATA" within a group signifying a mixed content model.void
printAttributes
(int elementDeclIndex) void
void
processingInstruction
(String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.Augmentations augs) A processing instruction.protected void
putElementNameMapping
(org.apache.xerces.xni.QName name, int scope, int elementDeclIndex) void
separator
(short separator, org.apache.xerces.xni.Augmentations augs) The separator between choices or sequences of a mixed or children content model.protected void
setAttributeDecl
(int elementDeclIndex, int attributeDeclIndex, XMLAttributeDecl attributeDecl) protected void
setContentSpec
(int contentSpecIndex, XMLContentSpec contentSpec) protected void
setContentSpecIndex
(int elementDeclIndex, int contentSpecIndex) void
setDTDContentModelSource
(org.apache.xerces.xni.parser.XMLDTDContentModelSource source) void
setDTDSource
(org.apache.xerces.xni.parser.XMLDTDSource source) protected void
setElementDecl
(int elementDeclIndex, XMLElementDecl elementDecl) protected void
setEntityDecl
(int entityDeclIndex, XMLEntityDecl entityDecl) protected void
setFirstAttributeDeclIndex
(int elementDeclIndex, int newFirstAttrIndex) protected void
setNotationDecl
(int notationDeclIndex, XMLNotationDecl notationDecl) void
startAttlist
(String elementName, org.apache.xerces.xni.Augmentations augs) The start of an attribute list.void
startConditional
(short type, org.apache.xerces.xni.Augmentations augs) The start of a conditional section.void
startContentModel
(String elementName, org.apache.xerces.xni.Augmentations augs) The start of a content model.void
startDTD
(org.apache.xerces.xni.XMLLocator locator, org.apache.xerces.xni.Augmentations augs) The start of the DTD.void
startExternalSubset
(org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) The start of the DTD external subset.void
startGroup
(org.apache.xerces.xni.Augmentations augs) A start of either a mixed or children content model.void
startParameterEntity
(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding, org.apache.xerces.xni.Augmentations augs) This method notifies of the start of an entity.void
Notifies of the presence of a TextDecl line in an entity.void
unparsedEntityDecl
(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String notation, org.apache.xerces.xni.Augmentations augs) An unparsed entity declaration.
-
Field Details
-
TOP_LEVEL_SCOPE
public static final int TOP_LEVEL_SCOPETop level scope (-1).- See Also:
-
fDTDSource
protected org.apache.xerces.xni.parser.XMLDTDSource fDTDSource -
fDTDContentModelSource
protected org.apache.xerces.xni.parser.XMLDTDContentModelSource fDTDContentModelSource -
fCurrentElementIndex
protected int fCurrentElementIndexCurrent element index. -
fCurrentAttributeIndex
protected int fCurrentAttributeIndexCurrent attribute index. -
fReadingExternalDTD
protected boolean fReadingExternalDTDfReadingExternalDTD -
fGrammarDescription
-
fAttributeDecl
Temporary Attribute decl.
-
-
Constructor Details
-
DTDGrammar
Default constructor.
-
-
Method Details
-
getGrammarDescription
public org.apache.xerces.xni.grammars.XMLGrammarDescription getGrammarDescription()Description copied from interface:org.apache.xerces.xni.grammars.Grammar
get theXMLGrammarDescription
associated with this object- Specified by:
getGrammarDescription
in interfaceorg.apache.xerces.xni.grammars.Grammar
-
getElementDeclIsExternal
public boolean getElementDeclIsExternal(int elementDeclIndex) Returns true if the specified element declaration is external.- Parameters:
elementDeclIndex
- The element declaration index.
-
getAttributeDeclIsExternal
public boolean getAttributeDeclIsExternal(int attributeDeclIndex) Returns true if the specified attribute declaration is external.- Parameters:
attributeDeclIndex
- Attribute declaration index.
-
getAttributeDeclIndex
-
startDTD
public void startDTD(org.apache.xerces.xni.XMLLocator locator, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The start of the DTD.- Specified by:
startDTD
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
startParameterEntity
public void startParameterEntity(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String encoding, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException 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.
- Specified by:
startParameterEntity
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
startExternalSubset
public void startExternalSubset(org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The start of the DTD external subset.- Specified by:
startExternalSubset
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
identifier
- The resource identifier.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
endParameterEntity
public void endParameterEntity(String name, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException 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.
- Specified by:
endParameterEntity
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
name
- The name of the entity.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
endExternalSubset
public void endExternalSubset(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of the DTD external subset.- Specified by:
endExternalSubset
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
elementDecl
public void elementDecl(String name, String contentModel, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException An element declaration.- Specified by:
elementDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
name
- The name of the element.contentModel
- The element content model.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
attributeDecl
public void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, org.apache.xerces.xni.XMLString defaultValue, org.apache.xerces.xni.XMLString nonNormalizedDefaultValue, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException An attribute declaration.- Specified by:
attributeDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
internalEntityDecl
public void internalEntityDecl(String name, org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.XMLString nonNormalizedText, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException An internal entity declaration.- Specified by:
internalEntityDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
externalEntityDecl
public void externalEntityDecl(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException An external entity declaration.- Specified by:
externalEntityDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
unparsedEntityDecl
public void unparsedEntityDecl(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, String notation, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException An unparsed entity declaration.- Specified by:
unparsedEntityDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
notationDecl
public void notationDecl(String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException A notation declaration- Specified by:
notationDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
endDTD
public void endDTD(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of the DTD.- Specified by:
endDTD
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
setDTDSource
public void setDTDSource(org.apache.xerces.xni.parser.XMLDTDSource source) - Specified by:
setDTDSource
in interfaceorg.apache.xerces.xni.XMLDTDHandler
-
getDTDSource
public org.apache.xerces.xni.parser.XMLDTDSource getDTDSource()- Specified by:
getDTDSource
in interfaceorg.apache.xerces.xni.XMLDTDHandler
-
textDecl
public void textDecl(String version, String encoding, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException 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.
- Specified by:
textDecl
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
comment
public void comment(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException A comment.- Specified by:
comment
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
text
- The text in the comment.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by application to signal an error.
-
processingInstruction
public void processingInstruction(String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException 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.
- Specified by:
processingInstruction
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
target
- The target.data
- The data or null if none specified.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
startAttlist
public void startAttlist(String elementName, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The start of an attribute list.- Specified by:
startAttlist
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
elementName
- The name of the element that this attribute list is associated with.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
endAttlist
public void endAttlist(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of an attribute list.- Specified by:
endAttlist
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
startConditional
public void startConditional(short type, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The start of a conditional section.- Specified by:
startConditional
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- 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:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
ignoredCharacters
public void ignoredCharacters(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException Characters within an IGNORE conditional section.- Specified by:
ignoredCharacters
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
text
- The ignored text.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
endConditional
public void endConditional(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of a conditional section.- Specified by:
endConditional
in interfaceorg.apache.xerces.xni.XMLDTDHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
setDTDContentModelSource
public void setDTDContentModelSource(org.apache.xerces.xni.parser.XMLDTDContentModelSource source) - Specified by:
setDTDContentModelSource
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
-
getDTDContentModelSource
public org.apache.xerces.xni.parser.XMLDTDContentModelSource getDTDContentModelSource()- Specified by:
getDTDContentModelSource
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
-
startContentModel
public void startContentModel(String elementName, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException 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.- Specified by:
startContentModel
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
elementName
- The name of the element.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
startGroup
public void startGroup(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException A start of either a mixed or children content model. A mixed content model will immediately be followed by a call to thepcdata()
method. A children content model will contain additional groups and/or elements.- Specified by:
startGroup
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
pcdata
public void pcdata(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The appearance of "#PCDATA" within a group signifying a mixed content model. This method will be the first called following the content model'sstartGroup()
.- Specified by:
pcdata
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
element
public void element(String elementName, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException A referenced element in a mixed or children content model.- Specified by:
element
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
elementName
- The name of the referenced element.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
separator
public void separator(short separator, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The separator between choices or sequences of a mixed or children content model.- Specified by:
separator
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
separator
- The type of children separator.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
occurrence
public void occurrence(short occurrence, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The occurrence count for a child in a children content model or for the mixed content model group.- Specified by:
occurrence
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
occurrence
- The occurrence count for the last element or group.augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
endGroup
public void endGroup(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of a group for mixed or children content models.- Specified by:
endGroup
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
any
public void any(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException A content model of ANY.- Specified by:
any
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
empty
public void empty(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException A content model of EMPTY.- Specified by:
empty
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.- See Also:
-
endContentModel
public void endContentModel(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException The end of a content model.- Specified by:
endContentModel
in interfaceorg.apache.xerces.xni.XMLDTDContentModelHandler
- Parameters:
augs
- Additional information that may include infoset augmentations.- Throws:
org.apache.xerces.xni.XNIException
- Thrown by handler to signal an error.
-
isNamespaceAware
public boolean isNamespaceAware()Returns true if this grammar is namespace aware. -
getSymbolTable
Returns the symbol table. -
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:
-
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.
-
getElementDeclIndex
getElementDeclIndex- Parameters:
elementDeclName
-- Returns:
- index of the elementDeclName in scope
-
getElementDeclIndex
public int getElementDeclIndex(org.apache.xerces.xni.QName elementDeclQName) Returns the element decl index.- Parameters:
elementDeclQName
- qualilfied name of the element
-
getContentSpecType
public short getContentSpecType(int elementIndex) make separate function for getting contentSpecType of element. we can avoid setting of the element values. -
getElementDecl
getElementDecl- Parameters:
elementDeclIndex
-elementDecl
- The values of this structure are set by this call.- Returns:
- True if find the element, False otherwise.
-
getFirstAttributeDeclIndex
public int getFirstAttributeDeclIndex(int elementDeclIndex) getFirstAttributeDeclIndex- Parameters:
elementDeclIndex
-- Returns:
- index of the first attribute for element declaration elementDeclIndex
-
getNextAttributeDeclIndex
public int getNextAttributeDeclIndex(int attributeDeclIndex) getNextAttributeDeclIndex- Parameters:
attributeDeclIndex
-- Returns:
- index of the next attribute of the attribute at attributeDeclIndex
-
getAttributeDecl
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
-
isCDATAAttribute
public boolean isCDATAAttribute(org.apache.xerces.xni.QName elName, org.apache.xerces.xni.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
-
getEntityDeclIndex
getEntityDeclIndex- Parameters:
entityDeclName
-- Returns:
- the index of the EntityDecl
-
getEntityDecl
getEntityDecl- Parameters:
entityDeclIndex
-entityDecl
-- Returns:
- true if getEntityDecl was able to fill entityDecl with the contents of the entity with index entityDeclIndex
-
getNotationDeclIndex
getNotationDeclIndex- Parameters:
notationDeclName
-- Returns:
- the index if found a notation with the name, otherwise -1.
-
getNotationDecl
getNotationDecl- Parameters:
notationDeclIndex
-notationDecl
-- Returns:
- return true of getNotationDecl can fill notationDecl with information about the notation at notationDeclIndex.
-
getContentSpec
getContentSpec- Parameters:
contentSpecIndex
-contentSpec
-- Returns:
- true if find the requested contentSpec node, false otherwise
-
getContentSpecIndex
public int getContentSpecIndex(int elementDeclIndex) Returns the index to the content spec for the given element declaration, or-1
if the element declaration index was invalid. -
getContentSpecAsString
getContentSpecAsString- Parameters:
elementDeclIndex
-- Returns:
- String
-
printElements
public void printElements() -
printAttributes
public void printAttributes(int elementDeclIndex) -
addContentSpecToElement
Adds the content spec to the given element declaration. -
getElementContentModelValidator
getElementContentModelValidator- Parameters:
elementDeclIndex
-- Returns:
- its ContentModelValidator if any.
-
createElementDecl
protected int createElementDecl() -
setElementDecl
-
putElementNameMapping
protected void putElementNameMapping(org.apache.xerces.xni.QName name, int scope, int elementDeclIndex) -
setFirstAttributeDeclIndex
protected void setFirstAttributeDeclIndex(int elementDeclIndex, int newFirstAttrIndex) -
setContentSpecIndex
protected void setContentSpecIndex(int elementDeclIndex, int contentSpecIndex) -
createAttributeDecl
protected int createAttributeDecl() -
setAttributeDecl
protected void setAttributeDecl(int elementDeclIndex, int attributeDeclIndex, XMLAttributeDecl attributeDecl) -
createContentSpec
protected int createContentSpec() -
setContentSpec
-
createEntityDecl
protected int createEntityDecl() -
setEntityDecl
-
createNotationDecl
protected int createNotationDecl() -
setNotationDecl
-
addContentSpecNode
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
-
addUniqueLeafNode
create an XMLContentSpec for a leaf- Parameters:
elementName
- the name (Element) for the node- 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 XMLContentSpecrightNodeIndex
- handle to an XMLContentSpec- Returns:
- handle to the newly create XMLContentSpec
-
initializeContentModelStack
protected void initializeContentModelStack()Initialize content model stack. -
isEntityDeclared
Description copied from interface:EntityState
Query method to check if entity with this name was declared.- Specified by:
isEntityDeclared
in interfaceEntityState
- Parameters:
name
-- Returns:
- true if name is a declared entity
-
isEntityUnparsed
Description copied from interface:EntityState
Query method to check if entity is unparsed.- Specified by:
isEntityUnparsed
in interfaceEntityState
- Parameters:
name
-- Returns:
- true if name is an unparsed entity
-