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 edu.umd.cs.findbugs.annotations.NonNull; 030 031/** 032 * This marker interface indicates that this object is an instance. 033 */ 034public interface IInstance extends IModelElement { 035 /** 036 * Retrieve the Metaschema definition on which the instance was declared. 037 * 038 * @return the Metaschema definition on which the instance was declared 039 */ 040 @NonNull 041 IFlagContainer getContainingDefinition(); 042 043 /** 044 * Get the parent model definition that serves as the container of this 045 * instance. 046 * 047 * @return the container 048 */ 049 @NonNull 050 IContainer getParentContainer(); 051 052 @Override 053 default IModule getContainingModule() { 054 return getContainingDefinition().getContainingModule(); 055 } 056 057 /** 058 * Generates a "coordinate" string for the provided information element 059 * instance. 060 * 061 * A coordinate consists of the element's: 062 * <ul> 063 * <li>containing Metaschema module's short name</li> 064 * <li>model type</li> 065 * <li>name</li> 066 * <li>hash code</li> 067 * <li>the hash code of the definition</li> 068 * </ul> 069 * 070 * @return the coordinate 071 */ 072 @SuppressWarnings("null") 073 @Override 074 default String toCoordinates() { 075 IModule module = getContainingModule(); 076 077 // TODO: revisit this to add more context i.e. the containing definition 078 return String.format("%s:%s", module.getShortName(), getModelType()); 079 } 080}