/*
* (c) Copyright 2007-2009 by Volker Bergmann. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, is permitted under the terms of the
* GNU General Public License.
*
* For redistributing this software or a derivative work under a license other
* than the GPL-compatible Free Software License as defined by the Free
* Software Foundation or approved by OSI, you must first obtain a commercial
* license to this software product from Volker Bergmann.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
* REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
* HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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 org.databene.platform.dbunit;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Map;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.sax.TransformerHandler;
import javax.xml.transform.stream.StreamResult;
import org.databene.benerator.consumer.AbstractConsumer;
import org.databene.commons.ConfigurationError;
import org.databene.commons.Encodings;
import org.databene.commons.IOUtil;
import org.databene.commons.SystemInfo;
import org.databene.commons.converter.ToStringConverter;
import org.databene.model.data.Entity;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
/**
* Exports entities in DbUnit XML file format.
* @since 0.3.04
* @author Volker Bergmann
*/
public class DbUnitEntityExporter extends AbstractConsumer {
// attributes ------------------------------------------------------------------------------------------------------
private static final Logger logger = LoggerFactory.getLogger(DbUnitEntityExporter.class);
private static final String DEFAULT_FILE_ENCODING = Encodings.UTF_8;
private static final String DEFAULT_URI = "data.dbunit.xml";
private static final String DATE_PATTERN = "yyyy-MM-dd";
private static final String TIMESTAMP_PATTERN = "yyyy-MM-dd HH:mm:ss.SSSSSS";
private ToStringConverter toStringConverter;
private String uri;
private String encoding;
private OutputStream out;
private TransformerHandler handler;
// constructors ----------------------------------------------------------------------------------------------------
public DbUnitEntityExporter() {
this(DEFAULT_URI);
}
public DbUnitEntityExporter(String uri) {
this(uri, DEFAULT_FILE_ENCODING);
}
public DbUnitEntityExporter(String uri, String encoding) {
setUri(uri);
setEncoding(encoding);
this.toStringConverter = new ToStringConverter(null, DATE_PATTERN, TIMESTAMP_PATTERN);
}
// properties ------------------------------------------------------------------------------------------------------
public String getUri() {
return uri;
}
public void setUri(String uri) {
this.uri = uri;
}
public String getEncoding() {
return encoding;
}
public void setEncoding(String encoding) {
this.encoding = (encoding != null ? encoding : SystemInfo.getFileEncoding());
if (this.encoding == null)
this.encoding = DEFAULT_FILE_ENCODING;
}
// Consumer interface ----------------------------------------------------------------------------------------------
@Override
public void startProductConsumption(Object object) {
if (!(object instanceof Entity))
throw new IllegalArgumentException("Expected entity");
Entity entity = (Entity) object;
try {
if (logger.isDebugEnabled())
logger.debug("exporting " + entity);
if (out == null)
initPrinter();
AttributesImpl atts = new AttributesImpl();
for (Map.Entry<String, Object> entry : entity.getComponents().entrySet()) {
Object value = entry.getValue();
if (value == null)
continue;
String s = toStringConverter.convert(value);
if (s != null)
atts.addAttribute("", "", entry.getKey(), "CDATA", s);
}
handler.startElement("", "", entity.type(), atts);
handler.endElement("", "", entity.type());
} catch (IOException e) {
throw new RuntimeException(e);
} catch (SAXException e) {
throw new ConfigurationError("Error in processing element: " + entity, e);
}
}
@Override
public void flush() {
if (out != null)
IOUtil.flush(out);
}
@Override
public void close() {
if (handler != null) {
try {
handler.endElement("", "", "dataset");
handler.endDocument();
handler = null;
} catch (SAXException e) {
throw new ConfigurationError("Error closing XML file.", e);
} finally {
IOUtil.close(out);
out = null;
}
}
}
// java.lang.String overrides --------------------------------------------------------------------------------------
private void initPrinter() throws IOException {
try {
// create file and write header
SAXTransformerFactory tf = (SAXTransformerFactory) SAXTransformerFactory.newInstance();
handler = tf.newTransformerHandler();
Transformer serializer = handler.getTransformer();
serializer.setOutputProperty(OutputKeys.ENCODING, encoding);
serializer.setOutputProperty(OutputKeys.INDENT, "yes");
out = new FileOutputStream(uri);
handler.setResult(new StreamResult(out));
handler.startDocument();
handler.startElement("", "", "dataset", null);
} catch (TransformerConfigurationException e) {
throw new ConfigurationError(e);
} catch (SAXException e) {
throw new ConfigurationError("Error in initializing XML file", e);
}
}
@Override
public String toString() {
return getClass().getSimpleName() + '[' + uri + ", " + encoding + "]";
}
}