View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *  http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.any23.validator.rule;
18  
19  import java.util.List;
20  
21  import org.apache.any23.extractor.html.DomUtils;
22  import org.apache.any23.validator.DOMDocument;
23  import org.apache.any23.validator.Rule;
24  import org.apache.any23.validator.RuleContext;
25  import org.apache.any23.validator.ValidationReport;
26  import org.apache.any23.validator.ValidationReportBuilder;
27  import org.w3c.dom.Node;
28  
29  /**
30   * This fixes missing attribute values for the 'itemscope' attribute 
31   * Typically when such a snippet of XHTML is fed through the 
32   * {@link org.apache.any23.extractor.rdfa.RDFa11Extractor}, and
33   * subsequently to Sesame's SesameRDFaParser,
34   * it will result in the following behavior. 
35   * <pre>
36   * {@code
37   * [Fatal Error] :23:15: Attribute name "itemscope" associated with an element type "div" must be followed by the ' = ' character.
38   * }
39   * </pre>
40   * This Rule identifies that happening.
41   *
42   */
43  public class MissingItemscopeAttributeValueRule implements Rule {
44  
45    /**
46     * Default constructor
47     */
48    public MissingItemscopeAttributeValueRule() {
49      //default costructor
50    }
51  
52    @Override
53    public String getHRName() {
54      return "missing-itemscope-value-rule";
55    }
56  
57    /**
58     * @see org.apache.any23.validator.Rule#applyOn(org.apache.any23.validator.DOMDocument, org.apache.any23.validator.RuleContext, org.apache.any23.validator.ValidationReportBuilder)
59     */
60    @Override
61    public boolean applyOn(DOMDocument document, @SuppressWarnings("rawtypes") RuleContext context,
62        ValidationReportBuilder validationReportBuilder) {
63      List<Node> itemNodes = document.getNodesWithAttribute("itemscope");
64      boolean foundPrecondition = false;
65      String propertyNode;
66      Node iNode = null;
67      for(Node itemNode : itemNodes) {
68        iNode = itemNode;
69        propertyNode = iNode.getAttributes().getNamedItem("itemscope").getNodeValue();
70        if( propertyNode == null || propertyNode.contentEquals("")) {
71          foundPrecondition = true;
72          break;
73        }
74      }
75      if(foundPrecondition) {
76        validationReportBuilder.reportIssue(
77            ValidationReport.IssueLevel.ERROR,
78            "Located absence of an accompanying value for the the 'itemscope' attribute of element with hashcode: " + iNode.hashCode(),
79            iNode
80            );
81        return true;
82      }
83      return false;
84    }
85  
86  }