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.datatype.markup.MarkupLine;
30 import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline;
31 import gov.nist.secauto.metaschema.core.metapath.MetapathExpression;
32 import gov.nist.secauto.metaschema.core.util.CollectionUtil;
33
34 import java.util.LinkedList;
35 import java.util.List;
36 import java.util.Map;
37 import java.util.Set;
38
39 import javax.xml.namespace.QName;
40
41 import edu.umd.cs.findbugs.annotations.NonNull;
42 import edu.umd.cs.findbugs.annotations.Nullable;
43
44 public abstract class AbstractKeyConstraint
45 extends AbstractConstraint
46 implements IKeyConstraint {
47 @NonNull
48 private final List<DefaultKeyField> keyFields;
49
50 /**
51 * Create a new key-based constraint, which uses a set of key fields to build a
52 * key.
53 *
54 * @param id
55 * the optional identifier for the constraint
56 * @param formalName
57 * the constraint's formal name or {@code null} if not provided
58 * @param description
59 * the constraint's semantic description or {@code null} if not
60 * provided
61 * @param source
62 * information about the constraint source
63 * @param level
64 * the significance of a violation of this constraint
65 * @param target
66 * the Metapath expression identifying the nodes the constraint targets
67 * @param properties
68 * a collection of associated properties
69 * @param keyFields
70 * a list of key fields associated with the constraint
71 * @param remarks
72 * optional remarks describing the intent of the constraint
73 */
74 protected AbstractKeyConstraint(
75 @Nullable String id,
76 @Nullable String formalName,
77 @Nullable MarkupLine description,
78 @NonNull ISource source,
79 @NonNull Level level,
80 @NonNull MetapathExpression target,
81 @NonNull Map<QName, Set<String>> properties,
82 @NonNull List<DefaultKeyField> keyFields,
83 @Nullable MarkupMultiline remarks) {
84 super(id, formalName, description, source, level, target, properties, remarks);
85 if (keyFields.isEmpty()) {
86 throw new IllegalArgumentException("an empty list of key fields is not allowed");
87 }
88 this.keyFields = keyFields;
89 }
90
91 @Override
92 public List<DefaultKeyField> getKeyFields() {
93 return keyFields;
94 }
95
96 public abstract static class AbstractKeyConstraintBuilder<
97 T extends AbstractKeyConstraintBuilder<T,
98 R>,
99 R extends AbstractKeyConstraint>
100 extends AbstractConstraintBuilder<T, R> {
101 @NonNull
102 private final List<DefaultKeyField> keyFields = new LinkedList<>();
103
104 public T keyField(@NonNull DefaultKeyField keyField) {
105 this.keyFields.add(keyField);
106 return getThis();
107 }
108
109 @NonNull
110 protected List<DefaultKeyField> getKeyFields() {
111 return keyFields;
112 }
113
114 @Override
115 protected void validate() {
116 super.validate();
117
118 CollectionUtil.requireNonEmpty(getKeyFields());
119 }
120 }
121 }