001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.databind.model.annotations; 028 029import static java.lang.annotation.ElementType.ANNOTATION_TYPE; 030import static java.lang.annotation.RetentionPolicy.RUNTIME; 031 032import gov.nist.secauto.metaschema.core.model.constraint.IConstraint; 033import gov.nist.secauto.metaschema.core.model.constraint.IConstraint.Level; 034 035import java.lang.annotation.Documented; 036import java.lang.annotation.Retention; 037import java.lang.annotation.Target; 038 039import edu.umd.cs.findbugs.annotations.NonNull; 040 041/** 042 * This annotation defines a rule that requires that the target contents of the 043 * assembly, represented by the containing {@link MetaschemaAssembly} 044 * annotation, reference items in a name index defined by the {@link Index} 045 * constraint. 046 */ 047 048@Documented 049@Retention(RUNTIME) 050@Target(ANNOTATION_TYPE) 051public @interface IndexHasKey { 052 /** 053 * An optional identifier for the constraint, which must be unique to only this 054 * constraint. 055 * 056 * @return the identifier if provided or an empty string otherwise 057 */ 058 @NonNull 059 String id() default ""; 060 061 /** 062 * An optional formal name for the constraint. 063 * 064 * @return the formal name if provided or an empty string otherwise 065 */ 066 @NonNull 067 String formalName() default ""; 068 069 /** 070 * An optional description of the constraint. 071 * 072 * @return the description if provided or an empty string otherwise 073 */ 074 @NonNull 075 String description() default ""; 076 077 /** 078 * The significance of a violation of this constraint. 079 * 080 * @return the level 081 */ 082 @NonNull 083 Level level() default IConstraint.Level.ERROR; 084 085 /** 086 * An optional metapath that points to the target flag or field value that the 087 * constraint applies to. If omitted the target will be ".", which means the 088 * target is the value of the {@link BoundFlag}, {@link BoundField} or 089 * {@link MetaschemaFieldValue} annotation the constraint appears on. In the 090 * prior case, this annotation may only appear on a {@link BoundField} if the 091 * field has no flags, which results in a {@link BoundField} annotation on a 092 * field instance with a scalar, data type value. 093 * 094 * @return the target metapath 095 */ 096 @NonNull 097 String target() default "."; 098 099 /** 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}