public class XMLDTDValidator extends Object implements XMLComponent, XMLDocumentFilter, XMLDTDValidatorFilter, RevalidationHandler
Formerly, this component also handled DTD events and grammar construction. To facilitate the development of a meaningful DTD grammar caching/preparsing framework, this functionality has been moved into the XMLDTDLoader class. Therefore, this class no longer implements the DTDFilter or DTDContentModelFilter interfaces.
This component requires the following features and properties from the component manager that uses it:
Modifier and Type | Field and Description |
---|---|
protected static String |
BALANCE_SYNTAX_TREES
Feature identifier: balance syntax trees.
|
protected static String |
DATATYPE_VALIDATOR_FACTORY
Property identifier: datatype validator factory.
|
protected static String |
DYNAMIC_VALIDATION
Feature identifier: dynamic validation.
|
protected static String |
ERROR_REPORTER
Property identifier: error reporter.
|
protected boolean |
fBalanceSyntaxTrees
Controls whether the DTD grammar produces balanced syntax trees.
|
protected DTDDVFactory |
fDatatypeValidatorFactory
Datatype validator factory.
|
protected XMLLocator |
fDocLocation |
protected XMLDocumentHandler |
fDocumentHandler
Document handler.
|
protected XMLDocumentSource |
fDocumentSource |
protected DTDGrammar |
fDTDGrammar
DTD Grammar.
|
protected boolean |
fDTDValidation
Validation against only DTD
|
protected boolean |
fDynamicValidation
Dynamic validation.
|
protected XMLErrorReporter |
fErrorReporter
Error reporter.
|
protected DTDGrammarBucket |
fGrammarBucket
Grammar bucket.
|
protected XMLGrammarPool |
fGrammarPool |
protected NamespaceContext |
fNamespaceContext
Namespace support.
|
protected boolean |
fNamespaces
Namespaces.
|
protected boolean |
fSeenDoctypeDecl
True if seen DOCTYPE declaration.
|
protected SymbolTable |
fSymbolTable
Symbol table.
|
protected DatatypeValidator |
fValENTITIES
Datatype validator: ENTITIES.
|
protected DatatypeValidator |
fValENTITY
Datatype validator: ENTITY.
|
protected DatatypeValidator |
fValID
Datatype validator: ID.
|
protected boolean |
fValidation
Validation.
|
protected ValidationManager |
fValidationManager |
protected ValidationState |
fValidationState |
protected DatatypeValidator |
fValIDRef
Datatype validator: IDREF.
|
protected DatatypeValidator |
fValIDRefs
Datatype validator: IDREFS.
|
protected DatatypeValidator |
fValNMTOKEN
Datatype validator: NMTOKEN.
|
protected DatatypeValidator |
fValNMTOKENS
Datatype validator: NMTOKENS.
|
protected DatatypeValidator |
fValNOTATION
Datatype validator: NOTATION.
|
protected boolean |
fWarnDuplicateAttdef
warn on duplicate attribute definition, this feature works only when validation is true
|
protected static String |
GRAMMAR_POOL
Property identifier: grammar pool.
|
protected static String |
NAMESPACES
Feature identifier: namespaces.
|
protected static String |
PARSER_SETTINGS |
protected static String |
SYMBOL_TABLE
Property identifier: symbol table.
|
protected static String |
VALIDATION
Feature identifier: validation.
|
protected static String |
VALIDATION_MANAGER |
protected static String |
WARN_ON_DUPLICATE_ATTDEF
Feature identifier: warn on duplicate attdef
|
Constructor and Description |
---|
XMLDTDValidator()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addDTDDefaultAttrsAndValidate(QName elementName,
int elementIndex,
XMLAttributes attributes)
Add default attributes and validate.
|
boolean |
characterData(String data,
Augmentations augs)
Character content.
|
void |
characters(XMLString text,
Augmentations augs)
Character content.
|
void |
comment(XMLString text,
Augmentations augs)
A comment.
|
void |
doctypeDecl(String rootElement,
String publicId,
String systemId,
Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
|
void |
emptyElement(QName element,
XMLAttributes attributes,
Augmentations augs)
An empty element.
|
void |
endCDATA(Augmentations augs)
The end of a CDATA section.
|
void |
endDocument(Augmentations augs)
The end of the document.
|
void |
endElement(QName element,
Augmentations augs)
The end of an element.
|
void |
endGeneralEntity(String name,
Augmentations augs)
This method notifies the end of a general entity.
|
protected void |
endNamespaceScope(QName element,
Augmentations augs,
boolean isEmpty) |
XMLDocumentHandler |
getDocumentHandler()
Returns the document handler
|
XMLDocumentSource |
getDocumentSource()
Returns the document source
|
protected String |
getExternalEntityRefInAttrValue(String nonNormalizedValue)
Checks entities in attribute values for standalone VC.
|
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.
|
protected void |
handleEndElement(QName element,
Augmentations augs,
boolean isEmpty)
Handle end element.
|
protected boolean |
handleStartElement(QName element,
XMLAttributes attributes,
Augmentations augs)
Handle element
|
boolean |
hasGrammar()
Returns true if the validator has a DTD grammar
|
void |
ignorableWhitespace(XMLString text,
Augmentations augs)
Ignorable whitespace.
|
protected void |
init()
initialization
|
protected boolean |
invalidStandaloneAttDef(QName element,
QName attribute)
Returns true if invalid standalone attribute definition.
|
protected boolean |
isSpace(int c) |
void |
processingInstruction(String target,
XMLString data,
Augmentations augs)
A processing instruction.
|
void |
reset(XMLComponentManager componentManager)
Resets the component.
|
void |
setDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
|
void |
setDocumentSource(XMLDocumentSource source)
Sets the document 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 |
startCDATA(Augmentations augs)
The start of a CDATA section.
|
void |
startDocument(XMLLocator locator,
String encoding,
NamespaceContext namespaceContext,
Augmentations augs)
The start of the document.
|
void |
startElement(QName element,
XMLAttributes attributes,
Augmentations augs)
The start of an element.
|
void |
startGeneralEntity(String name,
XMLResourceIdentifier identifier,
String encoding,
Augmentations augs)
This method notifies the start of a general entity.
|
protected void |
startNamespaceScope(QName element,
XMLAttributes attributes,
Augmentations augs) |
void |
textDecl(String version,
String encoding,
Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
|
boolean |
validate()
Return true if validator must validate the document
|
protected void |
validateDTDattribute(QName element,
String attValue,
XMLAttributeDecl attributeDecl)
Validate attributes in DTD fashion.
|
void |
xmlDecl(String version,
String encoding,
String standalone,
Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.
|
protected static final String NAMESPACES
protected static final String VALIDATION
protected static final String DYNAMIC_VALIDATION
protected static final String BALANCE_SYNTAX_TREES
protected static final String WARN_ON_DUPLICATE_ATTDEF
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 DATATYPE_VALIDATOR_FACTORY
protected static final String VALIDATION_MANAGER
protected ValidationManager fValidationManager
protected final ValidationState fValidationState
protected boolean fNamespaces
protected boolean fValidation
protected boolean fDTDValidation
protected boolean fDynamicValidation
true
.protected boolean fBalanceSyntaxTrees
protected boolean fWarnDuplicateAttdef
protected SymbolTable fSymbolTable
protected XMLErrorReporter fErrorReporter
protected XMLGrammarPool fGrammarPool
protected DTDGrammarBucket fGrammarBucket
protected XMLLocator fDocLocation
protected NamespaceContext fNamespaceContext
protected DTDDVFactory fDatatypeValidatorFactory
protected XMLDocumentHandler fDocumentHandler
protected XMLDocumentSource fDocumentSource
protected DTDGrammar fDTDGrammar
protected boolean fSeenDoctypeDecl
protected DatatypeValidator fValID
protected DatatypeValidator fValIDRef
protected DatatypeValidator fValIDRefs
protected DatatypeValidator fValENTITY
protected DatatypeValidator fValENTITIES
protected DatatypeValidator fValNMTOKEN
protected DatatypeValidator fValNMTOKENS
protected DatatypeValidator fValNOTATION
public void reset(XMLComponentManager componentManager) throws XMLConfigurationException
XMLComponent
reset
in interface XMLComponent
componentManager
- The component manager.XMLConfigurationException
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 setDocumentHandler(XMLDocumentHandler documentHandler)
setDocumentHandler
in interface XMLDocumentSource
public XMLDocumentHandler getDocumentHandler()
getDocumentHandler
in interface XMLDocumentSource
public void setDocumentSource(XMLDocumentSource source)
setDocumentSource
in interface XMLDocumentHandler
public XMLDocumentSource getDocumentSource()
getDocumentSource
in interface XMLDocumentHandler
public void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException
startDocument
in interface XMLDocumentHandler
locator
- The system identifier of the entity if the entity
is external, null otherwise.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 entities or a document entity that is
parsed from a java.io.Reader).namespaceContext
- The namespace context in effect at the
start of this document.
This object represents the current context.
Implementors of this class are responsible
for copying the namespace bindings from the
the current context (and its parent contexts)
if that information is important.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException
xmlDecl
in interface XMLDocumentHandler
version
- The XML version.encoding
- The IANA encoding name of the document, or null if
not specified.standalone
- The standalone value, or null if not specified.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException
doctypeDecl
in interface XMLDocumentHandler
rootElement
- The name of the root element.publicId
- The public identifier if an external DTD or null
if the external DTD is specified using SYSTEM.systemId
- The system identifier if an external DTD, null
otherwise.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException
startElement
in interface XMLDocumentHandler
element
- The name of the element.attributes
- The element attributes.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException
emptyElement
in interface XMLDocumentHandler
element
- The name of the element.attributes
- The element attributes.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void characters(XMLString text, Augmentations augs) throws XNIException
characters
in interface XMLDocumentHandler
text
- The content.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException
ignorableWhitespace
in interface XMLDocumentHandler
text
- The ignorable whitespace.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void endElement(QName element, Augmentations augs) throws XNIException
endElement
in interface XMLDocumentHandler
element
- The name of the element.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void startCDATA(Augmentations augs) throws XNIException
startCDATA
in interface XMLDocumentHandler
augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void endCDATA(Augmentations augs) throws XNIException
endCDATA
in interface XMLDocumentHandler
augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void endDocument(Augmentations augs) throws XNIException
endDocument
in interface XMLDocumentHandler
augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void comment(XMLString text, Augmentations augs) throws XNIException
comment
in interface XMLDocumentHandler
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 XMLDocumentHandler
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 startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException
Note: This method is not called for entity references appearing as part of attribute values.
startGeneralEntity
in interface XMLDocumentHandler
name
- The name of the general 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 entities or a document entity that is
parsed from a java.io.Reader).augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void endGeneralEntity(String name, Augmentations augs) throws XNIException
Note: This method is not called for entity references appearing as part of attribute values.
endGeneralEntity
in interface XMLDocumentHandler
name
- The name of the entity.augs
- Additional information that may include infoset augmentationsXNIException
- 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 XMLDocumentHandler
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 final boolean hasGrammar()
XMLDTDValidatorFilter
hasGrammar
in interface XMLDTDValidatorFilter
public final boolean validate()
XMLDTDValidatorFilter
validate
in interface XMLDTDValidatorFilter
protected void addDTDDefaultAttrsAndValidate(QName elementName, int elementIndex, XMLAttributes attributes) throws XNIException
XNIException
protected String getExternalEntityRefInAttrValue(String nonNormalizedValue)
protected void validateDTDattribute(QName element, String attValue, XMLAttributeDecl attributeDecl) throws XNIException
XNIException
protected boolean invalidStandaloneAttDef(QName element, QName attribute)
protected void init()
protected boolean handleStartElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException
XNIException
protected void startNamespaceScope(QName element, XMLAttributes attributes, Augmentations augs)
protected void handleEndElement(QName element, Augmentations augs, boolean isEmpty) throws XNIException
XNIException
protected void endNamespaceScope(QName element, Augmentations augs, boolean isEmpty)
protected boolean isSpace(int c)
public boolean characterData(String data, Augmentations augs)
RevalidationHandler
characterData
in interface RevalidationHandler
data
- The character data.augs
- AugmentationsCopyright © 2021 JBoss by Red Hat. All rights reserved.