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.databind.model;
28
29 import gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine;
30 import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline;
31 import gov.nist.secauto.metaschema.databind.model.annotations.BoundField;
32
33 import java.lang.reflect.Field;
34 import java.util.Locale;
35
36 import edu.umd.cs.findbugs.annotations.NonNull;
37
38 public abstract class AbstractFieldProperty
39 extends AbstractNamedModelProperty
40 implements IBoundFieldInstance {
41 @NonNull
42 private final BoundField fieldAnnotation;
43
44 public AbstractFieldProperty(@NonNull Field field, @NonNull IAssemblyClassBinding parentClassBinding) {
45 super(field, parentClassBinding);
46
47 BoundField fieldAnnotation = field.getAnnotation(BoundField.class);
48 if (fieldAnnotation == null) {
49 throw new IllegalStateException(String.format("Field '%s' on class '%s' is missing the '%s' annotation.",
50 field.getName(), parentClassBinding.getBoundClass().getName(), BoundField.class.getName()));
51 }
52 this.fieldAnnotation = fieldAnnotation;
53 }
54
55 @NonNull
56 protected BoundField getFieldAnnotation() {
57 return fieldAnnotation;
58 }
59
60 //
61 // @Override
62 // protected IDataTypeHandler newDataTypeHandler() {
63 // Class<?> itemClass = getItemType();
64 //
65 // IDataTypeHandler retval;
66 // if (itemClass.isAnnotationPresent(MetaschemaField.class)) {
67 // IClassBinding classBinding
68 // =
69 // getParentClassBinding().getBindingContext().getClassBinding(getPropertyInfo().getItemType());
70 // retval = new ClassDataTypeHandler(classBinding, this);
71 // } else {
72 // retval = new JavaTypeAdapterDataTypeHandler(this);
73 // }
74 // return retval;
75 // }
76
77 @Override
78 public String getFormalName() {
79 return ModelUtil.resolveToString(getFieldAnnotation().formalName());
80 }
81
82 @Override
83 public MarkupLine getDescription() {
84 return ModelUtil.resolveToMarkupLine(getFieldAnnotation().description());
85 }
86
87 @Override
88 public String getUseName() {
89 return ModelUtil.resolveToString(getFieldAnnotation().useName());
90 }
91
92 @Override
93 public boolean isInXmlWrapped() {
94 return getFieldAnnotation().inXmlWrapped();
95 }
96
97 @Override
98 public int getMinOccurs() {
99 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 }