View Javadoc
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.core.util.ObjectUtils;
32  import gov.nist.secauto.metaschema.databind.model.annotations.BoundAssembly;
33  import gov.nist.secauto.metaschema.databind.model.info.IDataTypeHandler;
34  
35  import java.lang.reflect.Field;
36  import java.util.Locale;
37  
38  import edu.umd.cs.findbugs.annotations.NonNull;
39  
40  class ClassBindingAssemblyProperty
41      extends AbstractNamedModelProperty
42      implements IBoundAssemblyInstance {
43  
44    @NonNull
45    private final BoundAssembly assembly;
46    @NonNull
47    private final IAssemblyClassBinding definition;
48  
49    protected ClassBindingAssemblyProperty(
50        @NonNull Field field,
51        @NonNull IAssemblyClassBinding definition,
52        @NonNull IAssemblyClassBinding parentClassBinding) {
53      super(field, parentClassBinding);
54      if (field.isAnnotationPresent(BoundAssembly.class)) {
55        this.assembly = ObjectUtils.notNull(field.getAnnotation(BoundAssembly.class));
56      } else {
57        throw new IllegalArgumentException(String.format("BoundField '%s' on class '%s' is missing the '%s' annotation.",
58            field.getName(), parentClassBinding.getBoundClass().getName(), BoundAssembly.class.getName()));
59      }
60      this.definition = definition;
61    }
62  
63    @NonNull
64    private BoundAssembly getAssemblyAnnotation() {
65      return assembly;
66    }
67  
68    @Override
69    protected IDataTypeHandler newDataTypeHandler() {
70      IClassBinding classBinding
71          = getParentClassBinding().getBindingContext().getClassBinding(getPropertyInfo().getItemType());
72      if (classBinding == null) {
73        throw new IllegalStateException(
74            String.format("Class '%s' is not bound", getPropertyInfo().getItemType().getClass().getName()));
75      }
76      return IDataTypeHandler.newDataTypeHandler(this, classBinding);
77    }
78  
79    @Override
80    public IAssemblyClassBinding getDefinition() {
81      return definition;
82    }
83  
84    @Override
85    public String getFormalName() {
86      return ModelUtil.resolveToString(getAssemblyAnnotation().formalName());
87    }
88  
89    @Override
90    public MarkupLine getDescription() {
91      return ModelUtil.resolveToMarkupLine(getAssemblyAnnotation().description());
92    }
93  
94    @Override
95    public MarkupMultiline getRemarks() {
96      return ModelUtil.resolveToMarkupMultiline(getAssemblyAnnotation().remarks());
97    }
98  
99    @Override
100   public String getUseName() {
101     return ModelUtil.resolveToString(getAssemblyAnnotation().useName());
102   }
103 
104   @Override
105   public String getXmlNamespace() {
106     return ObjectUtils
107         .notNull(ModelUtil.resolveNamespace(getAssemblyAnnotation().namespace(), getParentClassBinding()));
108   }
109 
110   @Override
111   public int getMinOccurs() {
112     return getAssemblyAnnotation().minOccurs();
113   }
114 
115   @Override
116   public int getMaxOccurs() {
117     return getAssemblyAnnotation().maxOccurs();
118   }
119 
120   @Override
121   public Object defaultValue() {
122     return getPropertyInfo().newPropertyCollector().getValue();
123   }
124 
125   @SuppressWarnings("null")
126   @Override
127   public String toCoordinates() {
128     return String.format("%s Instance(%s): %s",
129         getModelType().name().toLowerCase(Locale.ROOT),
130         getParentClassBinding().getBoundClass().getName(),
131         getName());
132   }
133 
134 }