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 javax.xml.namespace.QName;
30
31 import edu.umd.cs.findbugs.annotations.NonNull;
32 import edu.umd.cs.findbugs.annotations.Nullable;
33
34 /**
35 * This marker interface is used to identify a field or assembly instance that
36 * is a member of an assembly's model.
37 */
38 public interface IModelInstance extends IInstance {
39 @Override
40 IModelContainer getParentContainer();
41
42 /**
43 * Retrieve the Metaschema assembly definition on which this instance is
44 * declared.
45 *
46 * @return the parent Metaschema assembly definition
47 */
48 @Override
49 IAssemblyDefinition getContainingDefinition();
50
51 /**
52 * Get the name used for the associated element wrapping a collection of
53 * elements in XML. This value is required when {@link #getXmlGroupAsBehavior()}
54 * = {@link XmlGroupAsBehavior#GROUPED}. This name will be the element name
55 * wrapping a collection of elements.
56 *
57 * @return the groupAs QName or {@code null} if no name is configured, such as
58 * when {@link #getMaxOccurs()} = 1.
59 */
60 @Nullable
61 default QName getXmlGroupAsQName() {
62 QName retval = null;
63 if (XmlGroupAsBehavior.GROUPED.equals(getXmlGroupAsBehavior())) {
64 String namespace = getGroupAsXmlNamespace();
65 if (namespace != null) {
66 retval = new QName(namespace, getGroupAsName());
67 } else {
68 retval = new QName(getGroupAsName());
69 }
70 }
71 return retval;
72 }
73
74 /**
75 * Get the minimum cardinality for this associated instance. This value must be
76 * less than or equal to the maximum cardinality returned by
77 * {@link #getMaxOccurs()}.
78 *
79 * @return {@code 0} or a positive integer value
80 */
81 int getMinOccurs();
82
83 /**
84 * Get the maximum cardinality for this associated instance. This value must be
85 * greater than or equal to the minimum cardinality returned by
86 * {@link #getMinOccurs()}, or {@code -1} if unbounded.
87 *
88 * @return a positive integer value or {@code -1} if unbounded
89 */
90 int getMaxOccurs();
91
92 /**
93 * Get the name provided for grouping. An instance in Metaschema must have a
94 * group name if the instance has a cardinality greater than {@code 1}.
95 *
96 * @return the group-as name or {@code null} if no name is configured, such as
97 * when {@link #getMaxOccurs()} = 1
98 */
99 @Nullable
100 String getGroupAsName();
101
102 /**
103 * Retrieve the XML namespace for this group.
104 *
105 * @return the XML namespace or {@code null} if no namespace is used
106 */
107 @Nullable
108 String getGroupAsXmlNamespace();
109
110 /**
111 * Gets the configured JSON group-as strategy. A JSON group-as strategy is only
112 * required when {@link #getMaxOccurs()} > 1.
113 *
114 * @return the JSON group-as strategy, or {@code JsonGroupAsBehavior#NONE} if
115 * {@link #getMaxOccurs()} = 1
116 */
117 @NonNull
118 JsonGroupAsBehavior getJsonGroupAsBehavior();
119
120 /**
121 * Gets the configured XML group-as strategy. A XML group-as strategy is only
122 * required when {@link #getMaxOccurs()} > 1.
123 *
124 * @return the JSON group-as strategy, or {@code XmlGroupAsBehavior#UNGROUPED}
125 * if {@link #getMaxOccurs()} = 1
126 */
127 @NonNull
128 XmlGroupAsBehavior getXmlGroupAsBehavior();
129 }