org.apache.any23.validator
Interface Rule

All Known Implementing Classes:

AboutNotURIRule, MetaNameMisuseRule, MissingOpenGraphNamespaceRule

public interface Rule

Models a rule for an issue detection.

Author:

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

See Also:

Fix

Method Summary

boolean	applyOn(DOMDocument document, RuleContext context, ValidationReportBuilder validationReportBuilder) Applies this rule to the given document.
String	getHRName()

Method Detail

getHRName

String getHRName()

Returns:

returns the human readable name for this rule.

applyOn

boolean applyOn(DOMDocument document,
                RuleContext context,
                ValidationReportBuilder validationReportBuilder)

Applies this rule to the given document.

Parameters:

document - the target document.

context - the context used to pass data to an eventual Fix.

validationReportBuilder - the report builder used to collect rule reporting.

Returns:

true if al least an issue is detected, false otherwise.