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.ObjectUtils;
033
034import java.util.List;
035import java.util.Map;
036import java.util.Set;
037
038import javax.xml.namespace.QName;
039
040import edu.umd.cs.findbugs.annotations.NonNull;
041import edu.umd.cs.findbugs.annotations.Nullable;
042
043public final class DefaultIndexConstraint
044    extends AbstractKeyConstraint
045    implements IIndexConstraint {
046  @NonNull
047  private final String name;
048
049  /**
050   * Create a index constraint, which uses a set of key fields to build a key.
051   *
052   * @param id
053   *          the optional identifier for the constraint
054   * @param formalName
055   *          the constraint's formal name or {@code null} if not provided
056   * @param description
057   *          the constraint's semantic description or {@code null} if not
058   *          provided
059   * @param source
060   *          information about the constraint source
061   * @param level
062   *          the significance of a violation of this constraint
063   * @param target
064   *          the Metapath expression identifying the nodes the constraint targets
065   * @param properties
066   *          a collection of associated properties
067   * @param name
068   *          the name of the index
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  private DefaultIndexConstraint(
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 String name,
083      @NonNull List<DefaultKeyField> keyFields,
084      @Nullable MarkupMultiline remarks) {
085    super(id, formalName, description, source, level, target, properties, keyFields, remarks);
086    if (name.isBlank()) {
087      throw new IllegalArgumentException("The index name must be a non-blank string");
088    }
089    this.name = name;
090  }
091
092  @Override
093  public String getName() {
094    return name;
095  }
096
097  @Override
098  public <T, R> R accept(IConstraintVisitor<T, R> visitor, T state) {
099    return visitor.visitIndexConstraint(this, state);
100  }
101
102  @NonNull
103  public static Builder builder() {
104    return new Builder();
105  }
106
107  public static final class Builder
108      extends AbstractKeyConstraintBuilder<Builder, DefaultIndexConstraint> {
109    private String name;
110
111    private Builder() {
112      // disable construction
113    }
114
115    public Builder name(@NonNull String name) {
116      this.name = name;
117      return this;
118    }
119
120    @Override
121    protected Builder getThis() {
122      return this;
123    }
124
125    @Override
126    protected void validate() {
127      super.validate();
128
129      ObjectUtils.requireNonNull(name);
130    }
131
132    protected String getName() {
133      return name;
134    }
135
136    @Override
137    protected DefaultIndexConstraint newInstance() {
138      return new DefaultIndexConstraint(
139          getId(),
140          getFormalName(),
141          getDescription(),
142          ObjectUtils.notNull(getSource()),
143          getLevel(),
144          getTarget(),
145          getProperties(),
146          ObjectUtils.notNull(getName()),
147          getKeyFields(),
148          getRemarks());
149    }
150  }
151}