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.metapath.MetapathExpression.ResultType; 031import gov.nist.secauto.metaschema.core.metapath.item.node.IDefinitionNodeItem; 032import gov.nist.secauto.metaschema.core.metapath.item.node.IModuleNodeItem; 033import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem; 034import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItemFactory; 035import gov.nist.secauto.metaschema.core.model.IDefinition; 036import gov.nist.secauto.metaschema.core.model.IModule; 037import gov.nist.secauto.metaschema.core.model.MetaschemaException; 038import gov.nist.secauto.metaschema.core.util.ObjectUtils; 039 040import java.util.Collection; 041import java.util.List; 042import java.util.Map; 043import java.util.Set; 044import java.util.stream.Collectors; 045import java.util.stream.Stream; 046 047import javax.xml.namespace.QName; 048 049import edu.umd.cs.findbugs.annotations.NonNull; 050 051public interface IConstraintSet { 052 053 @NonNull 054 static Set<IConstraintSet> resolveConstraintSets(@NonNull Set<IConstraintSet> constraintSets) { 055 return ObjectUtils.notNull(constraintSets.stream() 056 .flatMap(set -> resolveConstraintSet(ObjectUtils.notNull(set))) 057 .distinct() 058 .collect(Collectors.toUnmodifiableSet())); 059 } 060 061 @NonNull 062 private static Stream<IConstraintSet> resolveConstraintSet(@NonNull IConstraintSet constraintSet) { 063 return ObjectUtils.notNull(Stream.concat( 064 Stream.of(constraintSet), 065 constraintSet.getImportedConstraintSets().stream())); 066 } 067 068 @NonNull 069 static List<ITargetedConstaints> getTargetedConstraintsForMetaschema( 070 @NonNull Set<IConstraintSet> constraintSets, 071 @NonNull IModule module) { 072 return ObjectUtils.notNull(resolveConstraintSets(constraintSets).stream() 073 .flatMap(set -> set.getTargetedConstraintsForModule(module)) 074 .collect(Collectors.toUnmodifiableList())); 075 } 076 077 @NonNull 078 Stream<ITargetedConstaints> getTargetedConstraintsForModule(@NonNull IModule module); 079 080 static void applyConstraintSetToModule( 081 @NonNull Set<IConstraintSet> constraintSets, 082 @NonNull IModule module) throws MetaschemaException { 083 Set<IConstraintSet> resolvedConstraintSets = resolveConstraintSets(constraintSets); 084 085 ConstraintComposingVisitor visitor = new ConstraintComposingVisitor(); 086 IModuleNodeItem item = INodeItemFactory.instance().newModuleNodeItem(module); 087 088 for (ITargetedConstaints targeted : getTargetedConstraintsForMetaschema(resolvedConstraintSets, module)) { 089 MetapathExpression targetExpression = targeted.getTargetExpression(); 090 INodeItem node = targetExpression.evaluateAs(item, ResultType.NODE); 091 if (node == null) { 092 throw new MetaschemaException(String.format("Target not found for expression '%s' on metaschema '%s'.", 093 targetExpression.getPath(), 094 module.getQName())); 095 } else if (node instanceof IDefinitionNodeItem) { 096 IDefinition nodeDefinition = ((IDefinitionNodeItem<?, ?>) node).getDefinition(); 097 IModule nodeModule = nodeDefinition.getContainingModule(); 098 if (!module.equals(nodeModule)) { 099 throw new MetaschemaException( 100 String.format("Target definition '%s' in metaschema '%s' is not in the scoped metaschema '%s'.", 101 nodeDefinition.getName(), 102 nodeModule.getQName(), 103 module.getQName())); 104 } 105 } 106 node.accept(visitor, targeted); 107 } 108 109 } 110 111 Collection<IConstraintSet> getImportedConstraintSets(); 112 113 /** 114 * Get the set of Metaschema scoped constraints to apply by a {@link QName} 115 * formed from the Metaschema namespace and short name. 116 * 117 * @return the mapping of QName to scoped constraints 118 */ 119 @NonNull 120 Map<QName, List<IScopedContraints>> getScopedContraints(); 121}