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; 028 029import gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureModelConstrained; 030 031import javax.xml.namespace.QName; 032 033public interface IAssemblyDefinition 034 extends IFlagContainer, IModelContainer, IAssembly, IFeatureModelConstrained { 035 036 /** 037 * Check if the assembly is a top-level root assembly. 038 * 039 * @return {@code true} if the assembly is a top-level root, or {@code false} 040 * otherwise 041 */ 042 boolean isRoot(); 043 044 /** 045 * Get the root name if this assembly is a top-level root. 046 * 047 * @return the root name if this assembly is a top-level root, or {@code null} 048 * otherwise 049 */ 050 String getRootName(); 051 052 /** 053 * Get the XML qualified name to use in XML as the root element. 054 * 055 * @return the root XML qualified name if this assembly is a top-level root, or 056 * {@code null} otherwise 057 */ 058 default QName getRootXmlQName() { 059 QName retval = null; 060 String rootName = getRootName(); 061 if (rootName != null) { 062 retval = new QName(getContainingModule().getXmlNamespace().toASCIIString(), rootName); 063 } 064 return retval; 065 } 066 067 /** 068 * Get the name used for the associated property in JSON/YAML. 069 * 070 * @return the root JSON property name if this assembly is a top-level root, or 071 * {@code null} otherwise 072 */ 073 default String getRootJsonName() { 074 return getRootName(); 075 } 076 077 @Override 078 IAssemblyInstance getInlineInstance(); 079 080 @Override 081 default IAssemblyDefinition getOwningDefinition() { 082 return this; 083 } 084 085 @Override 086 default boolean isSimple() { 087 return IFlagContainer.super.isSimple() && getModelInstances().isEmpty(); 088 } 089 090}