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.core.datatype.markup;
028
029import com.fasterxml.jackson.core.JsonGenerator;
030import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes;
031
032import gov.nist.secauto.metaschema.core.datatype.AbstractCustomJavaDataTypeAdapter;
033import gov.nist.secauto.metaschema.core.metapath.item.atomic.IMarkupItem;
034import gov.nist.secauto.metaschema.core.util.ObjectUtils;
035
036import org.codehaus.stax2.XMLStreamWriter2;
037import org.codehaus.stax2.evt.XMLEventFactory2;
038
039import java.io.IOException;
040
041import javax.xml.namespace.QName;
042import javax.xml.stream.XMLEventWriter;
043import javax.xml.stream.XMLStreamException;
044import javax.xml.stream.events.StartElement;
045
046import edu.umd.cs.findbugs.annotations.NonNull;
047
048public abstract class AbstractMarkupAdapter<TYPE extends IMarkupString<TYPE>>
049    extends AbstractCustomJavaDataTypeAdapter<TYPE, IMarkupItem> {
050
051  /**
052   * Construct a new adapter.
053   *
054   * @param clazz
055   *          the markup type class
056   */
057  protected AbstractMarkupAdapter(@NonNull Class<TYPE> clazz) {
058    super(clazz);
059  }
060
061  @Override
062  public JsonFormatTypes getJsonRawType() {
063    return JsonFormatTypes.STRING;
064  }
065
066  @Override
067  public boolean isXmlMixed() {
068    return true;
069  }
070
071  // TODO: verify that read/write methods cannot be generalized in the base class
072  @Override
073  public void writeXmlValue(
074      Object value,
075      StartElement parent,
076      XMLEventFactory2 eventFactory,
077      XMLEventWriter eventWriter)
078      throws XMLStreamException {
079
080    IMarkupString<?> markupString = (IMarkupString<?>) value;
081
082    markupString.writeXHtml(
083        ObjectUtils.notNull(parent.getName().getNamespaceURI()),
084        eventFactory,
085        eventWriter);
086  }
087
088  @Override
089  public void writeXmlValue(Object value, QName parentName, XMLStreamWriter2 streamWriter)
090      throws XMLStreamException {
091    IMarkupString<?> markupString = (IMarkupString<?>) value;
092
093    markupString.writeXHtml(
094        ObjectUtils.notNull(parentName.getNamespaceURI()),
095        streamWriter);
096  }
097
098  @Override
099  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}