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