View Javadoc
1   /*
2    * Portions of this software was developed by employees of the National Institute
3    * of Standards and Technology (NIST), an agency of the Federal Government and is
4    * being made available as a public service. Pursuant to title 17 United States
5    * Code Section 105, works of NIST employees are not subject to copyright
6    * protection in the United States. This software may be subject to foreign
7    * copyright. Permission in the United States and in foreign countries, to the
8    * extent that NIST may hold copyright, to use, copy, modify, create derivative
9    * works, and distribute this software and its documentation without fee is hereby
10   * granted on a non-exclusive basis, provided that this notice and disclaimer
11   * of warranty appears in all copies.
12   *
13   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
19   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25   */
26  
27  package gov.nist.secauto.metaschema.core.model.constraint;
28  
29  import gov.nist.secauto.metaschema.core.metapath.DynamicContext;
30  import gov.nist.secauto.metaschema.core.metapath.ISequence;
31  import gov.nist.secauto.metaschema.core.metapath.MetapathException;
32  import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
33  
34  import java.util.List;
35  
36  import edu.umd.cs.findbugs.annotations.NonNull;
37  
38  public interface IConstraintValidationHandler {
39  
40    void handleCardinalityMinimumViolation(
41        @NonNull ICardinalityConstraint constraint,
42        @NonNull INodeItem node,
43        @NonNull ISequence<? extends INodeItem> targets);
44  
45    void handleCardinalityMaximumViolation(
46        @NonNull ICardinalityConstraint constraint,
47        @NonNull INodeItem node,
48        @NonNull ISequence<? extends INodeItem> targets);
49  
50    void handleIndexDuplicateViolation(
51        @NonNull IIndexConstraint constraint,
52        @NonNull INodeItem node);
53  
54    void handleIndexDuplicateKeyViolation(
55        @NonNull IIndexConstraint constraint,
56        @NonNull INodeItem node,
57        @NonNull INodeItem oldItem,
58        @NonNull INodeItem target);
59  
60    void handleUniqueKeyViolation(
61        @NonNull IUniqueConstraint constraint,
62        @NonNull INodeItem node,
63        @NonNull INodeItem oldItem,
64        @NonNull INodeItem target);
65  
66    void handleMatchPatternViolation(
67        @NonNull IMatchesConstraint constraint,
68        @NonNull INodeItem node,
69        @NonNull INodeItem target,
70        @NonNull String value);
71  
72    void handleMatchDatatypeViolation(
73        @NonNull IMatchesConstraint constraint,
74        @NonNull INodeItem node,
75        @NonNull INodeItem target,
76        @NonNull String value,
77        @NonNull IllegalArgumentException cause);
78  
79    void handleExpectViolation(
80        @NonNull IExpectConstraint constraint,
81        @NonNull INodeItem node,
82        @NonNull INodeItem target,
83        @NonNull DynamicContext metapathContext);
84  
85    void handleKeyMatchError(
86        @NonNull IKeyConstraint constraint,
87        @NonNull INodeItem node,
88        @NonNull INodeItem target,
89        @NonNull MetapathException ex);
90  
91    void handleIndexMiss(
92        @NonNull IIndexHasKeyConstraint constraint,
93        @NonNull INodeItem node,
94        @NonNull INodeItem target,
95        @NonNull List<String> key);
96  
97    void handleAllowedValuesViolation(
98        @NonNull List<IAllowedValuesConstraint> failedConstraints,
99        @NonNull INodeItem target);
100 }