1 /*
2 * Copyright 2008-2010 Digital Enterprise Research Institute (DERI)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.deri.any23.validator;
18
19 /**
20 * Models a rule for an issue detection.
21 *
22 * @see org.deri.any23.validator.Fix
23 * @author Michele Mostarda (mostarda@fbk.eu)
24 * @author Davide Palmisano (palmisano@fbk.eu)
25 */
26 public interface Rule {
27
28 /**
29 * @return returns the human readable name for this rule.
30 */
31 String getHRName();
32
33 /**
34 * Applies this rule to the given document.
35 *
36 * @param document the target document.
37 * @param context the context used to pass data to an eventual {@link org.deri.any23.validator.Fix}.
38 * @param validationReportBuilder the report builder used to collect rule reporting.
39 * @return <code>true</code> if al least an issue is detected, <code>false</code> otherwise.
40 */
41 boolean applyOn(DOMDocument document, RuleContext context, ValidationReportBuilder validationReportBuilder);
42
43 }