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 gov.nist.secauto.metaschema.core.util.ObjectUtils;
30
31 import java.util.Collection;
32
33 import edu.umd.cs.findbugs.annotations.NonNull;
34
35 public interface INamedModelInstance extends INamedInstance, IModelInstance {
36 @Override
37 @NonNull
38 IFlagContainer getDefinition();
39
40 @Override
41 default String getJsonName() {
42 @NonNull String retval;
43 if (getMaxOccurs() == -1 || getMaxOccurs() > 1) {
44 @NonNull String groupAsName = ObjectUtils.requireNonNull(getGroupAsName(),
45 ObjectUtils.notNull(String.format("null group-as name in instance '%s' on definition '%s' in '%s'",
46 this.getName(),
47 this.getContainingDefinition().getName(),
48 this.getContainingModule().getLocation())));
49 retval = groupAsName;
50 } else {
51 retval = getEffectiveName();
52 }
53 return retval;
54 }
55
56 /**
57 * Get the item values for the provided {@code instanceValue}. An instance may
58 * be singular or many valued.
59 *
60 * @param instanceValue
61 * the instance
62 * @return the item values or an empty collection if no item values exist
63 */
64 @NonNull
65 Collection<?> getItemValues(Object instanceValue);
66 }