/**
 * Copyright (C) 2012-2013 Selventa, Inc.
 *
 * This file is part of the OpenBEL Framework.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The OpenBEL Framework 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 Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the OpenBEL Framework. If not, see <http://www.gnu.org/licenses/>.
 *
 * Additional Terms under LGPL v3:
 *
 * This license does not authorize you and you are prohibited from using the
 * name, trademarks, service marks, logos or similar indicia of Selventa, Inc.,
 * or, in the discretion of other licensors or authors of the program, the
 * name, trademarks, service marks, logos or similar indicia of such authors or
 * licensors, in any marketing or advertising materials relating to your
 * distribution of the program or any covered product. This restriction does
 * not waive or limit your obligation to keep intact all copyright notices set
 * forth in the program as delivered to you.
 *
 * If you distribute the program in whole or in part, or any modified version
 * of the program, and you assume contractual liability to the recipient with
 * respect to the program or modified version, then you will indemnify the
 * authors and licensors of the program for any liabilities that these
 * contractual assumptions directly impose on those licensors and authors.
 */
package org.openbel.framework.tools.xgmml;

import static org.openbel.framework.common.BELUtilities.nulls;

import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.util.List;

import org.openbel.framework.api.Kam;
import org.openbel.framework.api.Kam.KamEdge;
import org.openbel.framework.api.Kam.KamNode;
import org.openbel.framework.api.internal.KAMStoreDaoImpl.BelTerm;
import org.openbel.framework.api.KAMStore;
import org.openbel.framework.api.KAMStoreException;
import org.openbel.framework.common.InvalidArgument;
import org.openbel.framework.tools.xgmml.XGMMLObjects.Edge;
import org.openbel.framework.tools.xgmml.XGMMLObjects.Node;

/**
 * XGMMLExporter leverages the KAM API to export a KAM in XGMML graph format.
 *
 * @see <a href="http://en.wikipedia.org/wiki/XGMML">http://en.wikipedia.org/wiki/XGMML</a>
 * @author Anthony Bargnesi {@code <abargnesi@selventa.com>}
 */
public class XGMMLExporter {

    /**
     * Private constructor to prevent instantiation.
     */
    private XGMMLExporter() {
    }

    /**
     * Export KAM to XGMML format using the KAM API.
     *
     * @param kam {@link Kam} the kam to export to XGMML
     * @param kAMStore {@link KAMStore} the kam store to read kam details from
     * @param outputPath {@link String} the output path to write XGMML file to,
     * which can be null, in which case the kam's name will be used and it will
     * be written to the current directory (user.dir).
     *
     * @throws KAMStoreException Thrown if an error occurred retrieving the KAM
     * @throws FileNotFoundException Thrown if the export file cannot be
     * written to
     * @throws InvalidArgument Thrown if either the kam, kamInfo, kamStore, or
     * outputPath arguments were null
     */
    public static void exportKam(final Kam kam, final KAMStore kAMStore,
            String outputPath) throws KAMStoreException, FileNotFoundException {
        if (nulls(kam, kAMStore, outputPath)) {
            throw new InvalidArgument("argument(s) were null");
        }

        // Set up a writer to write the XGMML
        PrintWriter writer = new PrintWriter(outputPath);

        // Start to process the Kam

        // Write xgmml <graph> element header
        XGMMLUtility.writeStart(kam.getKamInfo().getName(), writer);

        // We iterate over all the nodes in the Kam first
        for (KamNode kamNode : kam.getNodes()) {
            Node xNode = new Node();
            xNode.id = kamNode.getId();
            xNode.label = kamNode.getLabel();
            xNode.function = kamNode.getFunctionType();

            List<BelTerm> supportingTerms =
                    kAMStore.getSupportingTerms(kamNode);

            XGMMLUtility.writeNode(xNode, supportingTerms, writer);
        }

        // Iterate over all the edges
        for (KamEdge kamEdge : kam.getEdges()) {
            Edge xEdge = new Edge();
            xEdge.id = kamEdge.getId();
            xEdge.rel = kamEdge.getRelationshipType();
            KamNode knsrc = kamEdge.getSourceNode();
            KamNode kntgt = kamEdge.getTargetNode();
            xEdge.source = knsrc.getId();
            xEdge.target = kntgt.getId();

            Node src = new Node();
            src.function = knsrc.getFunctionType();
            src.label = knsrc.getLabel();
            Node tgt = new Node();
            tgt.function = kntgt.getFunctionType();
            tgt.label = kntgt.getLabel();

            XGMMLUtility.writeEdge(src, tgt, xEdge, writer);
        }

        // Close out the writer
        XGMMLUtility.writeEnd(writer);
        writer.close();
    }
}