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.core.model.constraint; 28 29 import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline; 30 import gov.nist.secauto.metaschema.core.metapath.MetapathExpression; 31 32 import java.util.regex.Pattern; 33 34 import edu.umd.cs.findbugs.annotations.NonNull; 35 import edu.umd.cs.findbugs.annotations.Nullable; 36 37 /** 38 * Represents a component of a key used in a key-based index. 39 * <p> 40 * A key field is targeted at a Metaschema field or flag data object's value. An 41 * optional pattern can be used to extract a portion of the value for use in 42 * generating an index key. 43 */ 44 public interface IKeyField { 45 @NonNull 46 MetapathExpression getTarget(); 47 48 /** 49 * A pattern to use to retrieve the value. If non-{@code null}, the first 50 * capturing group is used to retrieve the value. 51 * 52 * @return a pattern to use to get the value or {@code null} if the full value 53 * is to be used 54 */ 55 @Nullable 56 Pattern getPattern(); 57 58 /** 59 * Any remarks about the key field as markup text. 60 * 61 * @return markup text or {@code null} if no text is provided 62 */ 63 @Nullable 64 MarkupMultiline getRemarks(); 65 }