View Javadoc
1   /**
2    * Copyright (C) 2014-2017 Philip Helger (www.helger.com)
3    * philip[at]helger[dot]com
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * 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 com.helger.schematron.pure.validation;
18  
19  import javax.annotation.Nonnull;
20  import javax.annotation.Nullable;
21  import javax.annotation.concurrent.NotThreadSafe;
22  
23  import org.w3c.dom.Node;
24  
25  import com.helger.commons.state.EContinue;
26  import com.helger.commons.state.EValidity;
27  import com.helger.schematron.pure.model.PSAssertReport;
28  
29  /**
30   * A simple implementation if {@link IPSValidationHandler} that stops validation
31   * upon the first error (the first failed assert or the first successful
32   * report). The final validation result can be retrieved by invoking
33   * {@link #getValidity()}.
34   * 
35   * @author Philip Helger
36   */
37  @NotThreadSafe
38  public class PSValidationHandlerBreakOnFirstError extends AbstractPSPartialValidationHandler
39  {
40    private EValidity m_eValidity = EValidity.VALID;
41  
42    @Override
43    @Nonnull
44    public EContinue onFailedAssert (@Nonnull final PSAssertReport aAssertReport,
45                                     @Nonnull final String sTestExpression,
46                                     @Nonnull final Node aRuleMatchingNode,
47                                     final int nNodeIndex,
48                                     @Nullable final Object aContext)
49    {
50      m_eValidity = EValidity.INVALID;
51      return EContinue.BREAK;
52    }
53  
54    @Override
55    @Nonnull
56    public EContinue onSuccessfulReport (@Nonnull final PSAssertReport aAssertReport,
57                                         @Nonnull final String sTestExpression,
58                                         @Nonnull final Node aRuleMatchingNode,
59                                         final int nNodeIndex,
60                                         @Nullable final Object aContext)
61    {
62      m_eValidity = EValidity.INVALID;
63      return EContinue.BREAK;
64    }
65  
66    /**
67     * @return The validity of the XML file. {@link EValidity#VALID} if no failed
68     *         assertion and no successful report occurred,
69     *         {@link EValidity#INVALID} otherwise.
70     */
71  
72    @Override
73    @Nonnull
74    public EValidity getValidity ()
75    {
76      return m_eValidity;
77    }
78  }