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 class DefaultUniqueConstraint
44 extends AbstractKeyConstraint
45 implements IUniqueConstraint {
46
47 /**
48 * Create a new key-based constraint, which uses a set of key fields to build a
49 * key used to identify non-unique items.
50 *
51 * @param id
52 * the optional identifier for the constraint
53 * @param formalName
54 * the constraint's formal name or {@code null} if not provided
55 * @param description
56 * the constraint's semantic description or {@code null} if not
57 * provided
58 * @param source
59 * information about the constraint source
60 * @param level
61 * the significance of a violation of this constraint
62 * @param target
63 * the Metapath expression identifying the nodes the constraint targets
64 * @param properties
65 * a collection of associated properties
66 * @param keyFields
67 * a list of key fields associated with the constraint
68 * @param remarks
69 * optional remarks describing the intent of the constraint
70 */
71 public DefaultUniqueConstraint(
72 @Nullable String id,
73 @Nullable String formalName,
74 @Nullable MarkupLine description,
75 @NonNull ISource source,
76 @NonNull Level level,
77 @NonNull MetapathExpression target,
78 @NonNull Map<QName, Set<String>> properties,
79 @NonNull List<DefaultKeyField> keyFields,
80 @Nullable MarkupMultiline remarks) {
81 super(id, formalName, description, source, level, target, properties, keyFields, remarks);
82 }
83
84 @Override
85 public <T, R> R accept(IConstraintVisitor<T, R> visitor, T state) {
86 return visitor.visitUniqueConstraint(this, state);
87 }
88
89 @NonNull
90 public static Builder builder() {
91 return new Builder();
92 }
93
94 public static final class Builder
95 extends AbstractKeyConstraintBuilder<Builder, DefaultUniqueConstraint> {
96 private Builder() {
97 // disable construction
98 }
99
100 @Override
101 protected Builder getThis() {
102 return this;
103 }
104
105 @Override
106 protected DefaultUniqueConstraint newInstance() {
107 return new DefaultUniqueConstraint(
108 getId(),
109 getFormalName(),
110 getDescription(),
111 ObjectUtils.notNull(getSource()),
112 getLevel(),
113 getTarget(),
114 getProperties(),
115 getKeyFields(),
116 getRemarks());
117 }
118 }
119 }