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 edu.umd.cs.findbugs.annotations.NonNull;
30
31 /**
32 * This marker interface indicates that this object is an instance.
33 */
34 public interface IInstance extends IModelElement {
35 /**
36 * Retrieve the Metaschema definition on which the instance was declared.
37 *
38 * @return the Metaschema definition on which the instance was declared
39 */
40 @NonNull
41 IFlagContainer getContainingDefinition();
42
43 /**
44 * Get the parent model definition that serves as the container of this
45 * instance.
46 *
47 * @return the container
48 */
49 @NonNull
50 IContainer getParentContainer();
51
52 @Override
53 default IModule getContainingModule() {
54 return getContainingDefinition().getContainingModule();
55 }
56
57 /**
58 * Generates a "coordinate" string for the provided information element
59 * instance.
60 *
61 * A coordinate consists of the element's:
62 * <ul>
63 * <li>containing Metaschema module's short name</li>
64 * <li>model type</li>
65 * <li>name</li>
66 * <li>hash code</li>
67 * <li>the hash code of the definition</li>
68 * </ul>
69 *
70 * @return the coordinate
71 */
72 @SuppressWarnings("null")
73 @Override
74 default String toCoordinates() {
75 IModule module = getContainingModule();
76
77 // TODO: revisit this to add more context i.e. the containing definition
78 return String.format("%s:%s", module.getShortName(), getModelType());
79 }
80 }