public class XMLDTDProcessor extends Object implements XMLComponent, XMLDTDFilter, XMLDTDContentModelFilter
This component requires the following features and properties from the component manager that uses it:
Modifier and Type | Field and Description |
---|---|
protected static String |
DTD_VALIDATOR
Property identifier: validator .
|
protected static String |
ERROR_REPORTER
Property identifier: error reporter.
|
protected XMLDTDContentModelHandler |
fDTDContentModelHandler
DTD content model handler.
|
protected XMLDTDContentModelSource |
fDTDContentModelSource
DTD content model source.
|
protected DTDGrammar |
fDTDGrammar
DTD Grammar.
|
protected XMLDTDHandler |
fDTDHandler
DTD handler.
|
protected XMLDTDSource |
fDTDSource
DTD source.
|
protected boolean |
fDTDValidation
Validation against only DTD
|
protected XMLErrorReporter |
fErrorReporter
Error reporter.
|
protected DTDGrammarBucket |
fGrammarBucket
Grammar bucket.
|
protected XMLGrammarPool |
fGrammarPool |
protected boolean |
fInDTDIgnore
True if in an ignore conditional section of the DTD.
|
protected Locale |
fLocale |
protected SymbolTable |
fSymbolTable
Symbol table.
|
protected boolean |
fValidation
Validation.
|
protected XMLDTDValidator |
fValidator |
protected boolean |
fWarnDuplicateAttdef
warn on duplicate attribute definition, this feature works only when validation is true
|
protected boolean |
fWarnOnUndeclaredElemdef
warn on undeclared element referenced in content model, this feature only works when valiation is true
|
protected static String |
GRAMMAR_POOL
Property identifier: grammar pool.
|
protected static String |
NOTIFY_CHAR_REFS
Feature identifier: notify character references.
|
protected static String |
PARSER_SETTINGS |
protected static String |
SYMBOL_TABLE
Property identifier: symbol table.
|
protected static String |
VALIDATION
Feature identifier: validation.
|
protected static String |
WARN_ON_DUPLICATE_ATTDEF
Feature identifier: warn on duplicate attdef
|
protected static String |
WARN_ON_UNDECLARED_ELEMDEF
Feature identifier: warn on undeclared element referenced in content model.
|
CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE
OCCURS_ONE_OR_MORE, OCCURS_ZERO_OR_MORE, OCCURS_ZERO_OR_ONE, SEPARATOR_CHOICE, SEPARATOR_SEQUENCE
Constructor and Description |
---|
XMLDTDProcessor()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
any(Augmentations augs)
A content model of ANY.
|
void |
attributeDecl(String elementName,
String attributeName,
String type,
String[] enumeration,
String defaultType,
XMLString defaultValue,
XMLString nonNormalizedDefaultValue,
Augmentations augs)
An attribute declaration.
|
protected static void |
checkStandaloneEntityRef(String name,
DTDGrammar grammar,
XMLEntityDecl tempEntityDecl,
XMLErrorReporter errorReporter)
Check standalone entity reference.
|
void |
comment(XMLString text,
Augmentations augs)
A comment.
|
void |
element(String elementName,
Augmentations augs)
A referenced element in a mixed or children content model.
|
void |
elementDecl(String name,
String contentModel,
Augmentations augs)
An element declaration.
|
void |
empty(Augmentations augs)
A content model of EMPTY.
|
void |
endAttlist(Augmentations augs)
The end of an attribute list.
|
void |
endConditional(Augmentations augs)
The end of a conditional section.
|
void |
endContentModel(Augmentations augs)
The end of a content model.
|
void |
endDTD(Augmentations augs)
The end of the DTD.
|
void |
endExternalSubset(Augmentations augs)
The end of the DTD external subset.
|
void |
endGroup(Augmentations augs)
The end of a group for mixed or children content models.
|
void |
endParameterEntity(String name,
Augmentations augs)
This method notifies the end of a parameter entity.
|
void |
externalEntityDecl(String name,
XMLResourceIdentifier identifier,
Augmentations augs)
An external entity declaration.
|
XMLDTDContentModelHandler |
getDTDContentModelHandler()
Gets the DTD content model handler.
|
XMLDTDContentModelSource |
getDTDContentModelSource() |
XMLDTDHandler |
getDTDHandler()
Returns the DTD handler.
|
XMLDTDSource |
getDTDSource() |
Boolean |
getFeatureDefault(String featureId)
Returns the default state for a feature, or null if this
component does not want to report a default value for this
feature.
|
Object |
getPropertyDefault(String propertyId)
Returns the default state for a property, or null if this
component does not want to report a default value for this
property.
|
String[] |
getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by
this component.
|
String[] |
getRecognizedProperties()
Returns a list of property identifiers that are recognized by
this component.
|
void |
ignoredCharacters(XMLString text,
Augmentations augs)
Characters within an IGNORE conditional section.
|
void |
internalEntityDecl(String name,
XMLString text,
XMLString nonNormalizedText,
Augmentations augs)
An internal entity declaration.
|
protected boolean |
isValidName(String name) |
protected boolean |
isValidNmtoken(String nmtoken) |
void |
notationDecl(String name,
XMLResourceIdentifier identifier,
Augmentations augs)
A notation declaration
|
void |
occurrence(short occurrence,
Augmentations augs)
The occurrence count for a child in a children content model or
for the mixed content model group.
|
void |
pcdata(Augmentations augs)
The appearance of "#PCDATA" within a group signifying a
mixed content model.
|
void |
processingInstruction(String target,
XMLString data,
Augmentations augs)
A processing instruction.
|
protected void |
reset() |
void |
reset(XMLComponentManager componentManager)
Resets the component.
|
void |
separator(short separator,
Augmentations augs)
The separator between choices or sequences of a mixed or children
content model.
|
void |
setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)
Sets the DTD content model handler.
|
void |
setDTDContentModelSource(XMLDTDContentModelSource source) |
void |
setDTDHandler(XMLDTDHandler dtdHandler)
Sets the DTD handler.
|
void |
setDTDSource(XMLDTDSource source) |
void |
setFeature(String featureId,
boolean state)
Sets the state of a feature.
|
void |
setProperty(String propertyId,
Object value)
Sets the value of a property.
|
void |
startAttlist(String elementName,
Augmentations augs)
The start of an attribute list.
|
void |
startConditional(short type,
Augmentations augs)
The start of a conditional section.
|
void |
startContentModel(String elementName,
Augmentations augs)
The start of a content model.
|
void |
startDTD(XMLLocator locator,
Augmentations augs)
The start of the DTD.
|
void |
startExternalSubset(XMLResourceIdentifier identifier,
Augmentations augs)
The start of the DTD external subset.
|
void |
startGroup(Augmentations augs)
A start of either a mixed or children content model.
|
void |
startParameterEntity(String name,
XMLResourceIdentifier identifier,
String encoding,
Augmentations augs)
This method notifies of the start of a parameter entity.
|
void |
textDecl(String version,
String encoding,
Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
|
void |
unparsedEntityDecl(String name,
XMLResourceIdentifier identifier,
String notation,
Augmentations augs)
An unparsed entity declaration.
|
protected static final String VALIDATION
protected static final String NOTIFY_CHAR_REFS
protected static final String WARN_ON_DUPLICATE_ATTDEF
protected static final String WARN_ON_UNDECLARED_ELEMDEF
protected static final String PARSER_SETTINGS
protected static final String SYMBOL_TABLE
protected static final String ERROR_REPORTER
protected static final String GRAMMAR_POOL
protected static final String DTD_VALIDATOR
protected boolean fValidation
protected boolean fDTDValidation
protected boolean fWarnDuplicateAttdef
protected boolean fWarnOnUndeclaredElemdef
protected SymbolTable fSymbolTable
protected XMLErrorReporter fErrorReporter
protected DTDGrammarBucket fGrammarBucket
protected XMLDTDValidator fValidator
protected XMLGrammarPool fGrammarPool
protected Locale fLocale
protected XMLDTDHandler fDTDHandler
protected XMLDTDSource fDTDSource
protected XMLDTDContentModelHandler fDTDContentModelHandler
protected XMLDTDContentModelSource fDTDContentModelSource
protected DTDGrammar fDTDGrammar
protected boolean fInDTDIgnore
public void reset(XMLComponentManager componentManager) throws XMLConfigurationException
XMLComponent
reset
in interface XMLComponent
componentManager
- The component manager.XMLConfigurationException
protected void reset()
public String[] getRecognizedFeatures()
getRecognizedFeatures
in interface XMLComponent
public void setFeature(String featureId, boolean state) throws XMLConfigurationException
Note: Components should silently ignore features that do not affect the operation of the component.
setFeature
in interface XMLComponent
featureId
- The feature identifier.state
- The state of the feature.SAXNotRecognizedException
- The component should not throw
this exception.SAXNotSupportedException
- The component should not throw
this exception.XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public String[] getRecognizedProperties()
getRecognizedProperties
in interface XMLComponent
public void setProperty(String propertyId, Object value) throws XMLConfigurationException
Note: Components should silently ignore properties that do not affect the operation of the component.
setProperty
in interface XMLComponent
propertyId
- The property identifier.value
- The value of the property.SAXNotRecognizedException
- The component should not throw
this exception.SAXNotSupportedException
- The component should not throw
this exception.XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public Boolean getFeatureDefault(String featureId)
getFeatureDefault
in interface XMLComponent
featureId
- The feature identifier.public Object getPropertyDefault(String propertyId)
getPropertyDefault
in interface XMLComponent
propertyId
- The property identifier.public void setDTDHandler(XMLDTDHandler dtdHandler)
setDTDHandler
in interface XMLDTDSource
dtdHandler
- The DTD handler.public XMLDTDHandler getDTDHandler()
getDTDHandler
in interface XMLDTDSource
public void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)
setDTDContentModelHandler
in interface XMLDTDContentModelSource
dtdContentModelHandler
- The DTD content model handler.public XMLDTDContentModelHandler getDTDContentModelHandler()
getDTDContentModelHandler
in interface XMLDTDContentModelSource
public void startExternalSubset(XMLResourceIdentifier identifier, Augmentations augs) throws XNIException
startExternalSubset
in interface XMLDTDHandler
augs
- Additional information that may include infoset
augmentations.identifier
- The resource identifier.XNIException
- Thrown by handler to signal an error.public void endExternalSubset(Augmentations augs) throws XNIException
endExternalSubset
in interface XMLDTDHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.protected static void checkStandaloneEntityRef(String name, DTDGrammar grammar, XMLEntityDecl tempEntityDecl, XMLErrorReporter errorReporter) throws XNIException
name
- grammar
- grammar to which entity belongstempEntityDecl
- empty entity declaration to put results inerrorReporter
- error reporter to send errors toXNIException
- Thrown by application to signal an error.public void comment(XMLString text, Augmentations augs) throws XNIException
comment
in interface XMLDTDHandler
text
- The text in the comment.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by application to signal an error.public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException
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.
processingInstruction
in interface XMLDTDHandler
target
- The target.data
- The data or null if none specified.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void startDTD(XMLLocator locator, Augmentations augs) throws XNIException
startDTD
in interface XMLDTDHandler
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.XNIException
- Thrown by handler to signal an error.public void ignoredCharacters(XMLString text, Augmentations augs) throws XNIException
ignoredCharacters
in interface XMLDTDHandler
text
- The ignored text.augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void textDecl(String version, String encoding, Augmentations augs) throws XNIException
Note: This method is only called for external parameter entities referenced in the DTD.
textDecl
in interface XMLDTDHandler
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.XNIException
- Thrown by handler to signal an error.public void startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException
startParameterEntity
in interface XMLDTDHandler
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.XNIException
- Thrown by handler to signal an error.public void endParameterEntity(String name, Augmentations augs) throws XNIException
endParameterEntity
in interface XMLDTDHandler
name
- The name of the parameter entity.augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void elementDecl(String name, String contentModel, Augmentations augs) throws XNIException
elementDecl
in interface XMLDTDHandler
name
- The name of the element.contentModel
- The element content model.augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void startAttlist(String elementName, Augmentations augs) throws XNIException
startAttlist
in interface XMLDTDHandler
elementName
- The name of the element that this attribute
list is associated with.augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs) throws XNIException
attributeDecl
in interface XMLDTDHandler
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" or
"NOTATION", 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.XNIException
- Thrown by handler to signal an error.public void endAttlist(Augmentations augs) throws XNIException
endAttlist
in interface XMLDTDHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs) throws XNIException
internalEntityDecl
in interface XMLDTDHandler
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.XNIException
- Thrown by handler to signal an error.public void externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs) throws XNIException
externalEntityDecl
in interface XMLDTDHandler
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.augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs) throws XNIException
unparsedEntityDecl
in interface XMLDTDHandler
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.XNIException
- Thrown by handler to signal an error.public void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs) throws XNIException
notationDecl
in interface XMLDTDHandler
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.XNIException
- Thrown by handler to signal an error.public void startConditional(short type, Augmentations augs) throws XNIException
startConditional
in interface XMLDTDHandler
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.XNIException
- Thrown by handler to signal an error.XMLDTDHandler.CONDITIONAL_INCLUDE
,
XMLDTDHandler.CONDITIONAL_IGNORE
public void endConditional(Augmentations augs) throws XNIException
endConditional
in interface XMLDTDHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void endDTD(Augmentations augs) throws XNIException
endDTD
in interface XMLDTDHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void setDTDSource(XMLDTDSource source)
setDTDSource
in interface XMLDTDHandler
public XMLDTDSource getDTDSource()
getDTDSource
in interface XMLDTDHandler
public void setDTDContentModelSource(XMLDTDContentModelSource source)
setDTDContentModelSource
in interface XMLDTDContentModelHandler
public XMLDTDContentModelSource getDTDContentModelSource()
getDTDContentModelSource
in interface XMLDTDContentModelHandler
public void startContentModel(String elementName, Augmentations augs) throws XNIException
startContentModel
in interface XMLDTDContentModelHandler
elementName
- The name of the element.augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void any(Augmentations augs) throws XNIException
any
in interface XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.empty(org.apache.xerces.xni.Augmentations)
,
startGroup(org.apache.xerces.xni.Augmentations)
public void empty(Augmentations augs) throws XNIException
empty
in interface XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.any(org.apache.xerces.xni.Augmentations)
,
startGroup(org.apache.xerces.xni.Augmentations)
public void startGroup(Augmentations augs) throws XNIException
pcdata()
method. A children content model will
contain additional groups and/or elements.startGroup
in interface XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.any(org.apache.xerces.xni.Augmentations)
,
empty(org.apache.xerces.xni.Augmentations)
public void pcdata(Augmentations augs)
startGroup()
.pcdata
in interface XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.startGroup(org.apache.xerces.xni.Augmentations)
public void element(String elementName, Augmentations augs) throws XNIException
element
in interface XMLDTDContentModelHandler
elementName
- The name of the referenced element.augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void separator(short separator, Augmentations augs) throws XNIException
separator
in interface XMLDTDContentModelHandler
separator
- The type of children separator.augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.XMLDTDContentModelHandler.SEPARATOR_CHOICE
,
XMLDTDContentModelHandler.SEPARATOR_SEQUENCE
public void occurrence(short occurrence, Augmentations augs) throws XNIException
occurrence
in interface XMLDTDContentModelHandler
occurrence
- The occurrence count for the last element
or group.augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.XMLDTDContentModelHandler.OCCURS_ZERO_OR_ONE
,
XMLDTDContentModelHandler.OCCURS_ZERO_OR_MORE
,
XMLDTDContentModelHandler.OCCURS_ONE_OR_MORE
public void endGroup(Augmentations augs) throws XNIException
endGroup
in interface XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.public void endContentModel(Augmentations augs) throws XNIException
endContentModel
in interface XMLDTDContentModelHandler
augs
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.protected boolean isValidNmtoken(String nmtoken)
protected boolean isValidName(String name)
Copyright © 2018 JBoss by Red Hat. All rights reserved.