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.MarkupLine;
030import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline;
031import gov.nist.secauto.metaschema.core.metapath.MetapathExpression;
032import gov.nist.secauto.metaschema.core.util.CollectionUtil;
033
034import java.util.LinkedList;
035import java.util.List;
036import java.util.Map;
037import java.util.Set;
038
039import javax.xml.namespace.QName;
040
041import edu.umd.cs.findbugs.annotations.NonNull;
042import edu.umd.cs.findbugs.annotations.Nullable;
043
044public abstract class AbstractKeyConstraint
045    extends AbstractConstraint
046    implements IKeyConstraint {
047  @NonNull
048  private final List<DefaultKeyField> keyFields;
049
050  /**
051   * Create a new key-based constraint, which uses a set of key fields to build a
052   * key.
053   *
054   * @param id
055   *          the optional identifier for the constraint
056   * @param formalName
057   *          the constraint's formal name or {@code null} if not provided
058   * @param description
059   *          the constraint's semantic description or {@code null} if not
060   *          provided
061   * @param source
062   *          information about the constraint source
063   * @param level
064   *          the significance of a violation of this constraint
065   * @param target
066   *          the Metapath expression identifying the nodes the constraint targets
067   * @param properties
068   *          a collection of associated properties
069   * @param keyFields
070   *          a list of key fields associated with the constraint
071   * @param remarks
072   *          optional remarks describing the intent of the constraint
073   */
074  protected AbstractKeyConstraint(
075      @Nullable String id,
076      @Nullable String formalName,
077      @Nullable MarkupLine description,
078      @NonNull ISource source,
079      @NonNull Level level,
080      @NonNull MetapathExpression target,
081      @NonNull Map<QName, Set<String>> properties,
082      @NonNull List<DefaultKeyField> keyFields,
083      @Nullable MarkupMultiline remarks) {
084    super(id, formalName, description, source, level, target, properties, remarks);
085    if (keyFields.isEmpty()) {
086      throw new IllegalArgumentException("an empty list of key fields is not allowed");
087    }
088    this.keyFields = keyFields;
089  }
090
091  @Override
092  public List<DefaultKeyField> getKeyFields() {
093    return keyFields;
094  }
095
096  public abstract static class AbstractKeyConstraintBuilder<
097      T extends AbstractKeyConstraintBuilder<T,
098          R>,
099      R extends AbstractKeyConstraint>
100      extends AbstractConstraintBuilder<T, R> {
101    @NonNull
102    private final List<DefaultKeyField> keyFields = new LinkedList<>();
103
104    public T keyField(@NonNull DefaultKeyField keyField) {
105      this.keyFields.add(keyField);
106      return getThis();
107    }
108
109    @NonNull
110    protected List<DefaultKeyField> getKeyFields() {
111      return keyFields;
112    }
113
114    @Override
115    protected void validate() {
116      super.validate();
117
118      CollectionUtil.requireNonEmpty(getKeyFields());
119    }
120  }
121}