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.core.model.constraint;
028
029import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline;
030import gov.nist.secauto.metaschema.core.metapath.MetapathExpression;
031
032import java.util.regex.Pattern;
033
034import edu.umd.cs.findbugs.annotations.NonNull;
035import edu.umd.cs.findbugs.annotations.Nullable;
036
037public class DefaultKeyField implements IKeyField {
038
039  @Nullable
040  private final Pattern pattern;
041  @NonNull
042  private final MetapathExpression target;
043  @Nullable
044  private final MarkupMultiline remarks;
045
046  /**
047   * Construct a new key field based on the provided target. An optional pattern
048   * can be used to extract a portion of the resulting key value.
049   *
050   * @param target
051   *          a Metapath expression identifying the target of the key field
052   * @param pattern
053   *          an optional used to extract a portion of the resulting key value
054   * @param remarks
055   *          optional remarks describing the intent of the constraint
056   */
057  public DefaultKeyField(
058      @NonNull MetapathExpression target,
059      @Nullable Pattern pattern,
060      @Nullable MarkupMultiline remarks) {
061    this.pattern = pattern;
062    this.target = target;
063    this.remarks = remarks;
064  }
065
066  @Override
067  public Pattern getPattern() {
068    return pattern;
069  }
070
071  @Override
072  public MetapathExpression getTarget() {
073    return target;
074  }
075
076  @Override
077  public MarkupMultiline getRemarks() {
078    return remarks;
079  }
080
081}