nu.validator.checker

Class MicrodataChecker

java.lang.Object

nu.validator.checker.Checker

nu.validator.checker.MicrodataChecker

All Implemented Interfaces:

org.xml.sax.ContentHandler

public class MicrodataChecker
extends Checker

Checker for microdata constraints that require tree traversal. The SAX events are used to construct a minimal tree with only the relevant elements and attributes, which is then validated. The followings constraints are supported: - The itemref attribute, if specified, must have a value that is an unordered set of unique space-separated tokens that are case-sensitive, consisting of IDs of elements in the same home subtree. - A document must not contain any items for which the algorithm to find the properties of an item finds any microdata errors. - All itemref attributes in a Document must be such that there are no cycles in the graph formed from representing each item in the Document as a node in the graph and each property of an item whose value is another item as an edge in the graph connecting those two items. - A document must not contain any elements that have an itemprop attribute that would not be found to be a property of any of the items in that document were their properties all to be determined Not all checks are unconditional. For example, the itemref constraints are only checked if the itemscope attribute is present. However, the checks are chained such that if a document validates with no errors, then all the constraints are satisfied.

Constructor Summary

Constructors

Constructor and Description
MicrodataChecker()

Method Summary

Modifier and Type	Method and Description
void	endDocument() Calls reset().
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
void	reset() Does nothing.
void	setDocumentLocator(org.xml.sax.Locator locator)
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)

Methods inherited from class nu.validator.checker.Checker

characters, endPrefixMapping, err, err, getDocumentLocator, getErrorHandler, ignorableWhitespace, processingInstruction, setErrorHandler, skippedEntity, startDocument, startPrefixMapping, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MicrodataChecker

public MicrodataChecker()

Method Detail

reset

public void reset()

Description copied from class: Checker

Does nothing. Subclasses are expected to override this method with an implementation that clears the state of the checker and releases objects the checker might hold references to.

Overrides:

reset in class Checker

See Also:

Checker.reset()

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class Checker

Throws:

org.xml.sax.SAXException

See Also:

Checker.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class Checker

Throws:

org.xml.sax.SAXException

See Also:

Checker.endElement(java.lang.String, java.lang.String, java.lang.String)

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Description copied from class: Checker

Calls reset().

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class Checker

Throws:

org.xml.sax.SAXException

See Also:

XMLFilterImpl.endDocument()

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Overrides:

setDocumentLocator in class Checker

See Also:

XMLFilterImpl.setDocumentLocator(org.xml.sax.Locator)