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.ObjectUtils;
33
34 import java.util.List;
35 import java.util.Map;
36 import java.util.Set;
37
38 import javax.xml.namespace.QName;
39
40 import edu.umd.cs.findbugs.annotations.NonNull;
41 import edu.umd.cs.findbugs.annotations.Nullable;
42
43 public final class DefaultIndexHasKeyConstraint
44 extends AbstractKeyConstraint
45 implements IIndexHasKeyConstraint {
46 @NonNull
47 private final String indexName;
48
49 /**
50 * Create a key reference constraint, which uses a set of key fields to build a
51 * key to match against an index.
52 *
53 * @param id
54 * the optional identifier for the constraint
55 * @param formalName
56 * the constraint's formal indexName or {@code null} if not provided
57 * @param description
58 * the constraint's semantic description or {@code null} if not
59 * provided
60 * @param source
61 * information about the constraint source
62 * @param level
63 * the significance of a violation of this constraint
64 * @param target
65 * the Metapath expression identifying the nodes the constraint targets
66 * @param properties
67 * a collection of associated properties
68 * @param indexName
69 * a reference to the indexName of the index
70 * @param keyFields
71 * a list of key fields associated with the constraint
72 * @param remarks
73 * optional remarks describing the intent of the constraint
74 */
75 private DefaultIndexHasKeyConstraint(
76 @Nullable String id,
77 @Nullable String formalName,
78 @Nullable MarkupLine description,
79 @NonNull ISource source,
80 @NonNull Level level,
81 @NonNull MetapathExpression target,
82 @NonNull Map<QName, Set<String>> properties,
83 @NonNull String indexName,
84 @NonNull List<DefaultKeyField> keyFields,
85 @Nullable MarkupMultiline remarks) {
86 super(id, formalName, description, source, level, target, properties, keyFields, remarks);
87 if (indexName.isBlank()) {
88 throw new IllegalArgumentException("The index indexName must be a non-blank string");
89 }
90 this.indexName = indexName;
91 }
92
93 @Override
94 public String getIndexName() {
95 return indexName;
96 }
97
98 @Override
99 public <T, R> R accept(IConstraintVisitor<T, R> visitor, T state) {
100 return visitor.visitIndexHasKeyConstraint(this, state);
101 }
102
103 @NonNull
104 public static Builder builder() {
105 return new Builder();
106 }
107
108 public static final class Builder
109 extends AbstractKeyConstraintBuilder<Builder, DefaultIndexHasKeyConstraint> {
110 private String indexName;
111
112 private Builder() {
113 // disable construction
114 }
115
116 public Builder name(@NonNull String name) {
117 this.indexName = name;
118 return this;
119 }
120
121 @Override
122 protected Builder getThis() {
123 return this;
124 }
125
126 @Override
127 protected void validate() {
128 super.validate();
129
130 ObjectUtils.requireNonNull(indexName);
131 }
132
133 protected String getIndexName() {
134 return indexName;
135 }
136
137 @Override
138 protected DefaultIndexHasKeyConstraint newInstance() {
139 return new DefaultIndexHasKeyConstraint(
140 getId(),
141 getFormalName(),
142 getDescription(),
143 ObjectUtils.notNull(getSource()),
144 getLevel(),
145 getTarget(),
146 getProperties(),
147 ObjectUtils.notNull(getIndexName()),
148 getKeyFields(),
149 getRemarks());
150 }
151 }
152 }