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 java.lang.annotation.Documented;
33 import java.lang.annotation.Retention;
34 import java.lang.annotation.Target;
35 import java.util.regex.Pattern;
36
37 import edu.umd.cs.findbugs.annotations.NonNull;
38
39 /**
40 * Identifies a Metapath expression referencing a value that is used in
41 * generating a key as part of a {@link IsUnique}, {@link Index}, or
42 * {@link IndexHasKey} constraint annotation.
43 */
44 @Documented
45 @Retention(RUNTIME)
46 @Target(ANNOTATION_TYPE)
47 public @interface KeyField {
48 /**
49 * An optional metapath that points to the target flag or field value that the
50 * key applies to. If omitted the target will be ".", which means the target is
51 * the value of the {@link BoundFlag}, {@link BoundField} or
52 * {@link MetaschemaFieldValue} annotation the constraint appears on. In the
53 * prior case, this annotation may only appear on a {@link BoundField} if the
54 * field has no flags, which results in a {@link BoundField} annotation on a
55 * field instance with a scalar, data type value.
56 *
57 * @return the target metapath
58 */
59 @NonNull
60 String target() default ".";
61
62 /**
63 * Retrieve an optional pattern to use to retrieve the value. If
64 * non-{@code null}, the first capturing group is used to retrieve the value.
65 * This must be a pattern that can compile using
66 * {@link Pattern#compile(String)}.
67 *
68 * @return a pattern string or an empty string if no pattern is provided
69 */
70 @NonNull
71 String pattern() default "";
72
73 /**
74 * Any remarks about the key field, encoded as an escaped Markdown string.
75 *
76 * @return an encoded markdown string or an empty string if no remarks are
77 * provided
78 */
79 @NonNull
80 String remarks() default "";
81 }