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 java.util.Collection;
30 import java.util.List;
31
32 import edu.umd.cs.findbugs.annotations.NonNull;
33 import edu.umd.cs.findbugs.annotations.Nullable;
34
35 /**
36 * Indicates that the Metaschema type that has a complex model that can contain
37 * field and assembly instances.
38 */
39 public interface IModelContainer extends IContainer {
40 /**
41 * Retrieve the Metaschema definition containing this container.
42 *
43 * @return the containing Metaschema definition
44 */
45 @Override
46 @NonNull
47 IAssemblyDefinition getOwningDefinition();
48
49 /**
50 * Get the model instance contained within the model with the associated use
51 * name.
52 *
53 * @param name
54 * the use name of the model instance
55 * @return the matching model instance, or {@code null} if no match was found
56 * @see INamedModelInstance#getUseName()
57 */
58 @Nullable
59 INamedModelInstance getModelInstanceByName(String name);
60
61 /**
62 * Get all named model instances within the container.
63 *
64 * @return an ordered mapping of use name to model instance
65 */
66 @NonNull
67 Collection<? extends INamedModelInstance> getNamedModelInstances();
68
69 /**
70 * Get all field instances within the container.
71 *
72 * @return a mapping of use name to field instance
73 */
74 @NonNull
75 Collection<? extends IFieldInstance> getFieldInstances();
76
77 /**
78 * Get the field instance contained within the model with the associated use
79 * name.
80 *
81 * @param name
82 * the use name of the field instance
83 * @return the matching field instance, or {@code null} if no match was found
84 * @see IFieldInstance#getUseName()
85 */
86 @Nullable
87 IFieldInstance getFieldInstanceByName(String name);
88
89 /**
90 * Get all assembly instances within the container.
91 *
92 * @return a mapping of use name to assembly instance
93 */
94 @NonNull
95 Collection<? extends IAssemblyInstance> getAssemblyInstances();
96
97 /**
98 * Get the assembly instance contained within the model with the associated use
99 * name.
100 *
101 * @param name
102 * the use name of the assembly instance
103 * @return the matching assembly instance, or {@code null} if no match was found
104 * @see IAssemblyInstance#getUseName()
105 */
106 @Nullable
107 IAssemblyInstance getAssemblyInstanceByName(String name);
108
109 /**
110 * Get all choice instances within the container.
111 *
112 * @return a list of choice instances
113 */
114 @NonNull
115 List<? extends IChoiceInstance> getChoiceInstances();
116
117 /**
118 * Get all model instances within the container.
119 *
120 * @return an ordered collection of model instances
121 */
122 @NonNull
123 Collection<? extends IModelInstance> getModelInstances();
124 }