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 class DefaultUniqueConstraint 044 extends AbstractKeyConstraint 045 implements IUniqueConstraint { 046 047 /** 048 * Create a new key-based constraint, which uses a set of key fields to build a 049 * key used to identify non-unique items. 050 * 051 * @param id 052 * the optional identifier for the constraint 053 * @param formalName 054 * the constraint's formal name or {@code null} if not provided 055 * @param description 056 * the constraint's semantic description or {@code null} if not 057 * provided 058 * @param source 059 * information about the constraint source 060 * @param level 061 * the significance of a violation of this constraint 062 * @param target 063 * the Metapath expression identifying the nodes the constraint targets 064 * @param properties 065 * a collection of associated properties 066 * @param keyFields 067 * a list of key fields associated with the constraint 068 * @param remarks 069 * optional remarks describing the intent of the constraint 070 */ 071 public DefaultUniqueConstraint( 072 @Nullable String id, 073 @Nullable String formalName, 074 @Nullable MarkupLine description, 075 @NonNull ISource source, 076 @NonNull Level level, 077 @NonNull MetapathExpression target, 078 @NonNull Map<QName, Set<String>> properties, 079 @NonNull List<DefaultKeyField> keyFields, 080 @Nullable MarkupMultiline remarks) { 081 super(id, formalName, description, source, level, target, properties, keyFields, remarks); 082 } 083 084 @Override 085 public <T, R> R accept(IConstraintVisitor<T, R> visitor, T state) { 086 return visitor.visitUniqueConstraint(this, state); 087 } 088 089 @NonNull 090 public static Builder builder() { 091 return new Builder(); 092 } 093 094 public static final class Builder 095 extends AbstractKeyConstraintBuilder<Builder, DefaultUniqueConstraint> { 096 private Builder() { 097 // disable construction 098 } 099 100 @Override 101 protected Builder getThis() { 102 return this; 103 } 104 105 @Override 106 protected DefaultUniqueConstraint newInstance() { 107 return new DefaultUniqueConstraint( 108 getId(), 109 getFormalName(), 110 getDescription(), 111 ObjectUtils.notNull(getSource()), 112 getLevel(), 113 getTarget(), 114 getProperties(), 115 getKeyFields(), 116 getRemarks()); 117 } 118 } 119}