org.jahia.services.htmlvalidator

Class WAIValidator

java.lang.Object

org.jahia.services.htmlvalidator.WAIValidator

public class WAIValidator
extends Object

This class is used to validate an HTML fragment against the WAI (Accessiweb Section 508) rules. All the 55 "Bronze" criteria can be found here:
Accessiweb

Author:

Xavier Lawrence

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	linkToDest

Constructor Summary

Constructors

Constructor and Description
WAIValidator(Locale uiLocale)

Method Summary

Modifier and Type	Method and Description
protected int	countHeadersInRow(net.htmlparser.jericho.Element rowElement)
protected int	countHeadersInRows(List<net.htmlparser.jericho.Element> rowElements)
protected void	processFrameset(net.htmlparser.jericho.Element node, Set<String> noframes, List<Result> errors, int level, net.htmlparser.jericho.Source source) Validates a Frame Element.
protected void	processTable(net.htmlparser.jericho.Element node, Set<String> headers, Set<String> ids, List<Result> errors, int level, net.htmlparser.jericho.Source source) Recursive method to process a Table element and all its children
protected void	resetIsDataTable(int level) If the level given in parameter is equal to the formLevel which previously set the isDataTable to false, then we have finished processing the form and we can set the variable back to true.
protected void	setIsDataTable(int level) Sets the isDataTable boolean to false and stores the level of the Node which invoked this method.
String	toString()
ValidatorResults	validate(String inputHTML) Validates a HTML fragment represented as a String.
protected Result	validateAreaShape(net.htmlparser.jericho.Element node, net.htmlparser.jericho.Source source) Validates an Area Element.
protected List<Result>	validateForm(net.htmlparser.jericho.Element node, int level, net.htmlparser.jericho.Source source) Validates a Form Element.
protected List<Result>	validateFrameset(net.htmlparser.jericho.Element node, int level, net.htmlparser.jericho.Source source)
protected List<Result>	validateHtml(net.htmlparser.jericho.Element node, net.htmlparser.jericho.Source source) Validates an HTML fragment starting from any Node.
protected Result	validateImage(net.htmlparser.jericho.Element node, net.htmlparser.jericho.Source source) Validates an Img Element.
protected Result	validateLink(net.htmlparser.jericho.Element node, net.htmlparser.jericho.Source source) Validates a link Element.
protected List<Result>	validateTable(net.htmlparser.jericho.Element node, int level, net.htmlparser.jericho.Source source) Validates a Table Element.

Methods inherited from class java.lang.Object

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

Field Detail

linkToDest

protected final Map<String,String> linkToDest

Constructor Detail

WAIValidator

public WAIValidator(Locale uiLocale)

Method Detail

validate

public ValidatorResults validate(String inputHTML)

Validates a HTML fragment represented as a String.

Parameters:

inputHTML - The html fragment

Returns:

EngineValidationHelper containing the validation errors, in case of no errors, an empty EngineValidationHelper is returned.

validateHtml

protected List<Result> validateHtml(net.htmlparser.jericho.Element node,
                                    net.htmlparser.jericho.Source source)

Validates an HTML fragment starting from any Node.

Parameters:

node - The starting Node.

source -

Returns:

A list of Result Objects, the list will be empty in case no errors occurred.

setIsDataTable

protected void setIsDataTable(int level)

Sets the isDataTable boolean to false and stores the level of the Node which invoked this method. The variable is used to distinguish data Tables, which need to be validated, against formatting or form tables which don't.

Parameters:

level - The level of the Form tag being processed.

resetIsDataTable

protected void resetIsDataTable(int level)

If the level given in parameter is equal to the formLevel which previously set the isDataTable to false, then we have finished processing the form and we can set the variable back to true.

Parameters:

level - The level of the tag being processed.

validateLink

protected Result validateLink(net.htmlparser.jericho.Element node,
                              net.htmlparser.jericho.Source source)
                       throws DOMException

Validates a link Element.

Parameters:

node - The HTMLAnchorElement.

source -

Returns:

Result or null if no error occurred.

Throws:

DOMException

validateImage

protected Result validateImage(net.htmlparser.jericho.Element node,
                               net.htmlparser.jericho.Source source)

Validates an Img Element.

Parameters:

node - The HTMLImageElement.

source -

Returns:

Result or null if no error occurred.

validateAreaShape

protected Result validateAreaShape(net.htmlparser.jericho.Element node,
                                   net.htmlparser.jericho.Source source)

Validates an Area Element.

Parameters:

node - The HTMLAreaElement.

source -

Returns:

Result or null if no error occurred.

validateTable

protected List<Result> validateTable(net.htmlparser.jericho.Element node,
                                     int level,
                                     net.htmlparser.jericho.Source source)

Validates a Table Element.

Parameters:

node - The HTMLFormElement.

source -

Returns:

A List of Result Objects.

processTable

protected void processTable(net.htmlparser.jericho.Element node,
                            Set<String> headers,
                            Set<String> ids,
                            List<Result> errors,
                            int level,
                            net.htmlparser.jericho.Source source)

Recursive method to process a Table element and all its children

Parameters:

node - The current node of the Table.

headers - The current list of 'headers' attributes (present in tds)

errors -

source -

countHeadersInRows

protected int countHeadersInRows(List<net.htmlparser.jericho.Element> rowElements)

countHeadersInRow

protected int countHeadersInRow(net.htmlparser.jericho.Element rowElement)

validateForm

protected List<Result> validateForm(net.htmlparser.jericho.Element node,
                                    int level,
                                    net.htmlparser.jericho.Source source)

Validates a Form Element.

Parameters:

node - The HTMLFormElement.

level - The level of the root form node in relation to the top root node of the html fragment.

source -

Returns:

A List of Result Objects.

validateFrameset

protected List<Result> validateFrameset(net.htmlparser.jericho.Element node,
                                        int level,
                                        net.htmlparser.jericho.Source source)

processFrameset

protected void processFrameset(net.htmlparser.jericho.Element node,
                               Set<String> noframes,
                               List<Result> errors,
                               int level,
                               net.htmlparser.jericho.Source source)

Validates a Frame Element.

Parameters:

node - The HTMLFrameElement.

source -

toString

public String toString()

Overrides:

toString in class Object