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.core.datatype.markup;
28  
29  import com.fasterxml.jackson.core.JsonGenerator;
30  import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes;
31  
32  import gov.nist.secauto.metaschema.core.datatype.AbstractCustomJavaDataTypeAdapter;
33  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IMarkupItem;
34  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
35  
36  import org.codehaus.stax2.XMLStreamWriter2;
37  import org.codehaus.stax2.evt.XMLEventFactory2;
38  
39  import java.io.IOException;
40  
41  import javax.xml.namespace.QName;
42  import javax.xml.stream.XMLEventWriter;
43  import javax.xml.stream.XMLStreamException;
44  import javax.xml.stream.events.StartElement;
45  
46  import edu.umd.cs.findbugs.annotations.NonNull;
47  
48  public abstract class AbstractMarkupAdapter<TYPE extends IMarkupString<TYPE>>
49      extends AbstractCustomJavaDataTypeAdapter<TYPE, IMarkupItem> {
50  
51    /**
52     * Construct a new adapter.
53     *
54     * @param clazz
55     *          the markup type class
56     */
57    protected AbstractMarkupAdapter(@NonNull Class<TYPE> clazz) {
58      super(clazz);
59    }
60  
61    @Override
62    public JsonFormatTypes getJsonRawType() {
63      return JsonFormatTypes.STRING;
64    }
65  
66    @Override
67    public boolean isXmlMixed() {
68      return true;
69    }
70  
71    // TODO: verify that read/write methods cannot be generalized in the base class
72    @Override
73    public void writeXmlValue(
74        Object value,
75        StartElement parent,
76        XMLEventFactory2 eventFactory,
77        XMLEventWriter eventWriter)
78        throws XMLStreamException {
79  
80      IMarkupString<?> markupString = (IMarkupString<?>) value;
81  
82      markupString.writeXHtml(
83          ObjectUtils.notNull(parent.getName().getNamespaceURI()),
84          eventFactory,
85          eventWriter);
86    }
87  
88    @Override
89    public void writeXmlValue(Object value, QName parentName, XMLStreamWriter2 streamWriter)
90        throws XMLStreamException {
91      IMarkupString<?> markupString = (IMarkupString<?>) value;
92  
93      markupString.writeXHtml(
94          ObjectUtils.notNull(parentName.getNamespaceURI()),
95          streamWriter);
96    }
97  
98    @Override
99    public void writeJsonValue(Object value, JsonGenerator generator) throws IOException {
100 
101     IMarkupString<?> markupString;
102     try {
103       markupString = (IMarkupString<?>) value;
104     } catch (ClassCastException ex) {
105       throw new IOException(ex);
106     }
107 
108     generator.writeString(markupString.toMarkdown().trim());
109   }
110 }