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.schemagen.xml.datatype;
28  
29  import gov.nist.secauto.metaschema.core.model.IModule;
30  import gov.nist.secauto.metaschema.core.util.CollectionUtil;
31  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
32  import gov.nist.secauto.metaschema.schemagen.datatype.IDatatypeContent;
33  
34  import org.jdom2.Element;
35  
36  import java.io.InputStream;
37  import java.util.List;
38  import java.util.Map;
39  import java.util.stream.Collectors;
40  
41  import edu.umd.cs.findbugs.annotations.NonNull;
42  
43  public abstract class AbstractXmlMarkupDatatypeProvider
44      extends AbstractXmlDatatypeProvider {
45  
46    @Override
47    protected InputStream getSchemaResource() {
48      return IModule.class.getResourceAsStream(getSchemaResourcePath());
49    }
50  
51    /**
52     * Get the absolute classpath of the schema resource.
53     *
54     * @return the resource path
55     */
56    @NonNull
57    protected abstract String getSchemaResourcePath();
58  
59    @Override
60    protected List<Element> queryElements(JDom2XmlSchemaLoader loader) {
61      return loader.getContent(
62          "/xs:schema/*",
63          CollectionUtil.singletonMap("xs", JDom2XmlSchemaLoader.NS_XML_SCHEMA));
64    }
65  
66    @NonNull
67    protected abstract String getDataTypeName();
68  
69    @Override
70    protected Map<String, IDatatypeContent> handleResults(@NonNull List<Element> items) {
71      String dataTypeName = getDataTypeName();
72      return CollectionUtil.singletonMap(
73          dataTypeName,
74          new JDom2DatatypeContent(
75              dataTypeName,
76              ObjectUtils.notNull(items.stream()
77                  .filter(element -> !"include".equals(element.getName()))
78                  .collect(Collectors.toList())),
79              CollectionUtil.emptyList()));
80    }
81  
82  }