1 /* 2 * Portions of this software was developed by employees of the National Institute 3 * of Standards and Technology (NIST), an agency of the Federal Government and is 4 * being made available as a public service. Pursuant to title 17 United States 5 * Code Section 105, works of NIST employees are not subject to copyright 6 * protection in the United States. This software may be subject to foreign 7 * copyright. Permission in the United States and in foreign countries, to the 8 * extent that NIST may hold copyright, to use, copy, modify, create derivative 9 * works, and distribute this software and its documentation without fee is hereby 10 * granted on a non-exclusive basis, provided that this notice and disclaimer 11 * of warranty appears in all copies. 12 * 13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 25 */ 26 27 package gov.nist.secauto.metaschema.core.model; 28 29 import gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureModelConstrained; 30 31 import javax.xml.namespace.QName; 32 33 public interface IAssemblyDefinition 34 extends IFlagContainer, IModelContainer, IAssembly, IFeatureModelConstrained { 35 36 /** 37 * Check if the assembly is a top-level root assembly. 38 * 39 * @return {@code true} if the assembly is a top-level root, or {@code false} 40 * otherwise 41 */ 42 boolean isRoot(); 43 44 /** 45 * Get the root name if this assembly is a top-level root. 46 * 47 * @return the root name if this assembly is a top-level root, or {@code null} 48 * otherwise 49 */ 50 String getRootName(); 51 52 /** 53 * Get the XML qualified name to use in XML as the root element. 54 * 55 * @return the root XML qualified name if this assembly is a top-level root, or 56 * {@code null} otherwise 57 */ 58 default QName getRootXmlQName() { 59 QName retval = null; 60 String rootName = getRootName(); 61 if (rootName != null) { 62 retval = new QName(getContainingModule().getXmlNamespace().toASCIIString(), rootName); 63 } 64 return retval; 65 } 66 67 /** 68 * Get the name used for the associated property in JSON/YAML. 69 * 70 * @return the root JSON property name if this assembly is a top-level root, or 71 * {@code null} otherwise 72 */ 73 default String getRootJsonName() { 74 return getRootName(); 75 } 76 77 @Override 78 IAssemblyInstance getInlineInstance(); 79 80 @Override 81 default IAssemblyDefinition getOwningDefinition() { 82 return this; 83 } 84 85 @Override 86 default boolean isSimple() { 87 return IFlagContainer.super.isSimple() && getModelInstances().isEmpty(); 88 } 89 90 }