org.apache.any23.validator
Interface Validator

All Known Implementing Classes:
DefaultValidator

public interface Validator

The validator class allows to perform validation - correction of related to HTML Document instances.

Author:
Michele Mostarda (mostarda@fbk.eu), Davide Palmisano (palmisano@fbk.eu)

Method Summary
 void addRule(Class<? extends Rule> rule)
          Allows to register a new rule to this validator
 void addRule(Class<? extends Rule> rule, Class<? extends Fix> fix)
          Allows to register a new rule to this validator and associating it to a fix.
 List<Class<? extends Rule>> getAllRules()
          Returns all the registered rules.
 List<Class<? extends Fix>> getFixes(Class<? extends Rule> rule)
          Returns all fixes registered for the give rule.
 void removeRule(Class<? extends Rule> rule)
          Allows to remove a rule from the validator and all the related Fixes.
 ValidationReport validate(DOMDocument document, boolean applyFix)
          Performs a validation - fixing of the provided document.
 ValidationReport validate(URI documentURI, Document document, boolean applyFix)
          Performs a validation - fixing of the provided document.
 

Method Detail

validate

ValidationReport validate(DOMDocument document,
                          boolean applyFix)
                          throws ValidatorException
Performs a validation - fixing of the provided document.

Parameters:
document - the DOMDocument instance wrapping the original HTML document.
applyFix - if true tries to fix the document.
Returns:
a report of the detected issues.
Throws:
ValidatorException - if an error occurs during the validation process.

validate

ValidationReport validate(URI documentURI,
                          Document document,
                          boolean applyFix)
                          throws ValidatorException
Performs a validation - fixing of the provided document.

Parameters:
documentURI - the document source URI.
document - the original HTML document.
applyFix - if true tries to fix the document.
Returns:
a report of the detected issues.
Throws:
ValidatorException - if an error occurs during the validation process.

addRule

void addRule(Class<? extends Rule> rule)
Allows to register a new rule to this validator

Parameters:
rule -

addRule

void addRule(Class<? extends Rule> rule,
             Class<? extends Fix> fix)
Allows to register a new rule to this validator and associating it to a fix.

Parameters:
rule -
fix -

removeRule

void removeRule(Class<? extends Rule> rule)
Allows to remove a rule from the validator and all the related Fixes.

Parameters:
rule -

getAllRules

List<Class<? extends Rule>> getAllRules()
Returns all the registered rules.

Returns:
a not null list of rules.

getFixes

List<Class<? extends Fix>> getFixes(Class<? extends Rule> rule)
Returns all fixes registered for the give rule.

Parameters:
rule -
Returns:
a not null list of fixes.


Copyright © 2010-2012 The Apache Software Foundation. All Rights Reserved.