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.databind.model; 028 029import gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine; 030import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline; 031import gov.nist.secauto.metaschema.databind.model.annotations.BoundField; 032 033import java.lang.reflect.Field; 034import java.util.Locale; 035 036import edu.umd.cs.findbugs.annotations.NonNull; 037 038public abstract class AbstractFieldProperty 039 extends AbstractNamedModelProperty 040 implements IBoundFieldInstance { 041 @NonNull 042 private final BoundField fieldAnnotation; 043 044 public AbstractFieldProperty(@NonNull Field field, @NonNull IAssemblyClassBinding parentClassBinding) { 045 super(field, parentClassBinding); 046 047 BoundField fieldAnnotation = field.getAnnotation(BoundField.class); 048 if (fieldAnnotation == null) { 049 throw new IllegalStateException(String.format("Field '%s' on class '%s' is missing the '%s' annotation.", 050 field.getName(), parentClassBinding.getBoundClass().getName(), BoundField.class.getName())); 051 } 052 this.fieldAnnotation = fieldAnnotation; 053 } 054 055 @NonNull 056 protected BoundField getFieldAnnotation() { 057 return fieldAnnotation; 058 } 059 060 // 061 // @Override 062 // protected IDataTypeHandler newDataTypeHandler() { 063 // Class<?> itemClass = getItemType(); 064 // 065 // IDataTypeHandler retval; 066 // if (itemClass.isAnnotationPresent(MetaschemaField.class)) { 067 // IClassBinding classBinding 068 // = 069 // getParentClassBinding().getBindingContext().getClassBinding(getPropertyInfo().getItemType()); 070 // retval = new ClassDataTypeHandler(classBinding, this); 071 // } else { 072 // retval = new JavaTypeAdapterDataTypeHandler(this); 073 // } 074 // return retval; 075 // } 076 077 @Override 078 public String getFormalName() { 079 return ModelUtil.resolveToString(getFieldAnnotation().formalName()); 080 } 081 082 @Override 083 public MarkupLine getDescription() { 084 return ModelUtil.resolveToMarkupLine(getFieldAnnotation().description()); 085 } 086 087 @Override 088 public String getUseName() { 089 return ModelUtil.resolveToString(getFieldAnnotation().useName()); 090 } 091 092 @Override 093 public boolean isInXmlWrapped() { 094 return getFieldAnnotation().inXmlWrapped(); 095 } 096 097 @Override 098 public int getMinOccurs() { 099 return getFieldAnnotation().minOccurs(); 100 } 101 102 @Override 103 public int getMaxOccurs() { 104 return getFieldAnnotation().maxOccurs(); 105 } 106 107 @Override 108 public MarkupMultiline getRemarks() { 109 return ModelUtil.resolveToMarkupMultiline(getFieldAnnotation().remarks()); 110 } 111 112 @SuppressWarnings("null") 113 @Override 114 public String toCoordinates() { 115 return String.format("%s Instance(%s): %s", 116 getModelType().name().toLowerCase(Locale.ROOT), 117 getParentClassBinding().getBoundClass().getName(), 118 getName()); 119 } 120}