/*
* Tanaguru - Automated webpage assessment
* Copyright (C) 2008-2016 Tanaguru.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Contact us by mail: tanaguru AT tanaguru DOT org
*/
package org.tanaguru.rules.rgaa32016;
import org.jsoup.nodes.Element;
import org.jsoup.select.Elements;
import org.tanaguru.entity.audit.TestSolution;
import org.tanaguru.processor.SSPHandler;
import org.tanaguru.ruleimplementation.AbstractMarkerPageRuleImplementation;
import org.tanaguru.rules.elementchecker.pertinence.TextPertinenceChecker;
import org.tanaguru.rules.elementselector.SimpleElementSelector;
import static org.tanaguru.rules.keystore.CssLikeQueryStore.TABLE_WITH_CAPTION_CSS_LIKE_QUERY;
import static org.tanaguru.rules.keystore.HtmlElementStore.CAPTION_ELEMENT;
import static org.tanaguru.rules.keystore.HtmlElementStore.TEXT_ELEMENT2;
import static org.tanaguru.rules.keystore.MarkerStore.COMPLEX_TABLE_MARKER;
import static org.tanaguru.rules.keystore.MarkerStore.DATA_TABLE_MARKER;
import static org.tanaguru.rules.keystore.MarkerStore.PRESENTATION_TABLE_MARKER;
import static org.tanaguru.rules.keystore.RemarkMessageStore.*;
/**
* Implementation of the rule 5.2.1 of the referential Rgaa 3-2016.
* <br/>
* For more details about the implementation, refer to <a href="http://tanaguru-rules-rgaa3.readthedocs.org/en/latest/Rule-5-2-1">the rule 5.2.1 design page.</a>
* @see <a href="http://references.modernisation.gouv.fr/referentiel-technique-0#test-5-2-1"> 5.2.1 rule specification</a>
*
*/
public class Rgaa32016Rule050201 extends AbstractMarkerPageRuleImplementation {
/**
* Default constructor
*/
public Rgaa32016Rule050201() {
super(
new SimpleElementSelector(TABLE_WITH_CAPTION_CSS_LIKE_QUERY),
// the data tables are part of the scope
new String[]{COMPLEX_TABLE_MARKER},
// the presentation and complex tables are not part of the scope
new String[]{PRESENTATION_TABLE_MARKER, DATA_TABLE_MARKER},
// checker for elements identified by marker
new TextPertinenceChecker(
// check emptiness
true,
// no comparison with other attribute
null,
// no comparison with blacklist
null,
// not pertinent message
NOT_PERTINENT_CAPTION_FOR_COMPLEX_TABLE_MSG,
// manual check message
CHECK_CAPTION_PERTINENCE_FOR_COMPLEX_TABLE_MSG,
// evidence element
TEXT_ELEMENT2),
// checker for elements not identified by marker
new TextPertinenceChecker(
// check emptiness
true,
// no comparison with other attribute
null,
// no comparison with blacklist
null,
// override not pertinent result
TestSolution.NEED_MORE_INFO,
// not pertinent message
CHECK_TABLE_IS_COMPLEX_FOR_NOT_PERTINENT_CAPTION_MSG,
// manual check message
CHECK_TABLE_IS_COMPLEX_AND_CAPTION_PERTINENCE_MSG,
// evidence element
TEXT_ELEMENT2)
);
}
@Override
protected void select(SSPHandler sspHandler) {
super.select(sspHandler);
// once tables selected, we extract the caption child element of each
// to make the control
Elements captionOnTable = new Elements();
for (Element el : getSelectionWithoutMarkerHandler().get()) {
captionOnTable.add(el.select(CAPTION_ELEMENT).first());
}
getSelectionWithoutMarkerHandler().clean().addAll(captionOnTable);
Elements captionOnDataTable = new Elements();
for (Element el : getSelectionWithMarkerHandler().get()) {
captionOnDataTable.add(el.select(CAPTION_ELEMENT).first());
}
getSelectionWithMarkerHandler().clean().addAll(captionOnDataTable);
}
}