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 public class DefaultKeyField implements IKeyField {
38
39 @Nullable
40 private final Pattern pattern;
41 @NonNull
42 private final MetapathExpression target;
43 @Nullable
44 private final MarkupMultiline remarks;
45
46 /**
47 * Construct a new key field based on the provided target. An optional pattern
48 * can be used to extract a portion of the resulting key value.
49 *
50 * @param target
51 * a Metapath expression identifying the target of the key field
52 * @param pattern
53 * an optional used to extract a portion of the resulting key value
54 * @param remarks
55 * optional remarks describing the intent of the constraint
56 */
57 public DefaultKeyField(
58 @NonNull MetapathExpression target,
59 @Nullable Pattern pattern,
60 @Nullable MarkupMultiline remarks) {
61 this.pattern = pattern;
62 this.target = target;
63 this.remarks = remarks;
64 }
65
66 @Override
67 public Pattern getPattern() {
68 return pattern;
69 }
70
71 @Override
72 public MetapathExpression getTarget() {
73 return target;
74 }
75
76 @Override
77 public MarkupMultiline getRemarks() {
78 return remarks;
79 }
80
81 }