001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.core.model; 028 029import edu.umd.cs.findbugs.annotations.NonNull; 030import edu.umd.cs.findbugs.annotations.Nullable; 031 032public interface IFieldDefinition extends IValuedDefinition, IFlagContainer, IField { 033 034 @Override 035 default IFieldDefinition getOwningDefinition() { 036 return this; 037 } 038 039 @Override 040 IFieldInstance getInlineInstance(); 041 042 /** 043 * Retrieves the key to use as the field name for this field's value in JSON. 044 * 045 * @return a string or a FlagInstance value 046 */ 047 @Nullable 048 default Object getJsonValueKey() { 049 Object retval = getJsonValueKeyFlagInstance(); 050 if (retval == null) { 051 retval = getJsonValueKeyName(); 052 } 053 return retval; 054 } 055 056 /** 057 * Check if a JSON value key flag is configured. 058 * 059 * @return {@code true} if a JSON value key flag is configured, or {@code false} 060 * otherwise 061 */ 062 default boolean hasJsonValueKeyFlagInstance() { 063 return getJsonValueKeyFlagInstance() != null; 064 } 065 066 /** 067 * Retrieves the flag instance who's value will be used as the "value key". 068 * 069 * @return the configured flag instance, or {@code null} if a flag is not 070 * configured as the "value key" 071 */ 072 @Nullable 073 IFlagInstance getJsonValueKeyFlagInstance(); 074 075 /** 076 * Retrieves the configured static label to use as the value key, or the type 077 * specific name if a label is not configured. 078 * 079 * @return the value key label 080 */ 081 @NonNull 082 String getJsonValueKeyName(); 083 084 /** 085 * Get the value of the field's value from the field item object. 086 * 087 * @param item 088 * the field item 089 * @return the field's value or {@code null} if it has no value 090 */ 091 Object getFieldValue(@NonNull Object item); 092}