All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.scalaxal.io.XalPrintWriter.scala Maven / Gradle / Ivy

There is a newer version: 1.1
Show newest version
/*
* Copyright (c) 2013, Ringo Wathelet
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this
*   list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright notice, this
*   list of conditions and the following disclaimer in the documentation and/or
*   other materials provided with the distribution.
*
* - Neither the name of "scalaxal" nor the names of its contributors may
*   be used to endorse or promote products derived from this software without
*   specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package com.scalaxal.io

import java.io.{ PrintWriter, File }
import xml.{NodeSeq, dtd, XML, PrettyPrinter}
import com.scalaxal.xAL._


/**
* @author Ringo Wathelet
* Date: 01/02/13
* Version: 1
*/

/**
* represents the extraction of an xml node sequence from a xal root element
*/
trait XmlExtractor {
  def getXmlFrom[A: XalToXml](xal: A): NodeSeq
}

/**
* writes the xal element object to xml representation
*
* @param writer the PrintWriter to use
* @param encoding the encoding
* @param xmlDecl if true, write xml declaration
* @param doctype if not null, write doctype declaration
*/
class XalPrintWriter(writer: Option[PrintWriter] = Some(new PrintWriter(System.out)),
                     xmlExtractor: Option[XmlExtractor] = Some(XalToXml),
                     encoding: String = "UTF-8",
                     xmlDecl: Boolean = true,
                     doctype: dtd.DocType = null) {

  def this(fileName: Option[String]) = this(Some(if (fileName.isDefined) new PrintWriter(new File(fileName.get)) else new PrintWriter(System.out)))

  def this(fileName: String) = this(Option(fileName))

  /**
   * writes the xal element to xml.
   * Note the "writer" is not closed here.
   *
   * @param value the xal element option
   * @param pretty the pretty printer to use, default null
   */
  def write(value: Any, pretty: PrettyPrinter = null) = {
    if (writer.isDefined)
     xmlExtractor match {
       case Some(extractor) =>
         if (pretty == null)
           extractor.getXmlFrom(value).foreach(x => XML.write(writer.get, x, encoding, xmlDecl, doctype))
         else
           extractor.getXmlFrom(value).foreach(x => XML.write(writer.get, XML.loadString(pretty.format(x)), encoding, xmlDecl, doctype))

         writer.get.flush()

       case None => Unit
     }

  }

  def close() = if (writer.isDefined) writer.get.close()

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy