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.metapath.MetapathExpression;
030import gov.nist.secauto.metaschema.core.model.IAssemblyDefinition;
031import gov.nist.secauto.metaschema.core.model.IDefinition;
032import gov.nist.secauto.metaschema.core.model.IFieldDefinition;
033import gov.nist.secauto.metaschema.core.model.IFlagDefinition;
034import gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained;
035
036import java.util.Locale;
037
038import edu.umd.cs.findbugs.annotations.NonNull;
039
040/**
041 * Provides an base implementation for a set of external constraints that target
042 * a given definition using a target Metapath expression.
043 *
044 * @param <T>
045 *          the type of the constraint container
046 */
047public abstract class AbstractTargetedConstraints<T extends IValueConstrained>
048    implements ITargetedConstaints, IFeatureValueConstrained {
049  @NonNull
050  private final MetapathExpression targetExpression;
051  @NonNull
052  private final T constraints;
053
054  public AbstractTargetedConstraints(
055      @NonNull MetapathExpression targetExpression,
056      @NonNull T constraints) {
057    this.targetExpression = targetExpression;
058    this.constraints = constraints;
059  }
060
061  @Override
062  public MetapathExpression getTargetExpression() {
063    return targetExpression;
064  }
065
066  @Override
067  public T getConstraintSupport() {
068    return constraints;
069  }
070
071  @SuppressWarnings("null")
072  protected void applyTo(@NonNull IDefinition definition) {
073    getAllowedValuesConstraints().forEach(constraint -> definition.addConstraint(constraint));
074    getMatchesConstraints().forEach(constraint -> definition.addConstraint(constraint));
075    getIndexHasKeyConstraints().forEach(constraint -> definition.addConstraint(constraint));
076    getExpectConstraints().forEach(constraint -> definition.addConstraint(constraint));
077  }
078
079  @Override
080  public void target(@NonNull IFlagDefinition definition) {
081    throw new IllegalStateException(
082        String.format("The targeted definition '%s' from metaschema '%s' is not a %s definition.",
083            definition.getEffectiveName(),
084            definition.getContainingModule().getQName().toString(),
085            definition.getModelType().name().toLowerCase(Locale.ROOT)));
086  }
087
088  @Override
089  public void target(@NonNull IFieldDefinition definition) {
090    throw new IllegalStateException(
091        String.format("The targeted definition '%s' from metaschema '%s' is not a %s definition.",
092            definition.getEffectiveName(),
093            definition.getContainingModule().getQName().toString(),
094            definition.getModelType().name().toLowerCase(Locale.ROOT)));
095  }
096
097  @Override
098  public void target(@NonNull IAssemblyDefinition definition) {
099    throw new IllegalStateException(
100        String.format("The targeted definition '%s' from metaschema '%s' is not a %s definition.",
101            definition.getEffectiveName(),
102            definition.getContainingModule().getQName().toString(),
103            definition.getModelType().name().toLowerCase(Locale.ROOT)));
104  }
105}