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.databind.model.annotations;
28
29 import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
30 import static java.lang.annotation.RetentionPolicy.RUNTIME;
31
32 import gov.nist.secauto.metaschema.core.model.constraint.IConstraint;
33 import gov.nist.secauto.metaschema.core.model.constraint.IConstraint.Level;
34
35 import java.lang.annotation.Documented;
36 import java.lang.annotation.Retention;
37 import java.lang.annotation.Target;
38
39 import edu.umd.cs.findbugs.annotations.NonNull;
40
41 /**
42 * This annotation defines a rule that requires uniqueness among the target
43 * contents of the assembly represented by the containing
44 * {@link MetaschemaAssembly} annotation.
45 */
46 @Documented
47 @Retention(RUNTIME)
48 @Target(ANNOTATION_TYPE)
49 public @interface IsUnique {
50 /**
51 * An optional identifier for the constraint, which must be unique to only this
52 * constraint.
53 *
54 * @return the identifier if provided or an empty string otherwise
55 */
56 @NonNull
57 String id() default "";
58
59 /**
60 * An optional formal name for the constraint.
61 *
62 * @return the formal name if provided or an empty string otherwise
63 */
64 @NonNull
65 String formalName() default "";
66
67 /**
68 * An optional description of the constraint.
69 *
70 * @return the description if provided or an empty string otherwise
71 */
72 @NonNull
73 String description() default "";
74
75 /**
76 * The significance of a violation of this constraint.
77 *
78 * @return the level
79 */
80 @NonNull
81 Level level() default IConstraint.Level.ERROR;
82
83 /**
84 * An optional metapath that points to the target flag or field value that the
85 * constraint applies to. If omitted the target will be ".", which means the
86 * target is the value of the {@link BoundFlag}, {@link BoundField} or
87 * {@link MetaschemaFieldValue} annotation the constraint appears on. In the
88 * prior case, this annotation may only appear on a {@link BoundField} if the
89 * field has no flags, which results in a {@link BoundField} annotation on a
90 * field instance with a scalar, data type value.
91 *
92 * @return the target metapath
93 */
94 @NonNull
95 String target() default ".";
96
97 /**
98 * An optional set of properties associated with these allowed values.
99 *
100 * @return the properties or an empty array with no properties
101 */
102 Property[] properties() default {};
103
104 /**
105 * A list of one or more keys to use in looking up an entry in a given index.
106 *
107 * @return one or more keys
108 */
109 @NonNull
110 KeyField[] keyFields();
111
112 /**
113 * The message to emit when the constraint is violated.
114 *
115 * @return the message or an empty string otherwise
116 */
117 @NonNull
118 String message() default "";
119
120 /**
121 * Any remarks about the constraint, encoded as an escaped Markdown string.
122 *
123 * @return an encoded markdown string or an empty string if no remarks are
124 * provided
125 */
126 @NonNull
127 String remarks() default "";
128 }