net.n3.nanoxml
Interface IXMLValidator

All Known Implementing Classes:

NonValidator, ValidatorPlugin

public interface IXMLValidator

IXMLValidator processes the DTD and handles entity references.

Version:

$Name: RELEASE_2_2_1 $, $Revision: 1.3 $

Author:

Marc De Scheemaecker

Method Summary

void	attributeAdded(java.lang.String key, java.lang.String value, java.lang.String systemId, int lineNr) Indicates that an attribute has been added to the current element.
void	elementAttributesProcessed(java.lang.String name, java.util.Properties extraAttributes, java.lang.String systemId, int lineNr) This method is called when the attributes of an XML element have been processed.
void	elementEnded(java.lang.String name, java.lang.String systemId, int lineNr) Indicates that the current element has ended.
void	elementStarted(java.lang.String name, java.lang.String systemId, int lineNr) Indicates that an element has been started.
IXMLEntityResolver	getParameterEntityResolver() Returns the parameter entity resolver.
void	parseDTD(java.lang.String publicID, IXMLReader reader, IXMLEntityResolver entityResolver, boolean external) Parses the DTD.
void	PCDataAdded(java.lang.String systemId, int lineNr) Indicates that a new #PCDATA element has been encountered.
void	setParameterEntityResolver(IXMLEntityResolver resolver) Sets the parameter entity resolver.

Method Detail

setParameterEntityResolver

void setParameterEntityResolver(IXMLEntityResolver resolver)

Sets the parameter entity resolver.

Parameters:

resolver - the entity resolver.

getParameterEntityResolver

IXMLEntityResolver getParameterEntityResolver()

Returns the parameter entity resolver.

Returns:

the entity resolver.

parseDTD

void parseDTD(java.lang.String publicID,
              IXMLReader reader,
              IXMLEntityResolver entityResolver,
              boolean external)
              throws java.lang.Exception

Parses the DTD. The validator object is responsible for reading the full DTD.

Parameters:

publicID - the public ID, which may be null.

reader - the reader to read the DTD from.

entityResolver - the entity resolver.

external - true if the DTD is external.

Throws:

java.lang.Exception - If something went wrong.

elementStarted

void elementStarted(java.lang.String name,
                    java.lang.String systemId,
                    int lineNr)
                    throws java.lang.Exception

Indicates that an element has been started.

Parameters:

name - the name of the element.

systemId - the system ID of the XML data of the element.

lineNr - the line number in the XML data of the element.

Throws:

java.lang.Exception - If the element could not be validated.

elementEnded

void elementEnded(java.lang.String name,
                  java.lang.String systemId,
                  int lineNr)
                  throws java.lang.Exception

Indicates that the current element has ended.

Parameters:

name - the name of the element.

systemId - the system ID of the XML data of the element.

lineNr - the line number in the XML data of the element.

Throws:

java.lang.Exception - If the element could not be validated.

attributeAdded

void attributeAdded(java.lang.String key,
                    java.lang.String value,
                    java.lang.String systemId,
                    int lineNr)
                    throws java.lang.Exception

Indicates that an attribute has been added to the current element.

Parameters:

key - the name of the attribute.

value - the value of the attribute.

systemId - the system ID of the XML data of the element.

lineNr - the line number in the XML data of the element.

Throws:

java.lang.Exception - If the attribute could not be validated.

elementAttributesProcessed

void elementAttributesProcessed(java.lang.String name,
                                java.util.Properties extraAttributes,
                                java.lang.String systemId,
                                int lineNr)
                                throws java.lang.Exception

This method is called when the attributes of an XML element have been processed. If there are attributes with a default value which have not been specified yet, they have to be put into extraAttributes.

Parameters:

name - the name of the element.

extraAttributes - where to put extra attributes.

systemId - the system ID of the XML data of the element.

lineNr - the line number in the XML data of the element.

Throws:

java.lang.Exception - if the element could not be validated.

PCDataAdded

void PCDataAdded(java.lang.String systemId,
                 int lineNr)
                 throws java.lang.Exception

Indicates that a new #PCDATA element has been encountered.

Parameters:

systemId - the system ID of the XML data of the element.

lineNr - the line number in the XML data of the element.

Throws:

java.lang.Exception - if the element could not be validated.