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 that the target contents of the
43 * assembly, represented by the containing {@link MetaschemaAssembly}
44 * annotation, reference items in a name index defined by the {@link Index}
45 * constraint.
46 */
47
48 @Documented
49 @Retention(RUNTIME)
50 @Target(ANNOTATION_TYPE)
51 public @interface IndexHasKey {
52 /**
53 * An optional identifier for the constraint, which must be unique to only this
54 * constraint.
55 *
56 * @return the identifier if provided or an empty string otherwise
57 */
58 @NonNull
59 String id() default "";
60
61 /**
62 * An optional formal name for the constraint.
63 *
64 * @return the formal name if provided or an empty string otherwise
65 */
66 @NonNull
67 String formalName() default "";
68
69 /**
70 * An optional description of the constraint.
71 *
72 * @return the description if provided or an empty string otherwise
73 */
74 @NonNull
75 String description() default "";
76
77 /**
78 * The significance of a violation of this constraint.
79 *
80 * @return the level
81 */
82 @NonNull
83 Level level() default IConstraint.Level.ERROR;
84
85 /**
86 * An optional metapath that points to the target flag or field value that the
87 * constraint applies to. If omitted the target will be ".", which means the
88 * target is the value of the {@link BoundFlag}, {@link BoundField} or
89 * {@link MetaschemaFieldValue} annotation the constraint appears on. In the
90 * prior case, this annotation may only appear on a {@link BoundField} if the
91 * field has no flags, which results in a {@link BoundField} annotation on a
92 * field instance with a scalar, data type value.
93 *
94 * @return the target metapath
95 */
96 @NonNull
97 String target() default ".";
98
99 /**
100 * An optional set of properties associated with these allowed values.
101 *
102 * @return the properties or an empty array with no properties
103 */
104 Property[] properties() default {};
105
106 /**
107 * A reference to a named index.
108 *
109 * @return the index name
110 */
111 @NonNull
112 String indexName();
113
114 /**
115 * A list of one or more keys to use in looking up an entry in a given index.
116 *
117 * @return one or more keys
118 */
119 @NonNull
120 KeyField[] keyFields();
121
122 /**
123 * The message to emit when the constraint is violated.
124 *
125 * @return the message or an empty string otherwise
126 */
127 @NonNull
128 String message() default "";
129
130 /**
131 * Any remarks about the constraint, encoded as an escaped Markdown string.
132 *
133 * @return an encoded markdown string or an empty string if no remarks are
134 * provided
135 */
136 @NonNull
137 String remarks() default "";
138 }