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 import edu.umd.cs.findbugs.annotations.Nullable;
31
32 public interface IFieldDefinition extends IValuedDefinition, IFlagContainer, IField {
33
34 @Override
35 default IFieldDefinition getOwningDefinition() {
36 return this;
37 }
38
39 @Override
40 IFieldInstance getInlineInstance();
41
42 /**
43 * Retrieves the key to use as the field name for this field's value in JSON.
44 *
45 * @return a string or a FlagInstance value
46 */
47 @Nullable
48 default Object getJsonValueKey() {
49 Object retval = getJsonValueKeyFlagInstance();
50 if (retval == null) {
51 retval = getJsonValueKeyName();
52 }
53 return retval;
54 }
55
56 /**
57 * Check if a JSON value key flag is configured.
58 *
59 * @return {@code true} if a JSON value key flag is configured, or {@code false}
60 * otherwise
61 */
62 default boolean hasJsonValueKeyFlagInstance() {
63 return getJsonValueKeyFlagInstance() != null;
64 }
65
66 /**
67 * Retrieves the flag instance who's value will be used as the "value key".
68 *
69 * @return the configured flag instance, or {@code null} if a flag is not
70 * configured as the "value key"
71 */
72 @Nullable
73 IFlagInstance getJsonValueKeyFlagInstance();
74
75 /**
76 * Retrieves the configured static label to use as the value key, or the type
77 * specific name if a label is not configured.
78 *
79 * @return the value key label
80 */
81 @NonNull
82 String getJsonValueKeyName();
83
84 /**
85 * Get the value of the field's value from the field item object.
86 *
87 * @param item
88 * the field item
89 * @return the field's value or {@code null} if it has no value
90 */
91 Object getFieldValue(@NonNull Object item);
92 }