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 unqiue index over the contents of the assembly 043 * represented by the containing {@link MetaschemaAssembly} annotation. 044 */ 045@Documented 046@Retention(RUNTIME) 047@Target(ANNOTATION_TYPE) 048public @interface Index { 049 /** 050 * An optional identifier for the constraint, which must be unique to only this 051 * constraint. 052 * 053 * @return the identifier if provided or an empty string otherwise 054 */ 055 @NonNull 056 String id() default ""; 057 058 /** 059 * An optional formal name for the constraint. 060 * 061 * @return the formal name if provided or an empty string otherwise 062 */ 063 @NonNull 064 String formalName() default ""; 065 066 /** 067 * An optional description of the constraint. 068 * 069 * @return the description if provided or an empty string otherwise 070 */ 071 @NonNull 072 String description() default ""; 073 074 /** 075 * The significance of a violation of this constraint. 076 * 077 * @return the level 078 */ 079 @NonNull 080 Level level() default IConstraint.Level.ERROR; 081 082 /** 083 * An optional metapath that points to the target flag or field value that the 084 * constraint applies to. If omitted the target will be ".", which means the 085 * target is the value of the {@link BoundFlag}, {@link BoundField} or 086 * {@link MetaschemaFieldValue} annotation the constraint appears on. In the 087 * prior case, this annotation may only appear on a {@link BoundField} if the 088 * field has no flags, which results in a {@link BoundField} annotation on a 089 * field instance with a scalar, data type value. 090 * 091 * @return the target metapath 092 */ 093 @NonNull 094 String target() default "."; 095 096 /** 097 * An optional set of properties associated with these allowed values. 098 * 099 * @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}