|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xerces.impl.dtd.XMLDTDValidator
public class XMLDTDValidator
The DTD validator. The validator implements a document filter: receiving document events from the scanner; validating the content and structure; augmenting the InfoSet, if applicable; and notifying the parser of the information resulting from the validation process.
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:
Constructor Summary | |
---|---|
XMLDTDValidator()
Default constructor. |
Method Summary | |
---|---|
boolean |
characterData(java.lang.String data,
Augmentations augs)
Character content. |
void |
characters(XMLString text,
Augmentations augs)
Character content. |
void |
comment(XMLString text,
Augmentations augs)
A comment. |
void |
doctypeDecl(java.lang.String rootElement,
java.lang.String publicId,
java.lang.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(java.lang.String name,
Augmentations augs)
This method notifies the end of a general entity. |
XMLDocumentHandler |
getDocumentHandler()
Returns the document handler |
XMLDocumentSource |
getDocumentSource()
Returns the document source |
java.lang.Boolean |
getFeatureDefault(java.lang.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. |
java.lang.Object |
getPropertyDefault(java.lang.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. |
java.lang.String[] |
getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this component. |
java.lang.String[] |
getRecognizedProperties()
Returns a list of property identifiers that are recognized by this component. |
boolean |
hasGrammar()
Returns true if the validator has a DTD grammar |
void |
ignorableWhitespace(XMLString text,
Augmentations augs)
Ignorable whitespace. |
void |
processingInstruction(java.lang.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(java.lang.String featureId,
boolean state)
Sets the state of a feature. |
void |
setProperty(java.lang.String propertyId,
java.lang.Object value)
Sets the value of a property. |
void |
startCDATA(Augmentations augs)
The start of a CDATA section. |
void |
startDocument(XMLLocator locator,
java.lang.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(java.lang.String name,
XMLResourceIdentifier identifier,
java.lang.String encoding,
Augmentations augs)
This method notifies the start of a general entity. |
void |
textDecl(java.lang.String version,
java.lang.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 |
void |
xmlDecl(java.lang.String version,
java.lang.String encoding,
java.lang.String standalone,
Augmentations augs)
Notifies of the presence of an XMLDecl line in the document. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLDTDValidator()
Method Detail |
---|
public void reset(XMLComponentManager componentManager) throws XMLConfigurationException
XMLComponent
reset
in interface XMLComponent
componentManager
- The component manager.
XMLConfigurationException
public java.lang.String[] getRecognizedFeatures()
getRecognizedFeatures
in interface XMLComponent
public void setFeature(java.lang.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 java.lang.String[] getRecognizedProperties()
getRecognizedProperties
in interface XMLComponent
public void setProperty(java.lang.String propertyId, java.lang.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 java.lang.Boolean getFeatureDefault(java.lang.String featureId)
getFeatureDefault
in interface XMLComponent
featureId
- The feature identifier.public java.lang.Object getPropertyDefault(java.lang.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, java.lang.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 augmentations
XNIException
- Thrown by handler to signal an error.public void xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.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 augmentations
XNIException
- Thrown by handler to signal an error.public void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.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 augmentations
XNIException
- 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 augmentations
XNIException
- 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 augmentations
XNIException
- 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 augmentations
XNIException
- 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 augmentations
XNIException
- 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 augmentations
XNIException
- 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 augmentations
XNIException
- 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 augmentations
XNIException
- 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 augmentations
XNIException
- 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 augmentations
XNIException
- Thrown by application to signal an error.public void processingInstruction(java.lang.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 augmentations
XNIException
- Thrown by handler to signal an error.public void startGeneralEntity(java.lang.String name, XMLResourceIdentifier identifier, java.lang.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 augmentations
XNIException
- Thrown by handler to signal an error.public void endGeneralEntity(java.lang.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 augmentations
XNIException
- Thrown by handler to signal an error.public void textDecl(java.lang.String version, java.lang.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
public boolean characterData(java.lang.String data, Augmentations augs)
RevalidationHandler
characterData
in interface RevalidationHandler
data
- The character data.augs
- Augmentations
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |