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.metapath.item.node; 28 29 import gov.nist.secauto.metaschema.core.metapath.format.IPathFormatter; 30 import gov.nist.secauto.metaschema.core.model.IModule; 31 import gov.nist.secauto.metaschema.core.model.ModuleScopeEnum; 32 33 import java.net.URI; 34 35 import edu.umd.cs.findbugs.annotations.NonNull; 36 37 /** 38 * Supports querying of global definitions and associated instances in a 39 * Metaschema module by effective name. 40 * <p> 41 * All definitions in the {@link ModuleScopeEnum#INHERITED} scope. This allows 42 * the exported structure of the Metaschema module to be queried. 43 */ 44 public interface IModuleNodeItem extends IDocumentNodeItem { 45 46 /** 47 * The Metaschema module this item is based on. 48 * 49 * @return the Metaschema module 50 */ 51 @NonNull 52 IModule getModule(); 53 54 @Override 55 default URI getDocumentUri() { 56 return getModule().getLocation(); 57 } 58 59 @Override 60 default NodeItemType getNodeItemType() { 61 return NodeItemType.METASCHEMA; 62 } 63 64 @Override 65 default IModuleNodeItem getNodeItem() { 66 return this; 67 } 68 69 @Override 70 default String format(@NonNull IPathFormatter formatter) { 71 return formatter.formatMetaschema(this); 72 } 73 74 @Override 75 default <RESULT, CONTEXT> RESULT accept(@NonNull INodeItemVisitor<RESULT, CONTEXT> visitor, CONTEXT context) { 76 return visitor.visitMetaschema(this, context); 77 } 78 }