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.metapath.item.node; 028 029import gov.nist.secauto.metaschema.core.metapath.format.IPathFormatter; 030import gov.nist.secauto.metaschema.core.model.IModule; 031import gov.nist.secauto.metaschema.core.model.ModuleScopeEnum; 032 033import java.net.URI; 034 035import edu.umd.cs.findbugs.annotations.NonNull; 036 037/** 038 * Supports querying of global definitions and associated instances in a 039 * Metaschema module by effective name. 040 * <p> 041 * All definitions in the {@link ModuleScopeEnum#INHERITED} scope. This allows 042 * the exported structure of the Metaschema module to be queried. 043 */ 044public interface IModuleNodeItem extends IDocumentNodeItem { 045 046 /** 047 * The Metaschema module this item is based on. 048 * 049 * @return the Metaschema module 050 */ 051 @NonNull 052 IModule getModule(); 053 054 @Override 055 default URI getDocumentUri() { 056 return getModule().getLocation(); 057 } 058 059 @Override 060 default NodeItemType getNodeItemType() { 061 return NodeItemType.METASCHEMA; 062 } 063 064 @Override 065 default IModuleNodeItem getNodeItem() { 066 return this; 067 } 068 069 @Override 070 default String format(@NonNull IPathFormatter formatter) { 071 return formatter.formatMetaschema(this); 072 } 073 074 @Override 075 default <RESULT, CONTEXT> RESULT accept(@NonNull INodeItemVisitor<RESULT, CONTEXT> visitor, CONTEXT context) { 076 return visitor.visitMetaschema(this, context); 077 } 078}