EDIT

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.io.dwca.out;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.util.List;

import javax.xml.stream.XMLStreamException;

import javax.xml.stream.XMLStreamWriter;

import org.apache.commons.lang.StringUtils;

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

import org.springframework.stereotype.Component;

import eu.etaxonomy.cdm.common.URI;

import eu.etaxonomy.cdm.io.dwca.out.DwcaMetaDataRecord.FieldEntry;

/**

 * @author a.mueller

 * @since 20.04.2011

 */

@Component

public class DwcaMetaDataExport extends DwcaExportBase {

    private static final long serialVersionUID = -4033439569151252697L;

    private static final Logger logger = LogManager.getLogger(DwcaMetaDataExport.class);

	protected static final String fileName = "meta.xml";

	/**

	 * Constructor

	 */

	public DwcaMetaDataExport() {

		super();

		this.ioName = this.getClass().getSimpleName();

	}

	@Override

	protected void doInvoke(DwcaTaxExportState state){

		DwcaTaxExportConfigurator config = state.getConfig();

		DwcaMetaDataRecord metaDataRecord = new DwcaMetaDataRecord(! IS_CORE, fileName, null);

		metaDataRecord.setMetaData(true);

		state.addMetaRecord(metaDataRecord);

		XMLStreamWriter writer = null;

		try {

			writer = createXmlStreamWriter(state, DwcaTaxExportFile.METADATA);

			String rootNamespace = "http://rs.tdwg.org/dwc/text/";

			String rootName = "archive";

			List<DwcaMetaDataRecord> metaRecords = state.getMetaRecords();

			// create header

			writer.writeStartDocument();

			writer.setDefaultNamespace(rootNamespace);

				// create root element

				writer.writeStartElement(rootName);

				writer.writeNamespace(null, rootNamespace);

				writer.writeNamespace("xsi", "http://www.w3.org/2001/XMLSchema-instance");

				writer.writeAttribute("http://www.w3.org/2001/XMLSchema-instance", "schemaLocation", "http://rs.tdwg.org/dwc/text/ http://rs.tdwg.org/dwc/text/tdwg_dwc_text.xsd");

				for (DwcaMetaDataRecord metaRecord : metaRecords){

					if (! metaRecord.isMetaData()){

						writeMetaDataRecord(writer, config, metaRecord);

					}

				}

				writer.writeEndElement();

			writer.writeEndDocument();

			writer.flush();

			writer.close();

		} catch (FileNotFoundException e) {

		    String message = "Metadata file could not be found";

			state.getResult().addException(e, message);

		} catch (XMLStreamException e) {

			if (e.getNestedException() != null){

			    String message = "Nested XMLStreamException while handling metadata";

			    state.getResult().addException((Exception)e.getNestedException(), message);

			}else{

			    String message = "XMLStreamException while handling metadata";

                state.getResult().addException(e, message);

			}

		} catch (IOException e) {

		    String message = "IOException while handling metadata";

            state.getResult().addException(e, message);

		} finally{

			closeWriter(writer, state);

		}

		return;

	}

	private void writeMetaDataRecord(XMLStreamWriter writer,

			DwcaTaxExportConfigurator config, DwcaMetaDataRecord metaRecord) throws XMLStreamException {

		if (! metaRecord.hasEntries()){

			return;

		}

		String encoding = config.getEncoding();

		String linesTerminatedBy = config.getLinesTerminatedBy();

		String fieldsEnclosedBy = config.getFieldsEnclosedBy();

		String ignoreHeaderLines = config.isHasHeaderLines()? "1":"0";

		String fieldsTerminatedBy= config.getFieldsTerminatedBy();

		// create core element

		String elementName = metaRecord.isCore()? "core": "extension";

		String rowType = metaRecord.getRowType();

		writeElementStart(writer, elementName, encoding, linesTerminatedBy,	fieldsEnclosedBy,

		        fieldsTerminatedBy, ignoreHeaderLines, rowType);

			String filename = metaRecord.getFileLocation();

			writeFiles(writer, filename );

			writeId(writer, metaRecord.isCore());

			List<FieldEntry> entryList = metaRecord.getEntries();

			for (FieldEntry fieldEntry : entryList){

				if (fieldEntry.index != 0){

					writeFieldLine(writer, fieldEntry.index, fieldEntry.term, fieldEntry.defaultValue);

				}

			}

		writer.writeEndElement();

	}

	private void writeFieldLine(XMLStreamWriter writer, int index, URI term, String defaultValue) throws XMLStreamException {

		writer.writeStartElement("field");

		if (StringUtils.isNotBlank(defaultValue)){

			writer.writeAttribute("default", defaultValue);

		}else{

			writer.writeAttribute("index", String.valueOf(index));

		}

		writer.writeAttribute("term", term.toString());

		writer.writeEndElement();

	}

	private void writeId(XMLStreamWriter writer, boolean isCore) throws XMLStreamException {

		String strId = isCore? "id" : "coreid";

		writer.writeStartElement(strId);

		writer.writeAttribute("index", "0");

		writer.writeEndElement();

	}

	private void writeFiles(XMLStreamWriter writer, String filename) throws XMLStreamException {

		writer.writeStartElement("files");

			writer.writeStartElement("location");

			writer.writeCharacters(filename);

			writer.writeEndElement();

		writer.writeEndElement();

	}

	/**

	 * @param writer

	 * @param encoding

	 * @param linesTerminatedBy

	 * @param fieldsEnclosedBy

	 * @param ignoreHeaderLines

	 * @param rowType

	 * @param elementName

	 * @throws XMLStreamException

	 */

	private void writeElementStart(XMLStreamWriter writer, String elementName, String encoding,

			String linesTerminatedBy, String fieldsEnclosedBy, String fieldsTerminatedBy,

			String ignoreHeaderLines, String rowType)

			throws XMLStreamException {

		writer.writeStartElement(elementName);

		writer.writeAttribute( "encoding", encoding );

		writer.writeAttribute( "linesTerminatedBy", linesTerminatedBy );

		writer.writeAttribute( "fieldsEnclosedBy", fieldsEnclosedBy );

		writer.writeAttribute("fieldsTerminatedBy", fieldsTerminatedBy);

		writer.writeAttribute("ignoreHeaderLines", ignoreHeaderLines);

		writer.writeAttribute("rowType", rowType);

	}

	@Override

	protected boolean doCheck(DwcaTaxExportState state) {

		boolean result = true;

		logger.warn("No check implemented for " + this.ioName);

		return result;

	}

	@Override

	protected boolean isIgnore(DwcaTaxExportState state) {

		return ! state.getConfig().isDoMetaData();

	}

}