/*
 * Copyright (C) 2012 Jan Pokorsky
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package cz.cas.lib.proarc.common.dublincore;

import com.yourmediashelf.fedora.generated.management.DatastreamProfile;
import cz.cas.lib.proarc.common.fedora.DigitalObjectException;
import cz.cas.lib.proarc.common.fedora.FedoraObject;
import cz.cas.lib.proarc.common.fedora.FoxmlUtils;
import cz.cas.lib.proarc.common.fedora.XmlStreamEditor;
import cz.cas.lib.proarc.common.fedora.XmlStreamEditor.EditorResult;
import cz.cas.lib.proarc.common.fedora.relation.RelationEditor;
import cz.cas.lib.proarc.common.mods.ModsUtils;
import cz.cas.lib.proarc.common.object.DigitalObjectHandler;
import cz.cas.lib.proarc.mods.ModsDefinition;
import cz.cas.lib.proarc.oaidublincore.DcConstants;
import cz.cas.lib.proarc.oaidublincore.OaiDcType;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;
import javax.xml.bind.util.JAXBResult;
import javax.xml.bind.util.JAXBSource;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;

/**
 * Dublin Core editor implements I/O over Fedora data stream.
 *
 * @author Jan Pokorsky
 */
public final class DcStreamEditor {

    public static final String DATASTREAM_ID = "DC";
    public static final String DATASTREAM_FORMAT_URI = DcConstants.NS_OAIDC;
    public static final String DATASTREAM_LABEL = "Dublin Core Record for this object";

    private final XmlStreamEditor editor;
    private final FedoraObject object;

    public static DatastreamProfile dcProfile() {
        return FoxmlUtils.inlineProfile(DATASTREAM_ID, DATASTREAM_FORMAT_URI, DATASTREAM_LABEL);
    }

    public DcStreamEditor(FedoraObject object) {
        this(object.getEditor(dcProfile()), object);
    }

    DcStreamEditor(XmlStreamEditor editor, FedoraObject object) {
        this.editor = editor;
        this.object = object;
    }

    public long getLastModified() throws DigitalObjectException {
        return editor.getLastModified();
    }

    public DublinCoreRecord read() throws DigitalObjectException {
        Source src = editor.read();
        OaiDcType dc;
        if (src != null) {
            dc = DcUtils.unmarshal(src, OaiDcType.class);
        } else {
            dc = new OaiDcType();
        }
        return new DublinCoreRecord(dc, editor.getLastModified(), object.getPid());
    }

    public void write(DigitalObjectHandler handler, DublinCoreRecord record, String message) throws DigitalObjectException {
        addDigitalObjectMetadata(handler, record.getDc());
        write(record, message);
    }

    public void write(DublinCoreRecord record, String message) throws DigitalObjectException {
        EditorResult result = editor.createResult();
        // DO NOT include schemaLocation. Fedora validator does not accept it.
        DcUtils.marshal(result, record.getDc(), false);
        editor.write(result, record.getTimestamp(), message);
    }

    @Deprecated
    public void write(ModsDefinition mods, String model, long timestamp, String message) throws DigitalObjectException {
        write(null, mods, model, timestamp, message);
    }

    @Deprecated
    public void write(DigitalObjectHandler handler, ModsDefinition mods, String model, long timestamp, String message) throws DigitalObjectException {
        try {
            JAXBSource jaxbSource = new JAXBSource(ModsUtils.defaultMarshaller(false),
                    new cz.cas.lib.proarc.mods.ObjectFactory().createMods(mods));
            // DO NOT include schemaLocation. Fedora validator does not accept it.
            Transformer t = DcUtils.modsTransformer(model);
            EditorResult result = editor.createResult();
            JAXBResult jaxbResult = new JAXBResult(DcUtils.defaultUnmarshaller());
            t.transform(jaxbSource, jaxbResult);
            JAXBElement<OaiDcType> elm = (JAXBElement<OaiDcType>) jaxbResult.getResult();
            OaiDcType dc = elm.getValue();
            addDigitalObjectMetadata(handler, dc);
            DcUtils.marshal(result, dc, false);
            editor.write(result, timestamp, message);
        } catch (TransformerException | JAXBException ex) {
            throw new DigitalObjectException(object.getPid(), ex);
        }
    }

    static void addDigitalObjectMetadata(DigitalObjectHandler handler, OaiDcType dc) throws DigitalObjectException {
        if (handler != null) {
            RelationEditor relations = handler.relations();
            DcUtils.addPid(dc, handler.getFedoraObject().getPid());
            DcUtils.addModel(dc, relations.getModel());
            DcUtils.addOwner(dc, relations.getOwners());
        }
    }

    public static class DublinCoreRecord {

        private String pid;
        private Integer batchId;
        /** last modification of the DC content*/
        private long timestamp;
        private OaiDcType dc;

        public DublinCoreRecord() {
        }

        public DublinCoreRecord(OaiDcType dc, long timestamp, String pid) {
            this.dc = dc;
            this.timestamp = timestamp;
            this.pid = pid;
        }

        public Integer getBatchId() {
            return batchId;
        }

        public void setBatchId(Integer batchId) {
            this.batchId = batchId;
        }

        public OaiDcType getDc() {
            return dc;
        }

        public void setDc(OaiDcType dc) {
            this.dc = dc;
        }

        public String getPid() {
            return pid;
        }

        public void setPid(String pid) {
            this.pid = pid;
        }

        public long getTimestamp() {
            return timestamp;
        }

        public void setTimestamp(long timestamp) {
            this.timestamp = timestamp;
        }

    }

}